aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHans Nilsson <[email protected]>2018-03-01 10:23:51 +0100
committerHans Nilsson <[email protected]>2018-03-01 10:23:51 +0100
commit9fe3d672c9c1f61ae648dcdbc9452a8bd3368ce5 (patch)
tree8d480a2642e3d6bd0e51369b5ca0a04cbb1fc601
parent9574395f47164982baf9c31258c696a7f950f582 (diff)
parent673ecca781e7dcc5c006933a42b9a32ec744ebf3 (diff)
downloadotp-9fe3d672c9c1f61ae648dcdbc9452a8bd3368ce5.tar.gz
otp-9fe3d672c9c1f61ae648dcdbc9452a8bd3368ce5.tar.bz2
otp-9fe3d672c9c1f61ae648dcdbc9452a8bd3368ce5.zip
Merge branch 'hans/ssh/cuddle_doc' into maint
* hans/ssh/cuddle_doc: ssh: Clearify links in ssh_sftp:read_file_info/2
-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>