aboutsummaryrefslogtreecommitdiffstats
path: root/lib/kernel/doc/src/logger_chapter.xml
diff options
context:
space:
mode:
authorSiri Hansen <[email protected]>2018-08-31 17:08:24 +0200
committerSiri Hansen <[email protected]>2018-09-12 14:58:02 +0200
commit96c1aa0041b368afceef0aef88e82a6c9f8e901d (patch)
tree2d0f3e086f3dd2b089968c7681786ffcd27c9cee /lib/kernel/doc/src/logger_chapter.xml
parent25b2daf1aa19c60eb12964015cc466dc506a3d89 (diff)
downloadotp-96c1aa0041b368afceef0aef88e82a6c9f8e901d.tar.gz
otp-96c1aa0041b368afceef0aef88e82a6c9f8e901d.tar.bz2
otp-96c1aa0041b368afceef0aef88e82a6c9f8e901d.zip
[logger] Remove encoding option from logger_formatter
The encoding option was introduced in commit 270d909696a753af022df72a404c73f2895b4a02, to allow report callbacks to format according to a given encoding. There was, however, no connection between this encoding option, and the encoding of the device to which the logger handler was writing. Since a formatter is defined to return unicode:chardata(), and in order to avoid mismatch with the encoding of the device, the encoding option is now removed from the formatter. The handler itself must make sure that it does not write illegal data to its device.
Diffstat (limited to 'lib/kernel/doc/src/logger_chapter.xml')
-rw-r--r--lib/kernel/doc/src/logger_chapter.xml11
1 files changed, 5 insertions, 6 deletions
diff --git a/lib/kernel/doc/src/logger_chapter.xml b/lib/kernel/doc/src/logger_chapter.xml
index d58c4a4d42..26066d0777 100644
--- a/lib/kernel/doc/src/logger_chapter.xml
+++ b/lib/kernel/doc/src/logger_chapter.xml
@@ -208,12 +208,11 @@
coversion to a string:</p>
<pre>fun((<seealso marker="logger#type-report"><c>logger:report()</c></seealso>,<seealso marker="logger#type-report_cb_config"><c>logger:report_cb_config()</c></seealso>) -> <seealso marker="stdlib:unicode#type-chardata"><c>unicode:chardata()</c></seealso>)
</pre>
- <p>The fun must obey the <c>encoding</c>, <c>depth</c>
- and <c>chars_limit</c> parameters provided in the second
- argument, as the formatter can not do anything useful of these
- parameters with the returned string. This variant is used when
- the formatting of the report depends on the size and encoding
- parameters.</p>
+ <p>The fun must obey the <c>depth</c> and <c>chars_limit</c>
+ parameters provided in the second argument, as the formatter
+ can not do anything useful of these parameters with the
+ returned string. This variant is used when the formatting of
+ the report depends on the size parameters.</p>
<p>Example, format string and arguments:</p>
<code>logger:error("The file does not exist: ~ts",[Filename])</code>
<p>Example, string:</p>