aboutsummaryrefslogtreecommitdiffstats
path: root/lib/kernel/doc/src/logger_chapter.xml
diff options
context:
space:
mode:
authorSiri Hansen <[email protected]>2018-09-17 12:53:37 +0200
committerSiri Hansen <[email protected]>2018-09-17 12:53:37 +0200
commit9eb252b378cf0dbfa88d2012155fa347c8d5162c (patch)
tree5acb7e845c8d08326cee544f62ad5e48e4d8cf53 /lib/kernel/doc/src/logger_chapter.xml
parent125d8095ecb012e74d9102a97ef341d676aa46ed (diff)
parent926bfd6f0bd71a8942f268cf23a37b55776600d2 (diff)
downloadotp-9eb252b378cf0dbfa88d2012155fa347c8d5162c.tar.gz
otp-9eb252b378cf0dbfa88d2012155fa347c8d5162c.tar.bz2
otp-9eb252b378cf0dbfa88d2012155fa347c8d5162c.zip
Merge branch 'maint'
Diffstat (limited to 'lib/kernel/doc/src/logger_chapter.xml')
-rw-r--r--lib/kernel/doc/src/logger_chapter.xml12
1 files changed, 7 insertions, 5 deletions
diff --git a/lib/kernel/doc/src/logger_chapter.xml b/lib/kernel/doc/src/logger_chapter.xml
index 7859b49d7e..fdb21fa24c 100644
--- a/lib/kernel/doc/src/logger_chapter.xml
+++ b/lib/kernel/doc/src/logger_chapter.xml
@@ -208,11 +208,13 @@
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 cannot 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
+ <p>The fun must obey the <c>depth</c> and <c>chars_limit</c>
+ parameters provided in the second argument, as the formatter
+ cannot do anything useful of these parameters with the
+ returned string. The extra data also contains a field named
+ <c>single_line</c>, indicating if the printed log message may
+ contain line breaks or not. This variant is used when the
+ formatting of the report depends on the size or single line
parameters.</p>
<p>Example, format string and arguments:</p>
<code>logger:error("The file does not exist: ~ts",[Filename])</code>