From cfbe1afe6ba1f1083c8aa41c7aeb422f253f5d23 Mon Sep 17 00:00:00 2001
From: Siri Hansen <siri@erlang.org>
Date: Fri, 18 May 2018 13:27:56 +0200
Subject: Add logger:update_formatter_config/2,3

---
 lib/kernel/doc/src/logger.xml         | 25 +++++++++++++++++++++++++
 lib/kernel/doc/src/logger_chapter.xml |  6 +++---
 2 files changed, 28 insertions(+), 3 deletions(-)

(limited to 'lib/kernel/doc')

diff --git a/lib/kernel/doc/src/logger.xml b/lib/kernel/doc/src/logger.xml
index f7e740e90d..be733685cc 100644
--- a/lib/kernel/doc/src/logger.xml
+++ b/lib/kernel/doc/src/logger.xml
@@ -773,6 +773,31 @@ logger:set_handler_config(HandlerId,maps:merge(Old,Config)).
       </desc>
     </func>
 
+    <func>
+      <name name="update_formatter_config" arity="2"/>
+      <fsummary>Update the formatter configuration for the specified handler.</fsummary>
+      <desc>
+        <p>Update the formatter configuration for the specified handler.</p>
+	<p>The new configuration is merged with the existing formatter
+	  configuration.</p>
+	<p>To overwrite the existing configuration without any merge,
+	  use <seealso marker="#set_handler_config-3">
+	    <c>set_handler_config(HandlerId,formatter,
+	      {FormatterModule,FormatterConfig})</c></seealso>.</p>
+      </desc>
+    </func>
+
+    <func>
+      <name name="update_formatter_config" arity="3"/>
+      <fsummary>Update the formatter configuration for the specified handler.</fsummary>
+      <desc>
+        <p>Update the formatter configuration for the specified handler.</p>
+	<p>This is equivalent
+	  to <br/><seealso marker="#update_formatter_config-2">
+	    <c>update_formatter_config(<anno>HandlerId</anno>,#{<anno>Key</anno>=><anno>Value</anno>})</c></seealso></p>
+      </desc>
+    </func>
+
     <func>
       <name name="compare_levels" arity="2"/>
       <fsummary>Compare the severity of two log levels.</fsummary>
diff --git a/lib/kernel/doc/src/logger_chapter.xml b/lib/kernel/doc/src/logger_chapter.xml
index 21b460e72a..522d0ce29d 100644
--- a/lib/kernel/doc/src/logger_chapter.xml
+++ b/lib/kernel/doc/src/logger_chapter.xml
@@ -157,7 +157,7 @@
 	  <p>A formatter is defined as a module exporting the following
 	    function:</p>
 
-	  <code>format(Log,Extra) -> unicode:chardata()</code>
+	  <code>format(Log,FConfig) -> unicode:chardata()</code>
 
 	  <p>The formatter callback is called by each handler, and the
 	    returned string can be printed to the handler's destination
@@ -413,12 +413,12 @@
 	    return <c>ignore</c>.</p>
 	  <p>Default is <c>log</c>.</p>
 	</item>
-	<tag><c>formatter = {Module::module(),Extra::term()}</c></tag>
+	<tag><c>formatter = {FModule::module(),FConfig::map()}</c></tag>
 	<item>
 	  <p>See <seealso marker="#Formatter">Formatter</seealso> for more
 	    information.</p>
 	  <p>The default module is <seealso marker="logger_formatter">
-	      <c>logger_formatter</c></seealso>, and <c>Extra</c> is
+	      <c>logger_formatter</c></seealso>, and <c>FConfig</c> is
 	      it's configuration map.</p>
 	</item>
         <tag>HandlerConfig, <c>term() = term()</c></tag>
-- 
cgit v1.2.3