From 3e0e79218065458b816cd726bd637f1ecd00a882 Mon Sep 17 00:00:00 2001 From: Hans Bolinder Date: Tue, 13 Oct 2015 14:02:48 +0200 Subject: [observer] Correct documentation Fix mistakes found by 'xmllint'. --- lib/observer/doc/src/crashdump_ug.xml | 2 -- lib/observer/doc/src/notes.xml | 12 ++++-------- lib/observer/doc/src/observer_ug.xml | 3 +-- lib/observer/doc/src/ttb.xml | 17 ++++++++--------- lib/observer/doc/src/ttb_ug.xml | 7 +++---- 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 @@

The Memory panel shows memory and allocator information. From the left hand menu you can select:

-

Memory More... -

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 @@
Improvements and New Features -

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. A summary of blocks- and carriers sizes is added to the allocator information page in the crashdump viewer. -

+

Own Id: OTP-10604 Aux Id: kunagi-336 [247]

@@ -408,7 +407,6 @@

The following bugs in ttb have been corrected:

-

ttb:tracer/2 would earlier crash when trying to set up tracing for a diskless node to wrap files, i.e. when option @@ -421,7 +419,7 @@ {file,{local,Filename}} A deadlock would sometimes occur due to an information printout from the ttb_control process when ttb was - stopped.

+ stopped.

Own Id: OTP-9431

@@ -449,7 +447,6 @@

The following new features are added to ttb:

-

A one-command trace setup is added, ttb:start_trace/4. The following new options are added to ttb:tracer/2: @@ -485,7 +482,7 @@ disable_sort is added to ttb:format/2. When this option is used, trace messages from different logs are not merged according to timestamps, but just appended - one log after the other.

+ one log after the other.

Own Id: OTP-9403

@@ -493,7 +490,6 @@

The following non backwards compatible changes are done in ttb:

-

When setting up trace with ttb, the 'timestamp' trace flag will now always be set. 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. -

+

*** POTENTIAL INCOMPATIBILITY ***

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 @@

Reds can be presented as accumulated values or as values since last update.

-

Process info open a detailed information window on the selected process. +

Process info open a detailed information window on the selected process.

Process Information Shows the process information. @@ -127,7 +127,6 @@ rb server will be stopped on the observed node when exiting or changing observed node.

-

Trace Processes will add the selected process identifiers to the Trace Overview view and the node the processes reside on will be added as well. Trace Named Processes 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 @@ ttb - Siri hansen - Bartlomiej Puzon + Siri hansen, Bartlomiej Puzon 1 @@ -60,17 +59,16 @@

This function is a shortcut allowing to start a trace with one command. Each tuple in Patterns is converted to list which is in turn passed to ttb:tpl. - The call: + The call:

ttb:start_trace([Node, OtherNode], [{mod, foo, []}, {mod, bar, 2}], {all, call}, [{file, File}, {handler,{fun myhandler/4, S}}]) - is equivalent to +

is equivalent to

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) -

@@ -193,7 +191,7 @@ ttb:p(all, call) (i.e. on diskless nodes), a custom module to handle autostart information storage and retrieval can be provided by specifying ttb_autostart_module environment variable for the runtime_tools - application. The module has to respond to the following API: + application. The module has to respond to the following API:

write_config(Data) -> ok Store the provided data for further retrieval. It is @@ -207,7 +205,6 @@ ttb:p(all, call) must return {error, Error}. -

The resume option implies the default FetchTimeout, which is 10 seconds

@@ -272,17 +269,19 @@ ttb:p(all, call) Clear trace pattern on global function calls

With tp and tpl one of match specification shortcuts - may be used (example: ttb:tp(foo_module, caller)). The shortcuts are: + may be used (example: ttb:tp(foo_module, caller)). The shortcuts are:

+ return - for [{'_',[],[{return_trace}]}] (report the return value) + caller - for [{'_',[],[{message,{caller}}]}] (report the calling function) + {codestr, Str} - for dbg:fun2ms/1 arguments passed as strings (example: "fun(_) -> return_trace() end") -

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) ->
- + Overload protection

When tracing live systems, special care needs to be always taken not to overload a node with too heavy tracing. ttb provides the overload option to help to address the problem.

@@ -747,7 +747,7 @@ f3() -> of the ttb for setting trace flags on processes and trace patterns for call trace, i.e. the functions p, tp, tpl, ctp, ctpl and ctpg. There are only - two things added by ttb for these functions: + two things added by ttb for these functions:

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 ttb from the erlang shell; shortcuts are provided for the most common match specifications (in order not to force the user to use - dbg:fun2ms continually). + dbg:fun2ms continually). -

Use list_history/0 to see the content of the history buffer, and run_history/1 to re-execute one of the entries.

-- cgit v1.2.1