From 7df173516a08455304abd0a783c9e8b64e88859e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B6rn=20Gustavsson?= <bjorn@erlang.org>
Date: Tue, 25 Aug 2015 15:07:43 +0200
Subject: 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.
---
 lib/stdlib/doc/src/proc_lib.xml | 11 +++++++++++
 1 file changed, 11 insertions(+)

(limited to 'lib/stdlib/doc/src')

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
@@ -226,6 +226,17 @@ init(Parent) ->
           <c>Pid</c> which sent the crash report.</p>
       </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>
-- 
cgit v1.2.3