From 20cc39d443d1a2c364b0fb778c7813ae7b5a1dd6 Mon Sep 17 00:00:00 2001 From: Sverker Eriksson Date: Tue, 11 Dec 2018 17:42:39 +0100 Subject: Add "since" attributes in xml for new functions and modules introduced after OTP_R13B03. --- lib/tools/doc/src/cover.xml | 14 ++++----- lib/tools/doc/src/eprof.xml | 16 +++++----- lib/tools/doc/src/instrument.xml | 8 ++--- lib/tools/doc/src/lcnt.xml | 68 ++++++++++++++++++++-------------------- 4 files changed, 53 insertions(+), 53 deletions(-) (limited to 'lib/tools') diff --git a/lib/tools/doc/src/cover.xml b/lib/tools/doc/src/cover.xml index 15cd784253..ac49be4652 100644 --- a/lib/tools/doc/src/cover.xml +++ b/lib/tools/doc/src/cover.xml @@ -260,7 +260,7 @@ - analyse() -> {result,Ok,Fail} | {error,not_main_node} + analyse() -> {result,Ok,Fail} | {error,not_main_node} analyse(Modules) -> OneResult | {result,Ok,Fail} | {error,not_main_node} analyse(Analysis) -> {result,Ok,Fail} | {error,not_main_node} analyse(Level) -> {result,Ok,Fail} | {error,not_main_node} @@ -305,7 +305,7 @@ - analyse_to_file() -> {result,Ok,Fail} | {error,not_main_node} + analyse_to_file() -> {result,Ok,Fail} | {error,not_main_node} analyse_to_file(Modules) -> Answer | {result,Ok,Fail} | {error,not_main_node} analyse_to_file(Options) -> {result,Ok,Fail} | {error,not_main_node} analyse_to_file(Modules,Options) -> Answer | {result,Ok,Fail} | {error,not_main_node} @@ -359,10 +359,10 @@ - async_analyse_to_file(Module) -> - async_analyse_to_file(Module,Options) -> - async_analyse_to_file(Module, OutFile) -> - async_analyse_to_file(Module, OutFile, Options) -> pid() + async_analyse_to_file(Module) -> + async_analyse_to_file(Module,Options) -> + async_analyse_to_file(Module, OutFile) -> + async_analyse_to_file(Module, OutFile, Options) -> pid() Asynchronous call to analyse_to_file. Module = atom() @@ -523,7 +523,7 @@ - flush(Nodes) -> ok | {error,not_main_node} + flush(Nodes) -> ok | {error,not_main_node} Collect cover data from remote nodes. Nodes = [atom()] diff --git a/lib/tools/doc/src/eprof.xml b/lib/tools/doc/src/eprof.xml index f098b7d39e..158f61d9e9 100644 --- a/lib/tools/doc/src/eprof.xml +++ b/lib/tools/doc/src/eprof.xml @@ -52,8 +52,8 @@ start_profiling(Rootset) -> profiling | {error, Reason} - start_profiling(Rootset,Pattern) -> profiling | {error, Reason} - start_profiling(Rootset,Pattern,Options) -> profiling | {error, Reason} + start_profiling(Rootset,Pattern) -> profiling | {error, Reason} + start_profiling(Rootset,Pattern,Options) -> profiling | {error, Reason} Start profiling. Rootset = [atom() | pid()] @@ -91,10 +91,10 @@ profile(Fun, Options) -> profiling | {error, Reason} profile(Rootset) -> profiling | {error, Reason} profile(Rootset,Fun) -> {ok, Value} | {error,Reason} - profile(Rootset,Fun,Pattern) -> {ok, Value} | {error, Reason} + profile(Rootset,Fun,Pattern) -> {ok, Value} | {error, Reason} profile(Rootset,Module,Function,Args) -> {ok, Value} | {error, Reason} - profile(Rootset,Module,Function,Args,Pattern) -> {ok, Value} | {error, Reason} - profile(Rootset,Module,Function,Args,Pattern,Options) -> {ok, Value} | {error, Reason} + profile(Rootset,Module,Function,Args,Pattern) -> {ok, Value} | {error, Reason} + profile(Rootset,Module,Function,Args,Pattern,Options) -> {ok, Value} | {error, Reason} Start profiling. Rootset = [atom() | pid()] @@ -128,9 +128,9 @@ - analyze() -> ok - analyze(Type) -> ok - analyze(Type,Options) -> ok + analyze() -> ok + analyze(Type) -> ok + analyze(Type,Options) -> ok Display profiling results per process. Type = procs | total diff --git a/lib/tools/doc/src/instrument.xml b/lib/tools/doc/src/instrument.xml index 9fd9332373..bc1276bdd5 100644 --- a/lib/tools/doc/src/instrument.xml +++ b/lib/tools/doc/src/instrument.xml @@ -92,7 +92,7 @@ - + Return a summary of all allocations in the system.

Shorthand for @@ -101,7 +101,7 @@ - + Return a summary of all allocations filtered by allocator type and scheduler id. @@ -170,7 +170,7 @@ - + Return a list of all carriers in the system.

Shorthand for @@ -179,7 +179,7 @@ - + Return a list of all carriers filtered by allocator type and scheduler id. diff --git a/lib/tools/doc/src/lcnt.xml b/lib/tools/doc/src/lcnt.xml index d2595cdb60..1d434decfc 100644 --- a/lib/tools/doc/src/lcnt.xml +++ b/lib/tools/doc/src/lcnt.xml @@ -34,7 +34,7 @@ PA1 lcnt.xml - lcnt + lcnt A runtime system Lock Profiling tool.

