From 50f64c60b87e8d03fedc3f9f4e655aff8ca9f16c Mon Sep 17 00:00:00 2001 From: Sverker Eriksson Date: Wed, 12 Dec 2018 19:32:24 +0100 Subject: Add empty 'since' attribute for old modules and functions --- lib/runtime_tools/doc/src/dbg.xml | 110 ++++++++++++------------ lib/runtime_tools/doc/src/erts_alloc_config.xml | 10 +-- 2 files changed, 60 insertions(+), 60 deletions(-) (limited to 'lib/runtime_tools/doc') diff --git a/lib/runtime_tools/doc/src/dbg.xml b/lib/runtime_tools/doc/src/dbg.xml index 06701ed5b4..941a880778 100644 --- a/lib/runtime_tools/doc/src/dbg.xml +++ b/lib/runtime_tools/doc/src/dbg.xml @@ -32,7 +32,7 @@ A dbg.sgml - dbg + dbg The Text Based Trace Facility

This module implements a text based interface to the @@ -68,7 +68,7 @@ - fun2ms(LiteralFun) -> MatchSpec + fun2ms(LiteralFun) -> MatchSpec Pseudo function that transforms fun syntax to match_spec. LiteralFun = fun() literal @@ -145,14 +145,14 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - h() -> ok + h() -> ok Give a list of available help items on standard output.

Gives a list of items for brief online help.

- h(Item) -> ok + h(Item) -> ok Give brief help for an item. Item = atom() @@ -163,14 +163,14 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - p(Item) -> {ok, MatchDesc} | {error, term()} + p(Item) -> {ok, MatchDesc} | {error, term()} Trace messages to and from Item.

Equivalent to p(Item, [m]).

- p(Item, Flags) -> {ok, MatchDesc} | {error, term()} + p(Item, Flags) -> {ok, MatchDesc} | {error, term()} Trace Item according to Flags. MatchDesc = [MatchNum] @@ -303,14 +303,14 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - c(Mod, Fun, Args) + c(Mod, Fun, Args) Evaluate apply(M,F,Args)with alltrace flags set.

Equivalent to c(Mod, Fun, Args, all).

- c(Mod, Fun, Args, Flags) + c(Mod, Fun, Args, Flags) Evaluate apply(M,F,Args)with Flagstrace flags set.

Evaluates the expression apply(Mod, Fun, Args) with the trace @@ -319,35 +319,35 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - i() -> ok + i() -> ok Display information about all traced processes and ports.

Displays information about all traced processes and ports.

- tp(Module,MatchSpec) + tp(Module,MatchSpec) Set pattern for traced global function calls

Same as tp({Module, '_', '_'}, MatchSpec)

- tp(Module,Function,MatchSpec) + tp(Module,Function,MatchSpec) Set pattern for traced global function calls

Same as tp({Module, Function, '_'}, MatchSpec)

- tp(Module, Function, Arity, MatchSpec) + tp(Module, Function, Arity, MatchSpec) Set pattern for traced global function calls

Same as tp({Module, Function, Arity}, MatchSpec)

- tp({Module, Function, Arity}, MatchSpec) -> {ok, MatchDesc} | {error, term()} + tp({Module, Function, Arity}, MatchSpec) -> {ok, MatchDesc} | {error, term()} Set pattern for traced global function calls Module = atom() | '_' @@ -410,28 +410,28 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - tpl(Module,MatchSpec) + tpl(Module,MatchSpec) Set pattern for traced local (as well as global) function calls

Same as tpl({Module, '_', '_'}, MatchSpec)

- tpl(Module,Function,MatchSpec) + tpl(Module,Function,MatchSpec) Set pattern for traced local (as well as global) function calls

Same as tpl({Module, Function, '_'}, MatchSpec)

- tpl(Module, Function, Arity, MatchSpec) + tpl(Module, Function, Arity, MatchSpec) Set pattern for traced local (as well as global) function calls

Same as tpl({Module, Function, Arity}, MatchSpec)

- tpl({Module, Function, Arity}, MatchSpec) -> {ok, MatchDesc} | {error, term()} + tpl({Module, Function, Arity}, MatchSpec) -> {ok, MatchDesc} | {error, term()} Set pattern for traced local (as well as global) function calls

