From 673ecca781e7dcc5c006933a42b9a32ec744ebf3 Mon Sep 17 00:00:00 2001
From: Hans Nilsson <hans@erlang.org>
Date: Mon, 26 Feb 2018 12:24:15 +0100
Subject: ssh: Clearify links in ssh_sftp:read_file_info/2

---
 lib/ssh/doc/src/ssh_sftp.xml | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

(limited to 'lib/ssh/doc')

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>
 
-- 
cgit v1.2.3