From 182c7b954620e9287ba2ddce9b1cbaceb1bddbaf Mon Sep 17 00:00:00 2001
From: Hans Nilsson <hans@erlang.org>
Date: Thu, 21 Jun 2018 10:38:51 +0200
Subject: ssh: Bug fix sftp error codes

Report the signal name if the signal error message is ""
Do not report a return code of 0 as an error.
---
 lib/ssh/doc/src/ssh_sftp.xml | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

(limited to 'lib/ssh/doc/src/ssh_sftp.xml')

diff --git a/lib/ssh/doc/src/ssh_sftp.xml b/lib/ssh/doc/src/ssh_sftp.xml
index 129426a6d5..f367560b5f 100644
--- a/lib/ssh/doc/src/ssh_sftp.xml
+++ b/lib/ssh/doc/src/ssh_sftp.xml
@@ -46,9 +46,9 @@
     <taglist>
       <tag><c>reason()</c></tag>
       <item>
-	<p>= <c>atom()</c> A description of the reason why an operation failed.</p>
+	<p>= <c>atom() | string() | tuple() </c>A description of the reason why an operation failed.</p>
 	<p>
-	  The value is formed from the sftp error codes in the protocol-level responses as defined in 
+	  The <c>atom()</c> value is formed from the sftp error codes in the protocol-level responses as defined in 
 	  <url href="https://tools.ietf.org/id/draft-ietf-secsh-filexfer-13.txt">draft-ietf-secsh-filexfer-13.txt</url>
 	  section 9.1.
 	</p>
@@ -57,6 +57,10 @@
 	  E.g. the error code <c>SSH_FX_NO_SUCH_FILE</c>
 	  will cause the <c>reason()</c> to be <c>no_such_file</c>.
 	</p>
+	<p>The <c>string()</c> reason is the error information from the server in case of an exit-signal.  If that information is empty, the reason is the exit signal name.
+	</p>
+	<p>The <c>tuple()</c> reason are other errors like the <c>{exit_status,integer()}</c> if the exit status is not 0.
+	</p>
       </item>
 
       <tag><c>ssh_connection_ref() =</c></tag>
-- 
cgit v1.2.3