aboutsummaryrefslogtreecommitdiffstats
path: root/lib/stdlib/doc
diff options
context:
space:
mode:
authorBjörn Gustavsson <bjorn@erlang.org>2015-08-25 15:07:43 +0200
committerBjörn Gustavsson <bjorn@erlang.org>2015-09-07 10:35:32 +0200
commit7df173516a08455304abd0a783c9e8b64e88859e (patch)
tree603100d431718131208db121f72fcba8f9a68a9c /lib/stdlib/doc
parent3c3a5b08589a6e54b0d2d81e470fcffaaa74c15c (diff)
downloadotp-7df173516a08455304abd0a783c9e8b64e88859e.tar.gz
otp-7df173516a08455304abd0a783c9e8b64e88859e.tar.bz2
otp-7df173516a08455304abd0a783c9e8b64e88859e.zip
proc_lib: Add format/3
We'll need a way to limit the size of the crash report produced by proc_lib:format(). Add format/3, where the third argument is a depth argument.
Diffstat (limited to 'lib/stdlib/doc')
-rw-r--r--lib/stdlib/doc/src/proc_lib.xml11
1 files changed, 11 insertions, 0 deletions
diff --git a/lib/stdlib/doc/src/proc_lib.xml b/lib/stdlib/doc/src/proc_lib.xml
index 86ade8840f..85f0c0c908 100644
--- a/lib/stdlib/doc/src/proc_lib.xml
+++ b/lib/stdlib/doc/src/proc_lib.xml
@@ -227,6 +227,17 @@ init(Parent) ->
</desc>
</func>
<func>
+ <name name="format" arity="3"/>
+ <fsummary>Format a crash report.</fsummary>
+ <desc>
+ <p>This function can be used by a user defined event handler to
+ format a crash report. When <anno>Depth</anno> is given as an
+ positive integer, it will be used in the format string to
+ limit the output as follows: <c>io_lib:format("~P",
+ [Term,<anno>Depth</anno>])</c>.</p>
+ </desc>
+ </func>
+ <func>
<name name="initial_call" arity="1"/>
<fsummary>Extract the initial call of a <c>proc_lib</c>spawned process.</fsummary>
<desc>