aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHans Bolinder <[email protected]>2015-10-13 14:02:48 +0200
committerHans Bolinder <[email protected]>2015-12-09 13:05:34 +0100
commit3e0e79218065458b816cd726bd637f1ecd00a882 (patch)
tree72b89dc87ae86251adfd9d504d2518e4614101cd
parent646e1b9e6a836526865f15582bb22c600c54d26a (diff)
downloadotp-3e0e79218065458b816cd726bd637f1ecd00a882.tar.gz
otp-3e0e79218065458b816cd726bd637f1ecd00a882.tar.bz2
otp-3e0e79218065458b816cd726bd637f1ecd00a882.zip
[observer] Correct documentation
Fix mistakes found by 'xmllint'.
-rw-r--r--lib/observer/doc/src/crashdump_ug.xml2
-rw-r--r--lib/observer/doc/src/notes.xml12
-rw-r--r--lib/observer/doc/src/observer_ug.xml3
-rw-r--r--lib/observer/doc/src/ttb.xml17
-rw-r--r--lib/observer/doc/src/ttb_ug.xml7
5 files changed, 16 insertions, 25 deletions
diff --git a/lib/observer/doc/src/crashdump_ug.xml b/lib/observer/doc/src/crashdump_ug.xml
index 3cd97f2f18..4bb3628ab5 100644
--- a/lib/observer/doc/src/crashdump_ug.xml
+++ b/lib/observer/doc/src/crashdump_ug.xml
@@ -377,7 +377,6 @@
<p>The <em>Memory</em> panel shows memory and allocator
information. From the left hand menu you can select:</p>
- <p>
<list>
<item><em>Memory</em> <seealso
@@ -394,7 +393,6 @@
marker="erts:crash_dump#allocated_areas">More...</seealso></item>
</list>
- </p>
</section>
<section>
diff --git a/lib/observer/doc/src/notes.xml b/lib/observer/doc/src/notes.xml
index 5243f50e34..f0c87d865e 100644
--- a/lib/observer/doc/src/notes.xml
+++ b/lib/observer/doc/src/notes.xml
@@ -273,13 +273,12 @@
<section><title>Improvements and New Features</title>
<list>
<item>
- <p>
<list> <item> The new Memory field from a crash dump is
now presented by crashdump viewer, both in the process
overview and in the process detail page. </item> <item> A
summary of blocks- and carriers sizes is added to the
allocator information page in the crashdump viewer.
- </item> </list></p>
+ </item> </list>
<p>
Own Id: OTP-10604 Aux Id: kunagi-336 [247] </p>
</item>
@@ -408,7 +407,6 @@
<item>
<p>
The following bugs in <c>ttb</c> have been corrected:</p>
- <p>
<list> <item><c>ttb:tracer/2</c> would earlier crash when
trying to set up tracing for a diskless node to wrap
files, i.e. when option
@@ -421,7 +419,7 @@
<c>{file,{local,Filename}}</c></item> <item>A deadlock
would sometimes occur due to an information printout from
the <c>ttb_control</c> process when <c>ttb</c> was
- stopped.</item> </list></p>
+ stopped.</item> </list>
<p>
Own Id: OTP-9431</p>
</item>
@@ -449,7 +447,6 @@
<item>
<p>
The following new features are added to <c>ttb</c>:</p>
- <p>
<list> <item>A one-command trace setup is added,
<c>ttb:start_trace/4</c>.</item> <item>The following new
options are added to <c>ttb:tracer/2</c>: <list>
@@ -485,7 +482,7 @@
<c>disable_sort</c> is added to <c>ttb:format/2</c>. When
this option is used, trace messages from different logs
are not merged according to timestamps, but just appended
- one log after the other. </item> </list></p>
+ one log after the other. </item> </list>
<p>
Own Id: OTP-9403</p>
</item>
@@ -493,7 +490,6 @@
<p>
The following non backwards compatible changes are done
in <c>ttb</c>:</p>
- <p>
<list> <item> When setting up trace with ttb, the
'timestamp' trace flag will now always be set. </item>
<item> The 'fetch' option to ttb:stop/1 is removed since
@@ -509,7 +505,7 @@
trace file, this is now changed so the handler state is
passed not only from one trace message to the next in the
same file, but also from one file to the next. </item>
- </list></p>
+ </list>
<p>
*** POTENTIAL INCOMPATIBILITY ***</p>
<p>
diff --git a/lib/observer/doc/src/observer_ug.xml b/lib/observer/doc/src/observer_ug.xml
index 8388cb6736..ff30d70913 100644
--- a/lib/observer/doc/src/observer_ug.xml
+++ b/lib/observer/doc/src/observer_ug.xml
@@ -105,7 +105,7 @@
<note>
<p><em>Reds</em> can be presented as accumulated values or as values since last update.</p>
</note>
- <p><c>Process info</c> open a detailed information window on the selected process.
+ <p><c>Process info</c> open a detailed information window on the selected process.</p>
<taglist>
<tag>Process Information</tag>
<item>Shows the process information.</item>
@@ -127,7 +127,6 @@
<c>rb</c> server will be stopped on the observed node when exiting or changing observed node.
</p>
</note>
- </p>
<p><c>Trace Processes</c> will add the selected process identifiers to the <c>Trace Overview</c> view and the
node the processes reside on will be added as well.
<c>Trace Named Processes</c> will add the registered name of processes. This can be useful
diff --git a/lib/observer/doc/src/ttb.xml b/lib/observer/doc/src/ttb.xml
index 0b064b51b8..0a50a20716 100644
--- a/lib/observer/doc/src/ttb.xml
+++ b/lib/observer/doc/src/ttb.xml
@@ -25,8 +25,7 @@
</legalnotice>
<title>ttb</title>
- <prepared>Siri hansen</prepared>
- <prepared>Bartlomiej Puzon</prepared>
+ <prepared>Siri hansen, Bartlomiej Puzon</prepared>
<responsible></responsible>
<docno>1</docno>
<approved></approved>
@@ -60,17 +59,16 @@
<p>This function is a shortcut allowing to start a trace with one command. Each
tuple in <c>Patterns</c> is converted to list which is in turn passed to
<c>ttb:tpl</c>.
- The call:<code type="none">
+ The call:</p><code type="none">
ttb:start_trace([Node, OtherNode],
[{mod, foo, []}, {mod, bar, 2}],
{all, call},
[{file, File}, {handler,{fun myhandler/4, S}}])</code>
- is equivalent to <code type="none">
+ <p>is equivalent to</p> <code type="none">
ttb:start_trace([Node, OtherNode], [{file, File}, {handler,{fun myhandler/4, S}}]),
ttb:tpl(mod, foo, []),
ttb:tpl(mod, bar, 2, []),
ttb:p(all, call)</code>
- </p>
</desc>
</func>
<func>
@@ -193,7 +191,7 @@ ttb:p(all, call)</code>
(i.e. on diskless nodes), a custom module to handle autostart
information storage and retrieval can be provided by specifying
<c>ttb_autostart_module</c> environment variable for the <c>runtime_tools</c>
- application. The module has to respond to the following API:
+ application. The module has to respond to the following API:</p>
<taglist>
<tag><c>write_config(Data) -> ok</c></tag>
<item>Store the provided data for further retrieval. It is
@@ -207,7 +205,6 @@ ttb:p(all, call)</code>
must return <c>{error, Error}</c>.
</item>
</taglist>
- </p>
<p>The <c>resume</c> option implies the default <c>FetchTimeout</c>, which is
10 seconds</p>
</desc>
@@ -272,17 +269,19 @@ ttb:p(all, call)</code>
<item>Clear trace pattern on global function calls</item>
</taglist>
<p>With <c>tp</c> and <c>tpl</c> one of match specification shortcuts
- may be used (example: <c>ttb:tp(foo_module, caller)</c>). The shortcuts are:
+ may be used (example: <c>ttb:tp(foo_module, caller)</c>). The shortcuts are:</p>
<taglist>
+ <tag/>
<item><c>return</c> - for <c>[{'_',[],[{return_trace}]}]</c>
(report the return value)</item>
+ <tag/>
<item><c>caller</c> - for <c>[{'_',[],[{message,{caller}}]}]</c>
(report the calling function)</item>
+ <tag/>
<item><c>{codestr, Str}</c> - for <c>dbg:fun2ms/1</c> arguments
passed as strings (example: <c>"fun(_) -> return_trace() end"</c>)
</item>
</taglist>
- </p>
</desc>
</func>
<func>
diff --git a/lib/observer/doc/src/ttb_ug.xml b/lib/observer/doc/src/ttb_ug.xml
index ba8c997133..e2a28d67d0 100644
--- a/lib/observer/doc/src/ttb_ug.xml
+++ b/lib/observer/doc/src/ttb_ug.xml
@@ -320,7 +320,7 @@ do_print(Out,{trace_ts,P,return_from,{M,F,A},R,Ts},N) ->
</code>
</section>
<section>
- <label>Overload protection</label>
+ <title>Overload protection</title>
<p>When tracing live systems, special care needs to be always taken
not to overload a node with too heavy tracing. <c>ttb</c> provides
the <c>overload</c> option to help to address the problem.</p>
@@ -747,7 +747,7 @@ f3() ->
of the <c>ttb</c> for setting trace flags on processes and trace
patterns for call trace, i.e. the functions <c>p</c>, <c>tp</c>,
<c>tpl</c>, <c>ctp</c>, <c>ctpl</c> and <c>ctpg</c>. There are only
- two things added by <c>ttb</c> for these functions:
+ two things added by <c>ttb</c> for these functions:</p>
<list type="bulleted">
<item>all calls are stored in the history buffer and can be
recalled and stored in a configuration file. This makes it
@@ -756,9 +756,8 @@ f3() ->
typing when using <c>ttb</c> from the erlang shell;</item>
<item>shortcuts are provided for the most common match
specifications (in order not to force the user to use
- <c>dbg:fun2ms</c> continually</item>).
+ <c>dbg:fun2ms</c> continually).</item>
</list>
- </p>
<p>Use <c>list_history/0</c> to see the content of the history
buffer, and <c>run_history/1</c> to re-execute one of the entries.
</p>