aboutsummaryrefslogtreecommitdiffstats
path: root/lib/runtime_tools/doc/src/dbg.xml
diff options
context:
space:
mode:
authorLukas Larsson <[email protected]>2016-03-18 19:46:04 +0100
committerLukas Larsson <[email protected]>2016-04-15 15:08:29 +0200
commit6117ee72af5c0c2973a0f20fb847a216825db03f (patch)
tree34017ddec7be46a1f2bd816c3182de88f6609642 /lib/runtime_tools/doc/src/dbg.xml
parentec6615584daa1ec4429127ca8ff6e506c72cddb9 (diff)
downloadotp-6117ee72af5c0c2973a0f20fb847a216825db03f.tar.gz
otp-6117ee72af5c0c2973a0f20fb847a216825db03f.tar.bz2
otp-6117ee72af5c0c2973a0f20fb847a216825db03f.zip
runtime_tools: Make dbg work with erl_tracer modules
OTP-13500
Diffstat (limited to 'lib/runtime_tools/doc/src/dbg.xml')
-rw-r--r--lib/runtime_tools/doc/src/dbg.xml17
1 files changed, 8 insertions, 9 deletions
diff --git a/lib/runtime_tools/doc/src/dbg.xml b/lib/runtime_tools/doc/src/dbg.xml
index ccb3bca50e..0128e23a47 100644
--- a/lib/runtime_tools/doc/src/dbg.xml
+++ b/lib/runtime_tools/doc/src/dbg.xml
@@ -288,7 +288,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\
</item>
</taglist>
<p>The list can also include any of the flags allowed in
- <c>erlang:trace/3</c></p>
+ <c><seealso marker="erts:erlang#trace-3">erlang:trace/3</seealso></c></p>
<p>The function returns either an error tuple or a tuple
<c>{ok, List}</c>. The <c>List</c> consists of
specifications of how many processes and ports that matched (in the
@@ -747,7 +747,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\
<v>Error = term()</v>
<v>HandlerSpec = {HandlerFun, InitialData}</v>
<v>HandlerFun = fun() (two arguments)</v>
- <v>ModuleSpec = {TracerModule, TracerState}</v>
+ <v>ModuleSpec = fun() (no arguments) | {TracerModule, TracerState}</v>
<v>ModuleModule = atom()</v>
<v>InitialData = TracerState = term()</v>
</type>
@@ -779,9 +779,9 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\
preferably generated by calling <c><seealso marker="#trace_port-2">trace_port/2</seealso></c>.
</p>
<p>if <c>Type</c> is <c>module</c>, then the second parameter should
- be a tuple describing the <c><seealso marker="erts:erl_tracer">erl_tracer</seealso></c>
+ be either a tuple describing the <c><seealso marker="erts:erl_tracer">erl_tracer</seealso></c>
module to be used for tracing and the state to be used for
- that tracer module.</p>
+ that tracer module or a fun returning the same tuple.</p>
<p>If an error is returned, it can either be due to a tracer
server already running (<c>{error,already_started}</c>) or
due to the <c>HandlerFun</c> throwing an exception.
@@ -800,8 +800,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\
<desc>
<p>This function is equivalent to <c><seealso marker="#tracer-2">tracer/2</seealso></c>, but acts on
the given node. A tracer is started on the node
- (<c>Nodename</c>) and the node is added to the list of traced
- nodes.
+ (<c>Nodename</c>) and the node is added to the list of traced nodes.
</p>
<note>
<p>This function is not equivalent to <c><seealso marker="#n-1">n/1</seealso></c>. While
@@ -1066,11 +1065,11 @@ hello</pre>
<fsummary>Return the process or port to which all trace messages are sent.</fsummary>
<type>
<v>Nodename = atom()</v>
- <v>Tracer = port() | pid()</v>
+ <v>Tracer = port() | pid() | {module(), term()}</v>
</type>
<desc>
- <p>Returns the process or port to which all trace
- messages are sent. </p>
+ <p>Returns the process, port or tracer module to which all trace
+ messages are sent.</p>
</desc>
</func>
<func>