The lcnt module is used to profile the internal ethread locks in the @@ -71,7 +71,7 @@ - start() -> {ok, Pid} | {error, {already_started, Pid}} + start() -> {ok, Pid} | {error, {already_started, Pid}} Starts the lock profiler server. Pid = pid() @@ -84,7 +84,7 @@ - stop() -> ok + stop() -> ok Stops the lock profiler server.

Stops the lock profiler server.

@@ -92,13 +92,13 @@ - collect() -> ok + collect() -> ok Same as collect(node()).

Same as collect(node()).

 - collect(Node) -> ok + collect(Node) -> ok Collects lock statistics from the runtime system. Node = node() @@ -113,13 +113,13 @@ - clear() -> ok + clear() -> ok Same as clear(node()).

Same as clear(node()).

 - clear(Node) -> ok + clear(Node) -> ok Clears the internal lock statistics from runtime system. Node = node() @@ -133,12 +133,12 @@ - conflicts() -> ok + conflicts() -> ok Same as conflicts([]).

Same as conflicts([]).

 - conflicts([Option]) -> ok + conflicts([Option]) -> ok Prints a list of internal lock counters. Option = {sort, Sort} | {reverse, bool()} | {thresholds, [Thresholds]} | {print, [Print | {Print, integer()}]} | {max_locks, MaxLocks} | {combine, bool()} @@ -154,14 +154,14 @@ - locations() -> ok + locations() -> ok Same as locations([]).

Same as locations([]).

 - locations([Option]) -> ok + locations([Option]) -> ok Prints a list of internal lock counters by source code locations. Option = {sort, Sort} | {thresholds, [Thresholds]} | {print, [Print | {Print, integer()}]} | {max_locks, MaxLocks} | {combine, bool()} @@ -177,12 +177,12 @@ - inspect(Lock) -> ok + inspect(Lock) -> ok Same as inspect(Lock, []).

Same as inspect(Lock, []).

 - inspect(Lock, [Option]) -> ok + inspect(Lock, [Option]) -> ok Prints a list of internal lock counters for a specific lock. Lock = Name | {Name, Id | [Id]} @@ -268,7 +268,7 @@ - information() -> ok + information() -> ok Prints lcnt server state and generic information about collected lock statistics.

Prints lcnt server state and generic information about collected lock statistics.

@@ -276,7 +276,7 @@ - swap_pid_keys() -> ok + swap_pid_keys() -> ok Swaps places on Name and Id space for ports and processes.

Swaps places on Name and Id space for ports and processes.

@@ -284,7 +284,7 @@ - load(Filename) -> ok + load(Filename) -> ok Restores previously saved data to the server. Filename = filename() @@ -295,7 +295,7 @@ - save(Filename) -> ok + save(Filename) -> ok Saves the collected data to file. Filename = filename() @@ -312,7 +312,7 @@ - apply(Fun) -> term() + apply(Fun) -> term() Same as apply(Fun, []). Fun = fun() @@ -322,7 +322,7 @@ - apply(Fun, Args) -> term() + apply(Fun, Args) -> term() Same as apply(Module, Function, Args). Fun = fun() @@ -333,7 +333,7 @@ - apply(Module, Function, Args) -> term() + apply(Module, Function, Args) -> term() Clears counters, applies function and collects the profiling results. Module = atom() @@ -358,12 +358,12 @@ - pid(Id, Serial) -> pid() + pid(Id, Serial) -> pid() Same as pid(node(), Id, Serial).

Same as pid(node(), Id, Serial).

 - pid(Node, Id, Serial) -> pid() + pid(Node, Id, Serial) -> pid() Creates a process id with creation 0. Node = node() @@ -376,12 +376,12 @@ - port(Id) -> port() + port(Id) -> port() Same as port(node(), Id).

Same as port(node(), Id).

 - port(Node, Id) -> port() + port(Node, Id) -> port() Creates a port id with creation 0. Node = node() @@ -399,12 +399,12 @@ - rt_collect() -> [lock_counter_data()] + rt_collect() -> [lock_counter_data()] Same as rt_collect(node()).

Same as rt_collect(node()).

 - rt_collect(Node) -> [lock_counter_data()] + rt_collect(Node) -> [lock_counter_data()] Returns a list of raw lock counter data. Node = node() @@ -413,12 +413,12 @@ - rt_clear() -> ok + rt_clear() -> ok Same as rt_clear(node()).

Same as rt_clear(node()).

 - rt_clear(Node) -> ok + rt_clear(Node) -> ok Clears the internal counters. Node = node() @@ -427,13 +427,13 @@ - rt_mask() -> [category_atom()] + rt_mask() -> [category_atom()] Same as rt_mask(node()).

Same as rt_mask(node()).

 - rt_mask(Node) -> [category_atom()] + rt_mask(Node) -> [category_atom()] Returns the current lock category mask. Node = node() @@ -447,7 +447,7 @@ - rt_mask(Categories) -> ok | {error, copy_save_enabled} + rt_mask(Categories) -> ok | {error, copy_save_enabled} Same as rt_mask(node(), Categories). Categories = [atom()] @@ -456,7 +456,7 @@ - rt_mask(Node, Categories) -> ok | {error, copy_save_enabled} + rt_mask(Node, Categories) -> ok | {error, copy_save_enabled} Changes the lock category mask. Node = node() @@ -489,12 +489,12 @@ - rt_opt({Type, bool()}) -> bool() + rt_opt({Type, bool()}) -> bool() Same as rt_opt(node(), {Type, Opt}).

Same as rt_opt(node(), {Type, Opt}).

 - rt_opt(Node, {Type, bool()}) -> bool() + rt_opt(Node, {Type, bool()}) -> bool() Changes the lock counter behavior and returns the previous behaviour. Node = node() -- cgit v1.2.3