aboutsummaryrefslogtreecommitdiffstats
path: root/lib/kernel/doc/src/logger_formatter.xml
diff options
context:
space:
mode:
authorSiri Hansen <[email protected]>2018-04-25 18:49:09 +0200
committerSiri Hansen <[email protected]>2018-04-26 14:37:31 +0200
commit992b57ad0a52f7a3ba945cbfaea53ce3ae3c3f5d (patch)
tree0e01eb4e704d89a52e29146606327616935efe3d /lib/kernel/doc/src/logger_formatter.xml
parent9397275e33805826eccf75868083ac22374d6194 (diff)
downloadotp-992b57ad0a52f7a3ba945cbfaea53ce3ae3c3f5d.tar.gz
otp-992b57ad0a52f7a3ba945cbfaea53ce3ae3c3f5d.tar.bz2
otp-992b57ad0a52f7a3ba945cbfaea53ce3ae3c3f5d.zip
Add chars_limit option to logger_formatter
Diffstat (limited to 'lib/kernel/doc/src/logger_formatter.xml')
-rw-r--r--lib/kernel/doc/src/logger_formatter.xml14
1 files changed, 11 insertions, 3 deletions
diff --git a/lib/kernel/doc/src/logger_formatter.xml b/lib/kernel/doc/src/logger_formatter.xml
index 213a592e47..6a17e3641f 100644
--- a/lib/kernel/doc/src/logger_formatter.xml
+++ b/lib/kernel/doc/src/logger_formatter.xml
@@ -77,13 +77,21 @@
rewritten. The format controls ~p and ~w are replaced with
~P and ~W, respectively, and the value is used as the depth
parameter. For details, see
- <seealso marker="stdlib:io#format-2">io:format/2</seealso>
+ <seealso marker="stdlib:io#format-2">io:format/2,3</seealso>
in STDLIB.</p>
+ <p><c>chars_limit</c> is a positive integer representing the
+ value of the option with the same name to be used when calling
+ <seealso marker="stdlib:io#format-3">io:format/3</seealso>. This
+ value limits the total number of characters printed bu the
+ formatter. Notes that this is a soft limit. For a hard
+ truncation limit, see option <c>max_size</c>.</p>
+
<p><c>max_size</c> is a positive integer representing the
maximum size a string returned from this formatter can
- have. If the formatted string is longer, it will be
- truncated.</p>
+ have. If the formatted string is longer, after possibly
+ being limited by <c>depth</c> and/or <c>chars_limit</c>, it
+ will be truncated.</p>
<p><c>utc</c> is a boolean. If set to true, all dates are
displayed in Universal Coordinated Time. Default