This function works as tp/2, but enables @@ -484,35 +484,35 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - ctp() + ctp() Clear call trace pattern for the specified functions

Same as ctp({'_', '_', '_'})

- ctp(Module) + ctp(Module) Clear call trace pattern for the specified functions

Same as ctp({Module, '_', '_'})

- ctp(Module, Function) + ctp(Module, Function) Clear call trace pattern for the specified functions

Same as ctp({Module, Function, '_'})

- ctp(Module, Function, Arity) + ctp(Module, Function, Arity) Clear call trace pattern for the specified functions

Same as ctp({Module, Function, Arity})

- ctp({Module, Function, Arity}) -> {ok, MatchDesc} | {error, term()} + ctp({Module, Function, Arity}) -> {ok, MatchDesc} | {error, term()} Clear call trace pattern for the specified functions Module = atom() | '_' @@ -533,35 +533,35 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - ctpl() + ctpl() Clear call trace pattern for the specified functions

Same as ctpl({'_', '_', '_'})

- ctpl(Module) + ctpl(Module) Clear call trace pattern for the specified functions

Same as ctpl({Module, '_', '_'})

- ctpl(Module, Function) + ctpl(Module, Function) Clear call trace pattern for the specified functions

Same as ctpl({Module, Function, '_'})

- ctpl(Module, Function, Arity) + ctpl(Module, Function, Arity) Clear call trace pattern for the specified functions

Same as ctpl({Module, Function, Arity})

- ctpl({Module, Function, Arity}) -> {ok, MatchDesc} | {error, term()} + ctpl({Module, Function, Arity}) -> {ok, MatchDesc} | {error, term()} Clear call trace pattern for the specified functions

This function works as ctp/1, but only disables @@ -570,35 +570,35 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - ctpg() + ctpg() Clear call trace pattern for the specified functions

Same as ctpg({'_', '_', '_'})

- ctpg(Module) + ctpg(Module) Clear call trace pattern for the specified functions

Same as ctpg({Module, '_', '_'})

- ctpg(Module, Function) + ctpg(Module, Function) >Clear call trace pattern for the specified functions

Same as ctpg({Module, Function, '_'})

- ctpg(Module, Function, Arity) + ctpg(Module, Function, Arity) >Clear call trace pattern for the specified functions

Same as ctpg({Module, Function, Arity})

- ctpg({Module, Function, Arity}) -> {ok, MatchDesc} | {error, term()} + ctpg({Module, Function, Arity}) -> {ok, MatchDesc} | {error, term()} Clear call trace pattern for the specified functions

This function works as ctp/1, but only disables @@ -623,7 +623,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - ltp() -> ok + ltp() -> ok List saved and built-in match specifications on the console.

Use this function to recall all match specifications previously @@ -654,7 +654,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - dtp() -> ok + dtp() -> ok Delete all saved match specifications.

Use this function to "forget" all match specifications @@ -665,7 +665,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - dtp(N) -> ok + dtp(N) -> ok Delete a specific saved match_spec. N = integer() @@ -676,7 +676,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - wtp(Name) -> ok | {error, IOError} + wtp(Name) -> ok | {error, IOError} Write all saved and built-in match specifications to a file Name = string() @@ -699,7 +699,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - rtp(Name) -> ok | {error, Error} + rtp(Name) -> ok | {error, Error} Read saved match specifications from file. Name = string() @@ -728,7 +728,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - n(Nodename) -> {ok, Nodename} | {error, Reason} + n(Nodename) -> {ok, Nodename} | {error, Reason} Add a remote node to the list of traced nodes Nodename = atom() @@ -767,7 +767,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - cn(Nodename) -> ok + cn(Nodename) -> ok Clear a node from the list of traced nodes. Nodename = atom() @@ -782,14 +782,14 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - ln() -> ok + ln() -> ok Show the list of traced nodes on the console.

Shows the list of traced nodes on the console.

- tracer() -> {ok, pid()} | {error, already_started} + tracer() -> {ok, pid()} | {error, already_started} Start a tracer server that handles trace messages.

