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/et/doc/src/et.xml | 10 ++++----- lib/et/doc/src/et_collector.xml | 46 ++++++++++++++++++++--------------------- lib/et/doc/src/et_selector.xml | 8 +++---- lib/et/doc/src/et_viewer.xml | 14 ++++++------- 4 files changed, 39 insertions(+), 39 deletions(-) (limited to 'lib/et') diff --git a/lib/et/doc/src/et.xml b/lib/et/doc/src/et.xml index ec7381f633..a362d00b3e 100644 --- a/lib/et/doc/src/et.xml +++ b/lib/et/doc/src/et.xml @@ -32,7 +32,7 @@ %VSN% et - et + et Main API of the Event Trace (ET) application

Interface module for the Event Trace (ET) application

@@ -79,8 +79,8 @@ - phone_home(DetailLevel, FromTo, Label, Contents) -> hopefully_traced - phone_home(DetailLevel, From, To, Label, Contents) -> hopefully_traced + phone_home(DetailLevel, FromTo, Label, Contents) -> hopefully_traced + phone_home(DetailLevel, From, To, Label, Contents) -> hopefully_traced Send a signal to the outer space

These functions sends a signal to the outer space and the @@ -90,8 +90,8 @@ - report_event(DetailLevel, FromTo, Label, Contents) -> hopefully_traced - report_event(DetailLevel, From, To, Label, Contents) -> hopefully_traced + report_event(DetailLevel, FromTo, Label, Contents) -> hopefully_traced + report_event(DetailLevel, From, To, Label, Contents) -> hopefully_traced Deprecated functions

Deprecated functions which for the time being are kept for diff --git a/lib/et/doc/src/et_collector.xml b/lib/et/doc/src/et_collector.xml index fd90ecfc41..f908612797 100644 --- a/lib/et/doc/src/et_collector.xml +++ b/lib/et/doc/src/et_collector.xml @@ -32,14 +32,14 @@ %VSN% et_collector.xml - et_collector + et_collector Collect trace events and provide a backing storage appropriate for iteration

Interface module for the Event Trace (ET) application

 - start_link(Options) -> {ok, CollectorPid} | {error, Reason} + start_link(Options) -> {ok, CollectorPid} | {error, Reason} Start a collector process Options = [option()] @@ -105,7 +105,7 @@ - stop(CollectorPid) -> ok + stop(CollectorPid) -> ok Stop a collector process CollectorPid = pid() @@ -115,7 +115,7 @@ - save_event_file(CollectorPid, FileName, Options) -> ok | {error, Reason} + save_event_file(CollectorPid, FileName, Options) -> ok | {error, Reason} Save the events to a file CollectorPid = pid() @@ -139,7 +139,7 @@ - load_event_file(CollectorPid, FileName) -> {ok, BadBytes} | exit(Reason) + load_event_file(CollectorPid, FileName) -> {ok, BadBytes} | exit(Reason) Load the event table from a file CollectorPid = pid() @@ -152,9 +152,9 @@ - report(Handle, TraceOrEvent) -> {ok, Continuation} | exit(Reason) - report_event(Handle, DetailLevel, FromTo, Label, Contents) -> {ok, Continuation} | exit(Reason) - report_event(Handle, DetailLevel, From, To, Label, Contents) -> {ok, Continuation} | exit(Reason) + report(Handle, TraceOrEvent) -> {ok, Continuation} | exit(Reason) + report_event(Handle, DetailLevel, FromTo, Label, Contents) -> {ok, Continuation} | exit(Reason) + report_event(Handle, DetailLevel, From, To, Label, Contents) -> {ok, Continuation} | exit(Reason) Report an event to the collector Handle = Initial | Continuation @@ -181,7 +181,7 @@ - make_key(Type, Stuff) -> Key + make_key(Type, Stuff) -> Key Make a key out of an event record or an old key Type = record(table_handle) | trace_ts | event_ts @@ -193,7 +193,7 @@ - get_table_handle(CollectorPid) -> Handle + get_table_handle(CollectorPid) -> Handle Return a table handle CollectorPid = pid() @@ -204,7 +204,7 @@ - get_global_pid() -> CollectorPid | exit(Reason) + get_global_pid() -> CollectorPid | exit(Reason) Return a the identity of the globally registered collector if there is any CollectorPid = pid() @@ -216,7 +216,7 @@ - change_pattern(CollectorPid, RawPattern) -> {old_pattern, TracePattern} + change_pattern(CollectorPid, RawPattern) -> {old_pattern, TracePattern} Change active trace pattern globally on all trace nodes CollectorPid = pid() @@ -232,9 +232,9 @@ - dict_insert(CollectorPid, {filter, collector}, FilterFun) -> ok - dict_insert(CollectorPid, {subscriber, SubscriberPid}, Void) -> ok - dict_insert(CollectorPid, Key, Val) -> ok + dict_insert(CollectorPid, {filter, collector}, FilterFun) -> ok + dict_insert(CollectorPid, {subscriber, SubscriberPid}, Void) -> ok + dict_insert(CollectorPid, Key, Val) -> ok Insert a dictionary entry and send a {et, {dict_insert, Key, Val}} tuple to all registered subscribers. CollectorPid = pid() @@ -259,7 +259,7 @@ - dict_lookup(CollectorPid, Key) -> [Val] + dict_lookup(CollectorPid, Key) -> [Val] Lookup a dictionary entry and return zero or one value CollectorPid = pid() @@ -273,7 +273,7 @@ - dict_delete(CollectorPid, Key) -> ok + dict_delete(CollectorPid, Key) -> ok Delete a dictionary entry and send a {et, {dict_delete, Key}} tuple to all registered subscribers. CollectorPid = pid() @@ -290,7 +290,7 @@ - dict_match(CollectorPid, Pattern) -> [Match] + dict_match(CollectorPid, Pattern) -> [Match] Match some dictionary entries CollectorPid = pid() @@ -306,7 +306,7 @@ - multicast(_CollectorPid, Msg) -> ok + multicast(_CollectorPid, Msg) -> ok Sends a message to all registered subscribers CollectorPid = pid() @@ -318,7 +318,7 @@ - start_trace_client(CollectorPid, Type, Parameters) -> file_loaded | {trace_client_pid, pid()} | exit(Reason) + start_trace_client(CollectorPid, Type, Parameters) -> file_loaded | {trace_client_pid, pid()} | exit(Reason) Load raw Erlang trace from a file, port or process. Type = dbg_trace_client_type() @@ -330,14 +330,14 @@ - iterate(Handle, Prev, Limit) -> NewAcc + iterate(Handle, Prev, Limit) -> NewAcc Iterates over the currently stored events

