diff options
author | Gustav Simonsson <[email protected]> | 2012-03-16 10:34:17 +0100 |
---|---|---|
committer | Gustav Simonsson <[email protected]> | 2012-03-16 10:34:17 +0100 |
commit | dbc73d9b5421437f6fac029c06013996de478521 (patch) | |
tree | 0b94819bece6d255bf107573ca47f85f6c3cc64c /lib/observer | |
parent | e5cc75f496d41589003548c16d199f0b37a919dc (diff) | |
parent | b65ab3aeaea983e3766d0398638eee8c068615d8 (diff) | |
download | otp-dbc73d9b5421437f6fac029c06013996de478521.tar.gz otp-dbc73d9b5421437f6fac029c06013996de478521.tar.bz2 otp-dbc73d9b5421437f6fac029c06013996de478521.zip |
Merge branch 'rj/minor-doc-improvements' into maint
* rj/minor-doc-improvements:
Remove dashes from error_logger doc
Add start/0,1 and help/0 to etop's doc
Remove/add extra/missing white spaces
Diffstat (limited to 'lib/observer')
-rw-r--r-- | lib/observer/doc/src/etop.xml | 31 | ||||
-rw-r--r-- | lib/observer/src/etop.erl | 6 |
2 files changed, 34 insertions, 3 deletions
diff --git a/lib/observer/doc/src/etop.xml b/lib/observer/doc/src/etop.xml index 78047caab3..4eb5603549 100644 --- a/lib/observer/doc/src/etop.xml +++ b/lib/observer/doc/src/etop.xml @@ -114,6 +114,37 @@ Default: <c>on</c></item> </description> <funcs> <func> + <name>start() -> ok</name> + <fsummary>Start etop</fsummary> + <desc> + <p>This function starts <c>etop</c>. + Note that etop is preferably started with the etop and getop scripts</p> + </desc> + </func> + <func> + <name>start(Options) -> ok</name> + <fsummary>Start etop</fsummary> + <type> + <v>Options = [Option]</v> + <v>Option = {Key, Value}</v> + <v>Key = atom()</v> + <v>Value = term()</v> + </type> + <desc> + <p>This function starts <c>etop</c>. Use + <seealso marker="#help/0">help/0</seealso> to see a + description of the possible options.</p> + </desc> + </func> + <func> + <name>help() -> ok</name> + <fsummary>Print etop's help</fsummary> + <desc> + <p>This function prints the help of <c>etop</c> and + its options.</p> + </desc> + </func> + <func> <name>config(Key,Value) -> Result</name> <fsummary>Change tool's configuration</fsummary> <type> diff --git a/lib/observer/src/etop.erl b/lib/observer/src/etop.erl index 0bf1d68534..7ec0fedbb2 100644 --- a/lib/observer/src/etop.erl +++ b/lib/observer/src/etop.erl @@ -31,9 +31,9 @@ help() -> io:format( - "Usage of the erlang top program~n" - "Options are set as command line parameters as in -node a@host -..~n" - "or as parameter to etop:start([{node, a@host}, {...}])~n" + "Usage of the Erlang top program~n~n" + "Options are set as command line parameters as in -node my@host~n" + "or as parameters to etop:start([{node, my@host}, {...}]).~n~n" "Options are:~n" " node atom Required The erlang node to measure ~n" " port integer The used port, NOTE: due to a bug this program~n" |