aboutsummaryrefslogtreecommitdiffstats
path: root/lib
diff options
context:
space:
mode:
authorHans Nilsson <[email protected]>2018-02-26 12:24:15 +0100
committerHans Nilsson <[email protected]>2018-02-27 14:45:25 +0100
commit673ecca781e7dcc5c006933a42b9a32ec744ebf3 (patch)
tree5c14af17abca5242d80d82b6353398df3cf5c2bd /lib
parent7d8d1c67ec71fbf24b8659faf684fbdc7ab79378 (diff)
downloadotp-673ecca781e7dcc5c006933a42b9a32ec744ebf3.tar.gz
otp-673ecca781e7dcc5c006933a42b9a32ec744ebf3.tar.bz2
otp-673ecca781e7dcc5c006933a42b9a32ec744ebf3.zip
ssh: Clearify links in ssh_sftp:read_file_info/2
Diffstat (limited to 'lib')
-rw-r--r--lib/ssh/doc/src/ssh_sftp.xml7
1 files changed, 6 insertions, 1 deletions
diff --git a/lib/ssh/doc/src/ssh_sftp.xml b/lib/ssh/doc/src/ssh_sftp.xml
index ed7fbf9cf3..129426a6d5 100644
--- a/lib/ssh/doc/src/ssh_sftp.xml
+++ b/lib/ssh/doc/src/ssh_sftp.xml
@@ -464,11 +464,16 @@
<v>FileInfo = record()</v>
</type>
<desc>
- <p>Returns a <c><![CDATA[file_info]]></c> record from the file specified by
+ <p>Returns a <c><![CDATA[file_info]]></c> record from the file system object specified by
<c><![CDATA[Name]]></c> or <c><![CDATA[Handle]]></c>. See
<seealso marker="kernel:file#read_file_info-2">file:read_file_info/2</seealso>
for information about the record.
</p>
+ <p>
+ Depending on the underlying OS:es links might be followed and info on the final file, directory
+ etc is returned. See <seealso marker="#read_link_info-2">ssh_sftp::read_link_info/2</seealso>
+ on how to get information on links instead.
+ </p>
</desc>
</func>