Short for iterate(Handle, Prev, Limit, undefined, Prev) -> NewAcc

 - iterate(Handle, Prev, Limit, Fun, Acc) -> NewAcc + iterate(Handle, Prev, Limit, Fun, Acc) -> NewAcc Iterate over the currently stored events Handle = collector_pid() | table_handle() @@ -361,7 +361,7 @@ - clear_table(Handle) -> ok + clear_table(Handle) -> ok Clear the event table Handle = collector_pid() | table_handle() diff --git a/lib/et/doc/src/et_selector.xml b/lib/et/doc/src/et_selector.xml index 30ca74c872..3c766cafb7 100644 --- a/lib/et/doc/src/et_selector.xml +++ b/lib/et/doc/src/et_selector.xml @@ -32,7 +32,7 @@ %VSN% et_selector.xml - et_selector + et_selector Define event transforms and trace patterns

@@ -40,7 +40,7 @@ - make_pattern(RawPattern) -> TracePattern + make_pattern(RawPattern) -> TracePattern Makes a trace pattern suitable to feed change_pattern/1 @@ -61,7 +61,7 @@ - change_pattern(Pattern) -> ok + change_pattern(Pattern) -> ok Activates/deactivates tracing by changing the current trace pattern @@ -85,7 +85,7 @@ - parse_event(Mod, ValidTraceData) -> false | true | {true, Event} + parse_event(Mod, ValidTraceData) -> false | true | {true, Event} Transforms trace data and makes an event record out of it diff --git a/lib/et/doc/src/et_viewer.xml b/lib/et/doc/src/et_viewer.xml index e0b39636e9..9d59eef668 100644 --- a/lib/et/doc/src/et_viewer.xml +++ b/lib/et/doc/src/et_viewer.xml @@ -32,14 +32,14 @@ %VSN% et_viewer.xml - et_viewer + et_viewer Displays a sequence chart for trace events (messages/actions)

- file(FileName) -> {ok, ViewerPid} | {error, Reason} + file(FileName) -> {ok, ViewerPid} | {error, Reason} Start a new event viewer and a corresponding collector and load them with trace events from a trace file. FileName() = string() @@ -52,7 +52,7 @@ - start() -> ok + start() -> ok Simplified start of a sequence chart viewer with global tracing activated.

Simplified start of a sequence chart viewer with @@ -62,7 +62,7 @@ - start(Options) -> ok + start(Options) -> ok Start of a sequence chart viewer without linking to the parent process.

Start of a sequence chart viewer without linking @@ -70,7 +70,7 @@ - start_link(Options) -> {ok, ViewerPid} | {error, Reason} + start_link(Options) -> {ok, ViewerPid} | {error, Reason} Start a sequence chart viewer for trace events (messages/actions) Options = [option() | collector_option()] @@ -125,7 +125,7 @@ - get_collector_pid(ViewerPid) -> CollectorPid + get_collector_pid(ViewerPid) -> CollectorPid Returns the identifier of the collector process ViewerPid = pid() @@ -136,7 +136,7 @@ - stop(ViewerPid) -> ok + stop(ViewerPid) -> ok Stops a viewer ViewerPid = pid() -- cgit v1.2.3