This function starts a server on the local node that will @@ -805,7 +805,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - tracer(Type, Data) -> {ok, pid()} | {error, Error} + tracer(Type, Data) -> {ok, pid()} | {error, Error} Start a tracer server with additional parameters Type = port | process | module @@ -859,7 +859,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - tracer(Nodename, Type, Data) -> {ok, Nodename} | {error, Reason} + tracer(Nodename, Type, Data) -> {ok, Nodename} | {error, Reason} Start a tracer server on given node with additional parameters Nodename = atom() @@ -881,7 +881,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - trace_port(Type, Parameters) -> fun() + trace_port(Type, Parameters) -> fun() Create and returns a trace port generatingfun Type = ip | file @@ -958,28 +958,28 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - flush_trace_port() + flush_trace_port() Equivalent to flush_trace_port(node()).

Equivalent to flush_trace_port(node()).

- flush_trace_port(Nodename) -> ok | {error, Reason} + flush_trace_port(Nodename) -> ok | {error, Reason} Flush internal data buffers in a trace driver on the given node.

Equivalent to trace_port_control(Nodename,flush).

- trace_port_control(Operation) + trace_port_control(Operation) Equivalent to trace_port_control(node(),Operation).

Equivalent to trace_port_control(node(),Operation).

- trace_port_control(Nodename,Operation) -> ok | {ok, Result} | {error, Reason} + trace_port_control(Nodename,Operation) -> ok | {ok, Result} | {error, Reason} Perform a control operation on the active trace port driver on the given node. Nodename = atom() @@ -1013,7 +1013,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - trace_client(Type, Parameters) -> pid() + trace_client(Type, Parameters) -> pid() Start a trace client that reads messages created by a trace port driver Type = ip | file | follow_file @@ -1080,7 +1080,7 @@ hello - trace_client(Type, Parameters, HandlerSpec) -> pid() + trace_client(Type, Parameters, HandlerSpec) -> pid() Start a trace client that reads messages created by a trace port driver, with a user defined handler Type = ip | file | follow_file @@ -1110,7 +1110,7 @@ hello - stop_trace_client(Pid) -> ok + stop_trace_client(Pid) -> ok Stop a trace client gracefully. Pid = pid() @@ -1123,14 +1123,14 @@ hello - get_tracer() + get_tracer() Equivalent to get_tracer(node()).

Equivalent to get_tracer(node()).

- get_tracer(Nodename) -> {ok, Tracer} + get_tracer(Nodename) -> {ok, Tracer} Return the process or port to which all trace messages are sent. Nodename = atom() @@ -1142,7 +1142,7 @@ hello - stop() -> ok + stop() -> ok Stop the dbgserver and the tracing of all processes.

Stops the dbg server and clears all trace flags for @@ -1153,7 +1153,7 @@ hello - stop_clear() -> ok + stop_clear() -> ok Stop the dbgserver and the tracing of all processes, and clears trace patterns.

Same as stop/0, but also clears all trace patterns on global functions calls.

diff --git a/lib/runtime_tools/doc/src/erts_alloc_config.xml b/lib/runtime_tools/doc/src/erts_alloc_config.xml index ffc4ec5285..5bcce1b5e3 100644 --- a/lib/runtime_tools/doc/src/erts_alloc_config.xml +++ b/lib/runtime_tools/doc/src/erts_alloc_config.xml @@ -29,7 +29,7 @@ 1 erts_alloc_config.sgml - erts_alloc_config + erts_alloc_config Configuration tool for erts_alloc @@ -136,7 +136,7 @@ - save_scenario() -> ok | {error, Error} + save_scenario() -> ok | {error, Error} Saves information about current runtime scenario Error = term() @@ -154,7 +154,7 @@
- make_config() -> ok | {error, Error} + make_config() -> ok | {error, Error} Creates an erts_alloc configuration Error = term() @@ -165,7 +165,7 @@ - make_config(FileNameOrIODev) -> ok | {error, Error} + make_config(FileNameOrIODev) -> ok | {error, Error} Creates an erts_alloc configuration FileNameOrIODev = string() | io_device() @@ -190,7 +190,7 @@ - stop() -> ok | {error, Error} + stop() -> ok | {error, Error} Error = term() -- cgit v1.2.3