aboutsummaryrefslogtreecommitdiffstats
path: root/lib/observer
diff options
context:
space:
mode:
authorBjörn Gustavsson <[email protected]>2013-10-10 10:55:18 +0200
committerBjörn Gustavsson <[email protected]>2013-10-10 10:56:54 +0200
commitc552255525f51fcd06e847149b8ce83bb0a99626 (patch)
tree6b6543007867689afcd735a8ce36987854d827cc /lib/observer
parent3abf1b5ef82478b152581152ad3ec749e8b7edaa (diff)
downloadotp-c552255525f51fcd06e847149b8ce83bb0a99626.tar.gz
otp-c552255525f51fcd06e847149b8ce83bb0a99626.tar.bz2
otp-c552255525f51fcd06e847149b8ce83bb0a99626.zip
Documentation of tracer/2: Use the correct option name 'overload_check'
The implementation and the documentation disagreed on the name of option.
Diffstat (limited to 'lib/observer')
-rw-r--r--lib/observer/doc/src/ttb.xml7
1 files changed, 4 insertions, 3 deletions
diff --git a/lib/observer/doc/src/ttb.xml b/lib/observer/doc/src/ttb.xml
index 4e63aecbf2..1453bbdf10 100644
--- a/lib/observer/doc/src/ttb.xml
+++ b/lib/observer/doc/src/ttb.xml
@@ -105,8 +105,9 @@ ttb:p(all, call)</code>
<v>Nodes = atom() | [atom()] | all | existing | new</v>
<v>Opts = Opt | [Opt]</v>
<v>Opt = {file,Client} | {handler, FormatHandler} | {process_info,PI} |
- shell | {shell, ShellSpec} | {timer, TimerSpec} | {overload, {MSec, Module, Function}}
- | {flush, MSec} | resume | {resume, FetchTimeout}</v>
+ shell | {shell, ShellSpec} | {timer, TimerSpec} |
+ {overload_check, {MSec, Module, Function}} |
+ {flush, MSec} | resume | {resume, FetchTimeout}</v>
<v>TimerSpec = MSec | {MSec, StopOpts}</v>
<v>MSec = FetchTimeout = integer()</v>
<v>Module = Function = atom() </v>
@@ -158,7 +159,7 @@ ttb:p(all, call)</code>
network communication are always present. The timer starts after
<c>ttb:p/2</c> is issued, so you can set up your trace patterns before.
</p>
- <p>The <c>overload</c> option allows to enable overload
+ <p>The <c>overload_check</c> option allows to enable overload
checking on the nodes under trace. <c>Module:Function(check)</c>
is performed each <c>MSec</c> milliseconds. If the check returns
<c>true</c>, the tracing is disabled on a given node.<br/>