summaryrefslogtreecommitdiff
path: root/lib/ssh/doc/src/ssh.xml
diff options
context:
space:
mode:
authorHans Nilsson <hans@erlang.org>2019-09-04 11:57:08 +0200
committerHans Nilsson <hans@erlang.org>2019-09-06 11:05:12 +0200
commit41605e48e1305bf2a2fd5971f41c6576cefe2ff7 (patch)
tree02f3c15f0271d529ed264a40d51d2ad8dbbf4a59 /lib/ssh/doc/src/ssh.xml
parent4ab8270c2cc8fb6f7bd5e6d3641a80dc78a7b490 (diff)
downloaderlang-41605e48e1305bf2a2fd5971f41c6576cefe2ff7.tar.gz
ssh: Extend ssh:daemon_info
Diffstat (limited to 'lib/ssh/doc/src/ssh.xml')
-rw-r--r--lib/ssh/doc/src/ssh.xml9
1 files changed, 8 insertions, 1 deletions
diff --git a/lib/ssh/doc/src/ssh.xml b/lib/ssh/doc/src/ssh.xml
index f648285266..f229561ff0 100644
--- a/lib/ssh/doc/src/ssh.xml
+++ b/lib/ssh/doc/src/ssh.xml
@@ -1175,9 +1175,16 @@
<!-- DAEMON_INFO/1 -->
<func>
<name name="daemon_info" arity="1" since="OTP 19.0"/>
+ <name name="daemon_info" arity="2" since=""/>
<fsummary>Get info about a daemon</fsummary>
<desc>
- <p>Returns a key-value list with information about the daemon.</p>
+ <p>Returns information about a daemon intended for e.g debugging or logging.
+ </p>
+ <p>When the <c>Key</c> is a single <c>Item</c>, the result is a single <c>InfoTuple</c>
+ </p>
+ <p>Note that <c>daemon_info/1</c> and <c>daemon_info/2</c> returns different types
+ due to compatibility reasons.
+ </p>
</desc>
</func>