Add comments for *Client.Stat and *Client.Lstat

drakkan · Sep 8, 2015 · a6fc4b8 · a6fc4b8
1 parent fe6bfd7
commit a6fc4b8
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/client.go b/client.go
@@ -259,6 +259,8 @@ func (c *Client) opendir(path string) (string, error) {
 	}
 }
 
+// Stat returns a FileInfo structure describing the file specified by path 'p'.
+// If 'p' is a symbolic link, the returned FileInfo structure describes the referent file.
 func (c *Client) Stat(p string) (os.FileInfo, error) {
 	id := c.nextId()
 	typ, data, err := c.sendRequest(sshFxpStatPacket{
@@ -283,6 +285,8 @@ func (c *Client) Stat(p string) (os.FileInfo, error) {
 	}
 }
 
+// Lstat returns a FileInfo structure describing the file specified by path 'p'.
+// If 'p' is a symbolic link, the returned FileInfo structure describes the symbolic link.
 func (c *Client) Lstat(p string) (os.FileInfo, error) {
 	id := c.nextId()
 	typ, data, err := c.sendRequest(sshFxpLstatPacket{