From 270d909696a753af022df72a404c73f2895b4a02 Mon Sep 17 00:00:00 2001
From: Siri Hansen <siri@erlang.org>
Date: Thu, 28 Jun 2018 14:52:11 +0200
Subject: [logger] Allow report callback with two arguments returning a string

If the report callback is a fun of arity 2, then the second argument
is a map with the keys 'encoding', 'depth' and 'chars_limit', and the
fun must return a string which is size limited according to the given
depth and chars_limit.

If the report callback is a fun of arity 1, then it must return a
tuple containing a format string and a list of arguments. The
formatter will produce the string, and limit it's size.
---
 lib/kernel/doc/src/logger.xml | 21 ++++++++++++++++++++-
 1 file changed, 20 insertions(+), 1 deletion(-)

(limited to 'lib/kernel/doc/src/logger.xml')

diff --git a/lib/kernel/doc/src/logger.xml b/lib/kernel/doc/src/logger.xml
index 8bf62a6b39..f1830a8224 100644
--- a/lib/kernel/doc/src/logger.xml
+++ b/lib/kernel/doc/src/logger.xml
@@ -227,7 +227,10 @@ logger:error("error happened because: ~p", [Reason]). % Without macro
 	      a <seealso marker="#type-report"><c>report()</c></seealso>,
 	      the <c>report_cb</c> key can be associated with a fun
 	      (report callback) that converts the report to a format
-	      string and arguments. See
+	      string and arguments, or directly to a string. See the
+	      type definition
+	      of <seealso marker="#type-report_cb"><c>report_cb()</c></seealso>,
+	      and
 	      section <seealso marker="logger_chapter#log_message">Log
 	      Message</seealso> in the User's Guide for more
 	      information about report callbacks.</p>
@@ -259,6 +262,22 @@ logger:error("error happened because: ~p", [Reason]). % Without macro
 	<p></p>
       </desc>
     </datatype>
+    <datatype>
+      <name name="report_cb"/>
+      <desc>
+	<p>A fun which converts a <seealso marker="#type-report"><c>report()</c>
+	  </seealso> to a format string and arguments, or directly to a string.
+	  See section <seealso marker="logger_chapter#log_message">Log
+	    Message</seealso> in the User's Guide for more
+	  information.</p>
+      </desc>
+    </datatype>
+    <datatype>
+      <name name="report_cb_config"/>
+      <desc>
+	<p></p>
+      </desc>
+    </datatype>
     <datatype>
       <name name="timestamp"/>
       <desc>
-- 
cgit v1.2.3