From d73f47345776d3567b50115af69d551077909514 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B6rn=20Gustavsson?= <bjorn@erlang.org>
Date: Fri, 28 Aug 2015 14:45:56 +0200
Subject: Add documentation

---
 lib/kernel/doc/src/kernel_app.xml | 37 +++++++++++++++++++++++++++++++++++++
 lib/sasl/doc/src/sasl_app.xml     | 12 ++++++++++--
 2 files changed, 47 insertions(+), 2 deletions(-)

(limited to 'lib')

diff --git a/lib/kernel/doc/src/kernel_app.xml b/lib/kernel/doc/src/kernel_app.xml
index 2cea38bae9..956c57f7c1 100644
--- a/lib/kernel/doc/src/kernel_app.xml
+++ b/lib/kernel/doc/src/kernel_app.xml
@@ -43,6 +43,7 @@
       <item><c>erl_boot_server</c></item>
       <item><c>erl_ddll</c></item>
       <item><c>error_logger</c></item>
+      <item><c>error_logger_format_depth</c></item>
       <item><c>file</c></item>
       <item><c>global</c></item>
       <item><c>global_group</c></item>
@@ -152,6 +153,42 @@
           </item>
         </taglist>
       </item>
+      <tag><c>error_logger_format_depth = Depth</c></tag>
+      <item>
+        <marker id="error_logger_format_depth"></marker>
+	<p>This parameter can be used to limit the size of the
+	formatted output from the error logger event handlers.</p>
+
+	<note><p>This configuration parameter was introduced in OTP 18.1.
+	It is currently experimental. Based on user feedback it
+	may be changed or improved in future releases, for example
+	to gain better control over how to limit the size of the
+	formatted output. We have no plans to entirely remove this
+	new feature, unless it turns out to be completely
+	useless. In OTP 19, the default may be changed to limit the
+	formatted output.</p></note>
+
+        <p><c>Depth</c> is a positive integer that is the maximum
+        depth to which terms are printed by the error logger event
+        handlers included in OTP. Specifically, the two event handlers
+        defined by the <c>Kernel</c> application and the two event
+        handlers in the <c>SASL</c> application will use this
+        configuration parameter. (If you have implemented you own
+        error handlers, this configuration parameter will have no
+        effect on them.)</p>
+
+	<p>The way <c>Depth</c> is used, is that format strings
+	string passed to the event handlers will be rewritten.
+	The "~p" and "~w" format controls will be replaced with
+	"~P" and "~W", respectively, and <c>Depth</c> will be
+	used as the depth parameter. See
+	<seealso marker="stdlib:io#format/2">io:format/2</seealso>.</p>
+
+	<note><p>A reasonable starting value for <c>Depth</c> is
+	<c>30</c>.  You should test crashing various processes in your
+	application and examine the logs from the crashes, and then
+	either increase or decrease the value.</p></note>
+     </item>
       <tag><c>global_groups = [GroupTuple]</c></tag>
       <item>
         <p>Defines global groups, see
diff --git a/lib/sasl/doc/src/sasl_app.xml b/lib/sasl/doc/src/sasl_app.xml
index 7cdb3e2ca7..fe38e69ce3 100644
--- a/lib/sasl/doc/src/sasl_app.xml
+++ b/lib/sasl/doc/src/sasl_app.xml
@@ -57,11 +57,19 @@
     <taglist>
       <tag><c>sasl_report_tty_h</c></tag>
       <item>
-        <p>Formats and writes <em>supervisor reports</em>, <em>crash reports</em> and <em>progress reports</em> to <c>stdio</c>.</p>
+        <p>Formats and writes <em>supervisor reports</em>, <em>crash reports</em> and <em>progress reports</em> to <c>stdio</c>.
+	This error logger event handler will use
+	<seealso marker="kernel:kernel_app#error_logger_format_depth">error_logger_format_depth</seealso>
+	in the Kernel application to limit how much detail are printed to
+	for crash and supervisor reports.</p>
       </item>
       <tag><c>sasl_report_file_h</c></tag>
       <item>
-        <p>Formats and writes <em>supervisor reports</em>, <em>crash report</em> and <em>progress report</em> to a single file.</p>
+        <p>Formats and writes <em>supervisor reports</em>, <em>crash report</em> and <em>progress report</em> to a single file.
+	This error logger event handler will use
+	<seealso marker="kernel:kernel_app#error_logger_format_depth">error_logger_format_depth</seealso>
+	in the Kernel application to limit how much detail are printed to
+	for crash and supervisor reports.</p>
       </item>
       <tag><c>log_mf_h</c></tag>
       <item>
-- 
cgit v1.2.3