From df622b62f72b6509505b32380fbb88203616868d Mon Sep 17 00:00:00 2001
From: Hans Nilsson <hans@erlang.org>
Date: Thu, 5 Nov 2015 17:39:46 +0100
Subject: ssh, public_key: updates after doc review

---
 lib/ssh/doc/src/ssh.xml | 38 ++++++++++++++++++++++++++------------
 1 file changed, 26 insertions(+), 12 deletions(-)

(limited to 'lib/ssh/doc')

diff --git a/lib/ssh/doc/src/ssh.xml b/lib/ssh/doc/src/ssh.xml
index 06bc39f8fe..43db63e7e6 100644
--- a/lib/ssh/doc/src/ssh.xml
+++ b/lib/ssh/doc/src/ssh.xml
@@ -464,27 +464,41 @@ kex is implicit but public_key is set explicitly.</p>
 
 	  <tag><c><![CDATA[{dh_gex_groups, [{Size=integer(),G=integer(),P=integer()}] | {file,filename()} {ssh_moduli_file,filename()} }]]></c></tag>
 	  <item>
-	    <p>Sets the groups that the server may choose among when diffie-hellman-group-exchange is negotiated.
-	    See RFC 4419 for details.
+	    <p>Defines the groups the server may choose among when diffie-hellman-group-exchange is negotiated.
+	    See RFC 4419 for details. The three variants of this option are:
 	    </p>
-	    <p>The default list is fetched from the public_key application.
-	    </p>
-	    <p>If the parameter is <c>{file,filename()}</c>, the file must exist and have one or more three-tuples terminated by a dot. The interpretation is as if the tuples had been given directly in the option.  The file is read when the daemon starts.
-	    </p>
-	    <p>If the parameter is <c>{ssh_moduli_file,filename()}</c>, the file must exist and be in ssh-keygen moduli file format.  The file is read when the daemon starts.
+	    <taglist>
+	      <tag><c>{Size=integer(),G=integer(),P=integer()}</c></tag>
+	      <item>The groups are given explicitly in this list. There may be several elements with the same <c>Size</c>.
+	      In such a case, the server will choose one randomly in the negotiated Size.
+	      </item>
+	      <tag><c>{file,filename()}</c></tag>
+	      <item>The file must have one or more three-tuples <c>{Size=integer(),G=integer(),P=integer()}</c> 
+	      terminated by a dot. The file is read when the daemon starts.
+	      </item>
+	      <tag><c>{ssh_moduli_file,filename()}</c></tag>
+	      <item>The file must be in
+	      <seealso marker="public_key:public_key#public_key/4">ssh-keygen moduli file format</seealso>.
+	      The file is read when the daemon starts.
+	      </item>
+	    </taglist>
+	    <p>The default list is fetched from the 
+	      <seealso marker="public_key:public_key#public_key/4">public_key</seealso> application.
 	    </p>
 	  </item>
 
 	  <tag><c><![CDATA[{dh_gex_limits,{Min=integer(),Max=integer()}}]]></c></tag>
 	  <item>
-	    <p>Limits the key Sizes what a client can ask for in diffie-hellman-group-exchange.
-	    The effective value will be
-	    <c>MaxUsed = min(MaxClient,Max), MinUsed = max(MinClient,Min)</c>.
-	    The default value is <c>{0,infinity}</c>.
+	    <p>Limits what a client can ask for in diffie-hellman-group-exchange.
+	    The limits will be
+	    <c>{MaxUsed = min(MaxClient,Max), MinUsed = max(MinClient,Min)}</c> where <c>MaxClient</c> and 
+	    <c>MinClient</c> are the values proposed by a connecting client.
+	    </p>
+	    <p>The default value is <c>{0,infinity}</c>.
 	    </p>
 	    <p>If <c>MaxUsed &lt; MinUsed</c> in a key exchange, it will fail with a disconnect.
 	    </p>
-	    <p>See RFC 4419 for the function of the Max an Min values.</p>
+	    <p>See RFC 4419 for the function of the Max and Min values.</p>
 	  </item>
 
 	  <tag><c><![CDATA[{pwdfun, fun(User::string(), password::string()) -> boolean()}]]></c></tag>
-- 
cgit v1.2.3