From a11ab6550423d48d45dfc9ed4eb35cb4bef9e5e3 Mon Sep 17 00:00:00 2001
From: Ingela Anderton Andin <ingela@erlang.org>
Date: Fri, 20 May 2016 16:37:42 +0200
Subject: ssl: Add default values and clarifications

---
 lib/ssl/doc/src/ssl_app.xml | 27 +++++++++++++++++++--------
 1 file changed, 19 insertions(+), 8 deletions(-)

(limited to 'lib')

diff --git a/lib/ssl/doc/src/ssl_app.xml b/lib/ssl/doc/src/ssl_app.xml
index daa06a40fc..e50ffdbfe6 100644
--- a/lib/ssl/doc/src/ssl_app.xml
+++ b/lib/ssl/doc/src/ssl_app.xml
@@ -94,7 +94,10 @@
       to <c>ssl:connect/[2,3]</c> and <c>ssl:listen/2</c>.</p></item>
 
       <tag><c><![CDATA[session_lifetime = integer() <optional>]]></c></tag>
-      <item><p>Maximum lifetime of the session data in seconds.</p></item>
+      <item><p>Maximum lifetime of the session data in seconds. Defaults to 24 hours which is the maximum
+      recommended lifetime by <url href="http://www.ietf.org/rfc/5246rfc.txt">RFC 5246</url>. However
+      sessions may be invalidated earlier due to the maximum limitation of the session cache table.
+      </p></item>
 
       <tag><c><![CDATA[session_cb = atom() <optional>]]></c></tag>
       <item><p>Name of the session cache callback module that implements
@@ -107,16 +110,24 @@
       in the session cache callback module. Defaults to <c>[]</c>.</p></item>
 
       <tag><c><![CDATA[session_cache_client_max = integer() <optional>]]></c><br/>
-      <c><![CDATA[session_cache_server_max = integer() <optional>]]></c></tag>
-      <item><p>Limits the growth of the clients/servers session cache,
-      if the maximum number of sessions is reached, the current cache entries will
-      be invalidated regardless of their remaining lifetime. Defaults to 1000.
-      </p></item>
+      <item><p>Limits the growth of the clients session cache, that is
+      how many sessions towards servers that are cached to be used by
+      new client connections.  If the maximum number of sessions is
+      reached, the current cache entries will be invalidated
+      regardless of their remaining lifetime. Defaults to
+      1000.</p></item>
+
+      <tag> <c><![CDATA[session_cache_server_max = integer() <optional>]]></c></tag>
+      <item><p>Limits the growth of the servers session cache, that is
+      how many client sessions are cached by the server. If the
+      maximum number of sessions is reached, the current cache entries
+      will be invalidated regardless of their remaining
+      lifetime. Defaults to 1000.</p></item>
       
       <tag><c><![CDATA[ssl_pem_cache_clean = integer() <optional>]]></c></tag>
       <item>
 	<p>
-	  Number of milliseconds between PEM cache validations.
+	  Number of milliseconds between PEM cache validations. Defaults to 2 minutes.
 	</p>
 	<seealso
 	    marker="ssl#clear_pem_cache-0">ssl:clear_pem_cache/0</seealso>
@@ -131,7 +142,7 @@
 	  shutdown gracefully. Defaults to 5000 milliseconds.   
 	</p>
       </item>
-
+      </tag>
       
     </taglist>
   </section>
-- 
cgit v1.2.3