From b246e47d53d4b738fe47df1d7bf71138a8501e02 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Johannes=20Wei=C3=9Fl?= <jargon@molb.org>
Date: Mon, 27 Jan 2014 00:43:00 +0100
Subject: ssh: Fix dialyzer type specs and documentation

Similar to d9ebfb8. The wrong specs were leading to dialyzer warnings
like this in our application since R16B03:

The pattern 'ok' can never match the type {'error',_}.
The pattern {'error', {'already_started', 'ssh'}} can never match the type 'ok'.
The pattern {'error', _} can never match the type {'open_error',_,string(),string()}.
---
 lib/ssh/doc/src/ssh.xml | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

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

diff --git a/lib/ssh/doc/src/ssh.xml b/lib/ssh/doc/src/ssh.xml
index c1a51d57fc..3a16eb29fa 100644
--- a/lib/ssh/doc/src/ssh.xml
+++ b/lib/ssh/doc/src/ssh.xml
@@ -365,8 +365,11 @@
     </func>
 
     <func>
-      <name>stop() -> ok </name>
+      <name>stop() -> ok | {error, Reason}</name>
       <fsummary>Stops the SSH application.</fsummary>
+      <type>
+        <v>Reason = term()</v>
+      </type>
       <desc>
         <p>Stops the SSH application. See also
           <seealso marker="kernel:application">application(3)</seealso></p>
-- 
cgit v1.2.3