aboutsummaryrefslogtreecommitdiffstats
path: root/lib/kernel/doc
diff options
context:
space:
mode:
authorSiri Hansen <[email protected]>2018-08-14 15:45:02 +0200
committerSiri Hansen <[email protected]>2018-08-14 15:45:02 +0200
commit80fc5d8bbb7d3fbc626e7206ef8125fd6749a7c6 (patch)
tree2dc80d05f0fbe2a10231ab71006698275a103d1a /lib/kernel/doc
parent4fc61aa178faa80290356a63d8e38d93697b9669 (diff)
parent8df53e8de0c323efd03c959bef801216952722f8 (diff)
downloadotp-80fc5d8bbb7d3fbc626e7206ef8125fd6749a7c6.tar.gz
otp-80fc5d8bbb7d3fbc626e7206ef8125fd6749a7c6.tar.bz2
otp-80fc5d8bbb7d3fbc626e7206ef8125fd6749a7c6.zip
Merge branch 'siri/logger/single_line-unwanted-comma/OTP-15228' into maint
* siri/logger/single_line-unwanted-comma/OTP-15228: [logger] Avoid unwanted commas introduced by formatter's single_line option
Diffstat (limited to 'lib/kernel/doc')
-rw-r--r--lib/kernel/doc/src/logger_formatter.xml14
1 files changed, 10 insertions, 4 deletions
diff --git a/lib/kernel/doc/src/logger_formatter.xml b/lib/kernel/doc/src/logger_formatter.xml
index 9226d19834..5a060fd42b 100644
--- a/lib/kernel/doc/src/logger_formatter.xml
+++ b/lib/kernel/doc/src/logger_formatter.xml
@@ -130,10 +130,16 @@
</item>
<tag><c>single_line = boolean()</c></tag>
<item>
- <p>If set to <c>true</c>, all newlines in the message are
- replaced with <c>", "</c>, and white spaces following
- directly after newlines are removed. Notice that newlines
- added by the <c>template</c> parameter are not replaced.</p>
+ <p>If set to <c>true</c>, each log event is printed as a
+ single line. To achieve this, <c>logger_formatter</c>
+ sets the field width to <c>0</c> for all <c>~p</c>
+ and <c>~P</c> control sequences in the format a string
+ (see <seealso marker="stdlib:io#format-2">
+ <c>io:format/2</c></seealso>), and replaces all
+ newlines in the message with <c>", "</c>. White spaces
+ following directly after newlines are removed. Notice
+ that newlines added by the <c>template</c> parameter are
+ not replaced.</p>
<p>Defaults to <c>true</c>.</p>
</item>
<tag><marker id="template"/>