From 4fd537f3984c7c5169e06438bdfb76e784e077f0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?P=C3=A9ter=20Dimitrov?= <peterdmv@erlang.org>
Date: Wed, 20 Jun 2018 10:42:09 +0200
Subject: ssl: Add documentation to the log_level option

Change-Id: Ibbb66f62c122cac2b1b6bd7f09cdaede4a86bd97
---
 lib/ssl/doc/src/ssl.xml | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

(limited to 'lib')

diff --git a/lib/ssl/doc/src/ssl.xml b/lib/ssl/doc/src/ssl.xml
index ab9f485464..2f4cc7d8d7 100644
--- a/lib/ssl/doc/src/ssl.xml
+++ b/lib/ssl/doc/src/ssl.xml
@@ -88,6 +88,7 @@
 	<p><c>| {client_preferred_next_protocols, {client | server,
 	[binary()]} | {client | server, [binary()], binary()}}</c></p>
 	<p><c>| {log_alert, boolean()}</c></p>
+	<p><c>| {log_level, atom()}</c></p>
 	<p><c>| {server_name_indication, hostname() | disable}</c></p>
 	<p><c>| {customize_hostname_check, list()}</c></p>
 	<p><c>| {sni_hosts, [{hostname(), [ssl_option()]}]}</c></p>
@@ -796,7 +797,17 @@ fun(srp, Username :: string(), UserState :: term()) ->
       the client.</p></item>
 
       <tag><c>{log_alert, boolean()}</c></tag>
-      <item><p>If set to <c>false</c>, error reports are not displayed.</p></item>
+      <item><p>If set to <c>false</c>, error reports are not displayed.</p>
+      <p>Deprecated in OTP 22, use <seealso marker="#log_level">log_level</seealso> instead.</p>
+      </item>
+
+      <tag><marker id="log_level"/><c>{log_level, atom()}</c></tag>
+      <item><p>Specifies the log level for TLS/DTLS. It can take the following
+      values (ordered by increasing verbosity level): <c>emergency, alert, critical, error,
+      warning, notice, info, debug.</c></p>
+      <p>At verbosity level <c>notice</c> and above error reports are
+      displayed in TLS. The level <c>debug</c> triggers verbose logging of TLS protocol
+      messages and logging of ignored alerts in DTLS.</p></item>
 
       <tag><c>{honor_cipher_order, boolean()}</c></tag>
       <item><p>If set to <c>true</c>, use the server preference for cipher
-- 
cgit v1.2.3