From 9e5169ac90db625061e486854729b8279ba46378 Mon Sep 17 00:00:00 2001 From: Sverker Eriksson Date: Mon, 10 Dec 2018 17:54:32 +0100 Subject: erl_interface: Fix doc for return type 'struct hostent' '*' is part of the return type, not the function name. --- lib/erl_interface/doc/src/ei_connect.xml | 8 ++++---- lib/erl_interface/doc/src/erl_connect.xml | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) (limited to 'lib') diff --git a/lib/erl_interface/doc/src/ei_connect.xml b/lib/erl_interface/doc/src/ei_connect.xml index 607a7cbff4..d5a55087a3 100644 --- a/lib/erl_interface/doc/src/ei_connect.xml +++ b/lib/erl_interface/doc/src/ei_connect.xml @@ -87,10 +87,10 @@ - struct hostent*ei_gethostbyaddr(const char *addr, int len, int type) - struct hostent*ei_gethostbyaddr_r(const char *addr, int length, int type, struct hostent *hostp, char *buffer, int buflen, int *h_errnop) - struct hostent*ei_gethostbyname(const char *name) - struct hostent*ei_gethostbyname_r(const char *name, struct hostent *hostp, char *buffer, int buflen, int *h_errnop) + struct hostent *ei_gethostbyaddr(const char *addr, int len, int type) + struct hostent *ei_gethostbyaddr_r(const char *addr, int length, int type, struct hostent *hostp, char *buffer, int buflen, int *h_errnop) + struct hostent *ei_gethostbyname(const char *name) + struct hostent *ei_gethostbyname_r(const char *name, struct hostent *hostp, char *buffer, int buflen, int *h_errnop) Name lookup functions.

Convenience functions for some common name lookup functions.

diff --git a/lib/erl_interface/doc/src/erl_connect.xml b/lib/erl_interface/doc/src/erl_connect.xml index 76ef6588c2..8df03d4ecc 100644 --- a/lib/erl_interface/doc/src/erl_connect.xml +++ b/lib/erl_interface/doc/src/erl_connect.xml @@ -616,10 +616,10 @@ typedef struct {
- struct hostent*erl_gethostbyaddr(addr, length, type) - struct hostent*erl_gethostbyaddr_r(addr, length, type, hostp, buffer, buflen, h_errnop) - struct hostent*erl_gethostbyname(name) - struct hostent*erl_gethostbyname_r(name, hostp, buffer, buflen, h_errnop) + struct hostent *erl_gethostbyaddr(addr, length, type) + struct hostent *erl_gethostbyaddr_r(addr, length, type, hostp, buffer, buflen, h_errnop) + struct hostent *erl_gethostbyname(name) + struct hostent *erl_gethostbyname_r(name, hostp, buffer, buflen, h_errnop) Name lookup functions. -- cgit v1.2.3 From b56feddd7f53c35a54a2d06dedee2780bb74715e Mon Sep 17 00:00:00 2001 From: Sverker Eriksson Date: Fri, 16 Nov 2018 14:53:40 +0100 Subject: erl_docgen: Generate "since" OTP version in html for and with "since" attribute. --- lib/erl_docgen/priv/css/otp_doc.css | 33 ++++++++++ lib/erl_docgen/priv/xsl/db_html.xsl | 125 ++++++++++++++++++++++++------------ 2 files changed, 118 insertions(+), 40 deletions(-) (limited to 'lib') diff --git a/lib/erl_docgen/priv/css/otp_doc.css b/lib/erl_docgen/priv/css/otp_doc.css index 34c6befb0e..89b278215c 100644 --- a/lib/erl_docgen/priv/css/otp_doc.css +++ b/lib/erl_docgen/priv/css/otp_doc.css @@ -71,6 +71,33 @@ a:visited { color: #1b6ec2; text-decoration: none } } .bold_code { font-family: mono, Courier, monospace; font-weight: bold } + +/* Invisible table for function specs, + * just to get since-version out in right margin */ +.func-table, .func-tr, .func-td, .func-since-td { + width: 200%; + border: 0; + padding: 0; + margin: 0; +} + +.func-tr:nth-child(n) { + background: inherit /* turn off zebra striped rows */ +} + +.func-td { + width: 50% +} + +.func-since-td { + width: 50%; + padding-left: 1em +} + +.func-td:hover { + background-color: #f5f5f5; +} + .code { font-family: mono, Courier, monospace; font-weight: normal; @@ -283,3 +310,9 @@ a > .code { .func-types-title{ font-size: 1em; } + +.since{ + color: gray; + font-weight: normal; + font-size: small; +} \ No newline at end of file diff --git a/lib/erl_docgen/priv/xsl/db_html.xsl b/lib/erl_docgen/priv/xsl/db_html.xsl index a0a922216b..c5150d447c 100644 --- a/lib/erl_docgen/priv/xsl/db_html.xsl +++ b/lib/erl_docgen/priv/xsl/db_html.xsl @@ -191,6 +191,7 @@ + @@ -225,11 +226,12 @@ - + - + + @@ -238,19 +240,32 @@ + -
- - - - - - - - -
+ + + + + +
+
+ + + + + + + + +
+
+ + + + +
@@ -1884,6 +1899,16 @@ + + + + Since + +
+ Module was introduced in + . +
+
@@ -2030,11 +2055,10 @@ -

- -

+ + @@ -2093,19 +2117,29 @@ - - - - - - - - - - - - -
+ + + + + +
+ + + + + + + + + + + + + + + + +
@@ -2136,14 +2170,25 @@ -
- - - - - - -
+ + + + + +
+
+ + + + + + +
+
+ + + +
-- cgit v1.2.3 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/common_test/doc/src/common_test_app.xml | 6 +- lib/common_test/doc/src/ct.xml | 66 ++++----- lib/common_test/doc/src/ct_cover.xml | 2 +- lib/common_test/doc/src/ct_hooks.xml | 36 ++--- lib/common_test/doc/src/ct_master.xml | 4 +- lib/common_test/doc/src/ct_netconfc.xml | 110 +++++++-------- lib/common_test/doc/src/ct_property_test.xml | 6 +- lib/common_test/doc/src/ct_slave.xml | 12 +- lib/common_test/doc/src/ct_snmp.xml | 10 +- lib/common_test/doc/src/ct_ssh.xml | 4 +- lib/common_test/doc/src/ct_telnet.xml | 4 +- lib/common_test/doc/src/ct_testspec.xml | 4 +- lib/common_test/doc/src/unix_telnet.xml | 2 +- lib/compiler/doc/src/compile.xml | 2 +- lib/crypto/doc/src/crypto.xml | 134 +++++++++--------- lib/diameter/doc/src/diameter.xml | 28 ++-- lib/diameter/doc/src/diameter_app.xml | 18 +-- lib/diameter/doc/src/diameter_codec.xml | 6 +- lib/diameter/doc/src/diameter_make.xml | 10 +- lib/diameter/doc/src/diameter_sctp.xml | 4 +- lib/diameter/doc/src/diameter_tcp.xml | 4 +- lib/diameter/doc/src/diameter_transport.xml | 4 +- lib/eldap/doc/src/eldap.xml | 68 +++++----- lib/erl_docgen/doc/src/docgen_xml_check.xml | 4 +- lib/erl_interface/doc/src/ei.xml | 16 +-- lib/erl_interface/doc/src/ei_connect.xml | 4 +- lib/et/doc/src/et.xml | 4 +- lib/ftp/doc/src/ftp.xml | 4 +- lib/inets/doc/src/http_uri.xml | 12 +- lib/inets/doc/src/httpc.xml | 50 +++---- lib/inets/doc/src/httpd.xml | 2 +- lib/inets/doc/src/httpd_custom_api.xml | 8 +- lib/inets/doc/src/mod_auth.xml | 2 +- lib/inets/doc/src/mod_security.xml | 4 +- lib/kernel/doc/src/application.xml | 10 +- lib/kernel/doc/src/code.xml | 14 +- lib/kernel/doc/src/erl_epmd.xml | 16 +-- lib/kernel/doc/src/error_handler.xml | 2 +- lib/kernel/doc/src/error_logger.xml | 2 +- lib/kernel/doc/src/file.xml | 24 ++-- lib/kernel/doc/src/gen_sctp.xml | 6 +- lib/kernel/doc/src/heart.xml | 10 +- lib/kernel/doc/src/inet.xml | 34 ++--- lib/kernel/doc/src/logger.xml | 166 +++++++++++------------ lib/kernel/doc/src/logger_disk_log_h.xml | 4 +- lib/kernel/doc/src/logger_filters.xml | 10 +- lib/kernel/doc/src/logger_formatter.xml | 6 +- lib/kernel/doc/src/logger_std_h.xml | 4 +- lib/kernel/doc/src/net_kernel.xml | 4 +- lib/kernel/doc/src/os.xml | 16 +-- lib/mnesia/doc/src/mnesia.xml | 4 +- lib/observer/doc/src/crashdump.xml | 2 +- lib/observer/doc/src/etop.xml | 6 +- lib/observer/doc/src/observer.xml | 4 +- lib/observer/doc/src/ttb.xml | 4 +- lib/public_key/doc/src/public_key.xml | 102 +++++++------- lib/reltool/doc/src/reltool.xml | 2 +- lib/runtime_tools/doc/src/dbg.xml | 4 +- lib/runtime_tools/doc/src/dyntrace.xml | 32 ++--- lib/runtime_tools/doc/src/msacc.xml | 32 ++--- lib/runtime_tools/doc/src/scheduler.xml | 12 +- lib/runtime_tools/doc/src/system_information.xml | 6 +- lib/sasl/doc/src/rb.xml | 8 +- lib/sasl/doc/src/release_handler.xml | 4 +- lib/snmp/doc/src/snmp.xml | 10 +- lib/snmp/doc/src/snmp_community_mib.xml | 2 +- lib/snmp/doc/src/snmp_generic.xml | 2 +- lib/snmp/doc/src/snmpa.xml | 46 +++---- lib/snmp/doc/src/snmpa_conf.xml | 2 +- lib/snmp/doc/src/snmpa_mib_data.xml | 34 ++--- lib/snmp/doc/src/snmpa_mib_storage.xml | 26 ++-- lib/snmp/doc/src/snmpa_mpd.xml | 14 +- lib/snmp/doc/src/snmpm.xml | 56 ++++---- lib/snmp/doc/src/snmpm_mpd.xml | 2 +- lib/snmp/doc/src/snmpm_user.xml | 2 +- lib/ssh/doc/src/ssh.xml | 10 +- lib/ssh/doc/src/ssh_client_channel.xml | 32 ++--- lib/ssh/doc/src/ssh_client_key_api.xml | 8 +- lib/ssh/doc/src/ssh_connection.xml | 4 +- lib/ssh/doc/src/ssh_file.xml | 12 +- lib/ssh/doc/src/ssh_server_channel.xml | 10 +- lib/ssh/doc/src/ssh_server_key_api.xml | 6 +- lib/ssh/doc/src/ssh_sftp.xml | 4 +- lib/ssl/doc/src/ssl.xml | 64 ++++----- lib/ssl/doc/src/ssl_crl_cache.xml | 8 +- lib/ssl/doc/src/ssl_crl_cache_api.xml | 10 +- lib/ssl/doc/src/ssl_session_cache_api.xml | 18 +-- lib/stdlib/doc/src/beam_lib.xml | 4 +- lib/stdlib/doc/src/binary.xml | 56 ++++---- lib/stdlib/doc/src/c.xml | 10 +- lib/stdlib/doc/src/calendar.xml | 16 +-- lib/stdlib/doc/src/dict.xml | 4 +- lib/stdlib/doc/src/epp.xml | 22 +-- lib/stdlib/doc/src/erl_anno.xml | 36 ++--- lib/stdlib/doc/src/erl_internal.xml | 2 +- lib/stdlib/doc/src/erl_parse.xml | 14 +- lib/stdlib/doc/src/erl_scan.xml | 14 +- lib/stdlib/doc/src/erl_tar.xml | 2 +- lib/stdlib/doc/src/ets.xml | 18 +-- lib/stdlib/doc/src/filelib.xml | 10 +- lib/stdlib/doc/src/filename.xml | 10 +- lib/stdlib/doc/src/gb_sets.xml | 2 +- lib/stdlib/doc/src/gb_trees.xml | 6 +- lib/stdlib/doc/src/gen_event.xml | 8 +- lib/stdlib/doc/src/gen_server.xml | 8 +- lib/stdlib/doc/src/gen_statem.xml | 48 +++---- lib/stdlib/doc/src/io.xml | 12 +- lib/stdlib/doc/src/io_lib.xml | 28 ++-- lib/stdlib/doc/src/lists.xml | 8 +- lib/stdlib/doc/src/maps.xml | 50 +++---- lib/stdlib/doc/src/math.xml | 8 +- lib/stdlib/doc/src/orddict.xml | 4 +- lib/stdlib/doc/src/ordsets.xml | 2 +- lib/stdlib/doc/src/proc_lib.xml | 8 +- lib/stdlib/doc/src/rand.xml | 38 +++--- lib/stdlib/doc/src/re.xml | 4 +- lib/stdlib/doc/src/sets.xml | 2 +- lib/stdlib/doc/src/shell.xml | 4 +- lib/stdlib/doc/src/string.xml | 66 ++++----- lib/stdlib/doc/src/supervisor.xml | 4 +- lib/stdlib/doc/src/sys.xml | 16 +-- lib/stdlib/doc/src/timer.xml | 4 +- lib/stdlib/doc/src/unicode.xml | 16 +-- lib/stdlib/doc/src/uri_string.xml | 18 +-- lib/stdlib/doc/src/zip.xml | 2 +- lib/tftp/doc/src/tftp.xml | 16 +-- 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 +++++----- 130 files changed, 1146 insertions(+), 1146 deletions(-) (limited to 'lib') diff --git a/lib/common_test/doc/src/common_test_app.xml b/lib/common_test/doc/src/common_test_app.xml index a3b3f927eb..0401293444 100644 --- a/lib/common_test/doc/src/common_test_app.xml +++ b/lib/common_test/doc/src/common_test_app.xml @@ -272,7 +272,7 @@
- Module:group(GroupName) -> [Info] + Module:group(GroupName) -> [Info] Test case group information function (providing default data for a test case group, that is, its test cases and subgroups). @@ -486,7 +486,7 @@ - Module:Testcase() -> [Info] + Module:Testcase() -> [Info] Test case information function. Info = {timetrap,Time} | {require,Required} | {require,Name,Required} | {userdata,UserData} | {silent_connections,Conns} @@ -560,7 +560,7 @@ - Module:Testcase(Config) -> term() | {skip,Reason} | {comment,Comment} | {save_config,SaveConfig} | {skip_and_save,Reason,SaveConfig} | exit() + Module:Testcase(Config) -> term() | {skip,Reason} | {comment,Comment} | {save_config,SaveConfig} | {skip_and_save,Reason,SaveConfig} | exit() A test case. Config = SaveConfig = [{Key,Value}] diff --git a/lib/common_test/doc/src/ct.xml b/lib/common_test/doc/src/ct.xml index c0380c4142..e55637a7fe 100644 --- a/lib/common_test/doc/src/ct.xml +++ b/lib/common_test/doc/src/ct.xml @@ -157,7 +157,7 @@ - add_config(Callback, Config) -> ok | {error, Reason} + add_config(Callback, Config) -> ok | {error, Reason} Loads configuration variables using the specified callback module and configuration string. @@ -176,7 +176,7 @@ - break(Comment) -> ok | {error, Reason} + break(Comment) -> ok | {error, Reason} Cancels any active timetrap and pause the execution of the current test case until the user calls function continue/0. @@ -206,7 +206,7 @@ - break(TestCase, Comment) -> ok | {error, Reason} + break(TestCase, Comment) -> ok | {error, Reason} Works the same way as break/1, only argument TestCase makes it possible to pause a test case executing in a parallel group. @@ -228,7 +228,7 @@ - capture_get() -> ListOfStrings + capture_get() -> ListOfStrings Equivalent to capture_get([default]). ListOfStrings = [string()] @@ -240,7 +240,7 @@ - capture_get(ExclCategories) -> ListOfStrings + capture_get(ExclCategories) -> ListOfStrings Returns and purges the list of text strings buffered during the latest session of capturing printouts to stdout. @@ -262,7 +262,7 @@ - capture_start() -> ok + capture_start() -> ok Starts capturing all text strings printed to stdout during execution of the test case. @@ -276,7 +276,7 @@ - capture_stop() -> ok + capture_stop() -> ok Stops capturing text strings (a session started with capture_start/0). @@ -307,7 +307,7 @@ - comment(Format, Args) -> ok + comment(Format, Args) -> ok Prints the formatted string in the comment field in the table on the test suite result page. @@ -326,7 +326,7 @@ - continue() -> ok + continue() -> ok This function must be called to continue after a test case (not executing in a parallel group) has called break/1. @@ -337,7 +337,7 @@ - continue(TestCase) -> ok + continue(TestCase) -> ok This function must be called to continue after a test case has called break/2. @@ -454,7 +454,7 @@ - fail(Format, Args) -> ok + fail(Format, Args) -> ok Terminates a test case with an error message specified by a format string and a list of values (used as arguments to io_lib:format/2). @@ -554,7 +554,7 @@ - get_event_mgr_ref() -> EvMgrRef + get_event_mgr_ref() -> EvMgrRef Gets a reference to the Common Test event manager. EvMgrRef = atom() @@ -572,7 +572,7 @@ - get_progname() -> string() + get_progname() -> string() Returns the command used to start this Erlang instance.

Returns the command used to start this Erlang instance. @@ -622,7 +622,7 @@ - get_testspec_terms() -> TestSpecTerms | undefined + get_testspec_terms() -> TestSpecTerms | undefined Gets a list of all test specification terms used to configure and run this test. @@ -636,7 +636,7 @@ - get_testspec_terms(Tags) -> TestSpecTerms | undefined + get_testspec_terms(Tags) -> TestSpecTerms | undefined Reads one or more terms from the test specification used to configure and run this test. @@ -663,7 +663,7 @@ - get_timetrap_info() -> {Time, {Scaling,ScaleVal}} + get_timetrap_info() -> {Time, {Scaling,ScaleVal}} Reads information about the timetrap set for the current test case. @@ -682,7 +682,7 @@ - get_verbosity(Category) -> Level | undefined + get_verbosity(Category) -> Level | undefined Read the verbosity level for a logging category. Category = default | atom() @@ -778,7 +778,7 @@ - log(X1, X2, X3, X4) -> ok + log(X1, X2, X3, X4) -> ok Equivalent to log(Category, Importance, Format, FormatArgs, Opts). @@ -794,7 +794,7 @@ - log(Category, Importance, Format, FormatArgs, Opts) -> ok + log(Category, Importance, Format, FormatArgs, Opts) -> ok Prints from a test case to the log file. Category = atom() @@ -825,7 +825,7 @@ - make_priv_dir() -> ok | {error, Reason} + make_priv_dir() -> ok | {error, Reason} If the test has been started with option create_priv_dir set to manual_per_tc, in order for the test case to use the private directory, it must first create it by calling this function. @@ -841,7 +841,7 @@ - notify(Name, Data) -> ok + notify(Name, Data) -> ok Sends an asynchronous notification of type Name with Data to the Common Test event manager. @@ -898,7 +898,7 @@ - pal(X1, X2, X3, X4) -> ok + pal(X1, X2, X3, X4) -> ok Equivalent to pal(Category, Importance, Format, FormatArgs, Opts). @@ -914,7 +914,7 @@ - pal(Category, Importance, Format, FormatArgs, Opts) -> ok + pal(Category, Importance, Format, FormatArgs, Opts) -> ok Prints and logs from a test case. Category = atom() @@ -976,7 +976,7 @@ - print(X1, X2) -> ok + print(X1, X2) -> ok Equivalent to print(Category, Importance, Format, FormatArgs, []). @@ -1005,7 +1005,7 @@ - print(X1, X2, X3, X4) -> ok + print(X1, X2, X3, X4) -> ok Equivalent to print(Category, Importance, Format, FormatArgs, Opts). @@ -1021,7 +1021,7 @@ - print(Category, Importance, Format, FormatArgs, Opts) -> ok + print(Category, Importance, Format, FormatArgs, Opts) -> ok Prints from a test case to the console. Category = atom() @@ -1048,7 +1048,7 @@ - reload_config(Required) -> ValueOrElement | {error, Reason} + reload_config(Required) -> ValueOrElement | {error, Reason} Reloads configuration file containing specified configuration key. @@ -1071,7 +1071,7 @@ - remaining_test_procs() -> {TestProcs,SharedGL,OtherGLs} + remaining_test_procs() -> {TestProcs,SharedGL,OtherGLs} >This function will return the identity of test- and group leader processes that are still running at the time of this call. @@ -1107,7 +1107,7 @@ - remove_config(Callback, Config) -> ok + remove_config(Callback, Config) -> ok Removes configuration variables (together with their aliases) that were loaded with specified callback module and configuration string. @@ -1375,7 +1375,7 @@ - set_verbosity(Category, Level) -> ok + set_verbosity(Category, Level) -> ok Set the verbosity level for a logging category. Category = default | atom() @@ -1390,7 +1390,7 @@ - sleep(Time) -> ok + sleep(Time) -> ok This function, similar to timer:sleep/1, suspends the test case for a specified time. @@ -1482,7 +1482,7 @@ - sync_notify(Name, Data) -> ok + sync_notify(Name, Data) -> ok Sends a synchronous notification of type Name with Data to the Common Test event manager. @@ -1515,7 +1515,7 @@ - timetrap(Time) -> ok + timetrap(Time) -> ok Sets a new timetrap for the running test case. Time = {hours, Hours} | {minutes, Mins} | {seconds, Secs} | Millisecs | infinity | Func diff --git a/lib/common_test/doc/src/ct_cover.xml b/lib/common_test/doc/src/ct_cover.xml index 89d944acbe..f777fd1ce9 100644 --- a/lib/common_test/doc/src/ct_cover.xml +++ b/lib/common_test/doc/src/ct_cover.xml @@ -67,7 +67,7 @@ - cross_cover_analyse(Level, Tests) -> ok + cross_cover_analyse(Level, Tests) -> ok Accumulates cover results over multiple tests. Level = overview | details diff --git a/lib/common_test/doc/src/ct_hooks.xml b/lib/common_test/doc/src/ct_hooks.xml index 954be0ffba..048552e4bb 100644 --- a/lib/common_test/doc/src/ct_hooks.xml +++ b/lib/common_test/doc/src/ct_hooks.xml @@ -32,7 +32,7 @@ PA1 ct_hooks.sgml - ct_hooks + ct_hooks A callback interface on top of Common Test. @@ -75,7 +75,7 @@ - Module:init(Id, Opts) -> {ok, State} | {ok, State, Priority} + Module:init(Id, Opts) -> {ok, State} | {ok, State, Priority} Initiates the Common Test Hook. Id = reference() | term() @@ -109,7 +109,7 @@ - Module:pre_init_per_suite(SuiteName, InitData, CTHState) -> Result + Module:pre_init_per_suite(SuiteName, InitData, CTHState) -> Result Called before init_per_suite. SuiteName = atom() @@ -161,7 +161,7 @@ - Module:post_init_per_suite(SuiteName, Config, Return, CTHState) -> Result + Module:post_init_per_suite(SuiteName, Config, Return, CTHState) -> Result Called after init_per_suite. SuiteName = atom() @@ -208,7 +208,7 @@ - Module:pre_init_per_group(SuiteName, GroupName, InitData, CTHState) -> Result + Module:pre_init_per_group(SuiteName, GroupName, InitData, CTHState) -> Result Called before init_per_group. SuiteName = atom() @@ -241,7 +241,7 @@ - Module:post_init_per_group(SuiteName, GroupName, Config, Return, CTHState) -> Result + Module:post_init_per_group(SuiteName, GroupName, Config, Return, CTHState) -> Result Called after init_per_group. SuiteName = atom() @@ -274,7 +274,7 @@ - Module:pre_init_per_testcase(SuiteName, TestcaseName, InitData, CTHState) -> Result + Module:pre_init_per_testcase(SuiteName, TestcaseName, InitData, CTHState) -> Result Called before init_per_testcase. SuiteName = atom() @@ -311,7 +311,7 @@ - Module:post_init_per_testcase(SuiteName, TestcaseName, Config, Return, CTHState) -> Result + Module:post_init_per_testcase(SuiteName, TestcaseName, Config, Return, CTHState) -> Result Called after init_per_testcase. SuiteName = atom() @@ -344,7 +344,7 @@ - Module:pre_end_per_testcase(SuiteName, TestcaseName, EndData, CTHState) -> Result + Module:pre_end_per_testcase(SuiteName, TestcaseName, EndData, CTHState) -> Result Called before end_per_testcase. SuiteName = atom() @@ -380,7 +380,7 @@ - Module:post_end_per_testcase(SuiteName, TestcaseName, Config, Return, CTHState) -> Result + Module:post_end_per_testcase(SuiteName, TestcaseName, Config, Return, CTHState) -> Result Called after end_per_testcase. SuiteName = atom() @@ -413,7 +413,7 @@ - Module:pre_end_per_group(SuiteName, GroupName, EndData, CTHState) -> Result + Module:pre_end_per_group(SuiteName, GroupName, EndData, CTHState) -> Result Called before end_per_group. SuiteName = atom() @@ -446,7 +446,7 @@ - Module:post_end_per_group(SuiteName, GroupName, Config, Return, CTHState) -> Result + Module:post_end_per_group(SuiteName, GroupName, Config, Return, CTHState) -> Result Called after end_per_group. SuiteName = atom() @@ -479,7 +479,7 @@ - Module:pre_end_per_suite(SuiteName, EndData, CTHState) -> Result + Module:pre_end_per_suite(SuiteName, EndData, CTHState) -> Result Called before end_per_suite. SuiteName = atom() @@ -506,7 +506,7 @@ - Module:post_end_per_suite(SuiteName, Config, Return, CTHState) -> Result + Module:post_end_per_suite(SuiteName, Config, Return, CTHState) -> Result Called after end_per_suite. SuiteName = atom() @@ -533,7 +533,7 @@ - Module:on_tc_fail(SuiteName, TestName, Reason, CTHState) -> NewCTHState + Module:on_tc_fail(SuiteName, TestName, Reason, CTHState) -> NewCTHState Called after the CTH scope ends. SuiteName = atom() @@ -577,7 +577,7 @@ - Module:on_tc_skip(SuiteName, TestName, Reason, CTHState) -> NewCTHState + Module:on_tc_skip(SuiteName, TestName, Reason, CTHState) -> NewCTHState Called after the CTH scope ends. SuiteName = atom() @@ -623,7 +623,7 @@ - Module:terminate(CTHState) + Module:terminate(CTHState) Called after the CTH scope ends. CTHState = term() @@ -637,7 +637,7 @@ - Module:id(Opts) -> Id + Module:id(Opts) -> Id Called before the init function of a CTH. Opts = term() diff --git a/lib/common_test/doc/src/ct_master.xml b/lib/common_test/doc/src/ct_master.xml index 6bde4644c6..8afd7c537e 100644 --- a/lib/common_test/doc/src/ct_master.xml +++ b/lib/common_test/doc/src/ct_master.xml @@ -65,7 +65,7 @@ - basic_html(Bool) -> ok + basic_html(Bool) -> ok If set to true, the ct_master logs are written on a primitive HTML format, not using the Common Test CSS style sheet. @@ -79,7 +79,7 @@ - get_event_mgr_ref() -> MasterEvMgrRef + get_event_mgr_ref() -> MasterEvMgrRef Gets a reference to the Common Test master event manager. diff --git a/lib/common_test/doc/src/ct_netconfc.xml b/lib/common_test/doc/src/ct_netconfc.xml index 7ec8f23073..32a1175d81 100644 --- a/lib/common_test/doc/src/ct_netconfc.xml +++ b/lib/common_test/doc/src/ct_netconfc.xml @@ -32,7 +32,7 @@ A ct_netconfc.xml - ct_netconfc + ct_netconfc NETCONF client module. @@ -312,8 +312,8 @@ - - + + Executes an action.

Executes an action. If the return type is void, ok is @@ -322,8 +322,8 @@ - - + + Requests graceful termination of the session associated with the client. @@ -339,7 +339,7 @@ - + Opens an SSH connection to a NETCONF server.

Opens an SSH connection to a NETCONF server.

@@ -361,7 +361,7 @@
- + Opens an SSH connection to a named NETCONF server.

Open an SSH connection to a named NETCONF server.

@@ -399,8 +399,8 @@
- - + + Copies configuration data.

Copies configuration data.

@@ -412,12 +412,12 @@
- create_subscription(Client) -> Result - create_subscription(Client, Stream) -> Result - create_subscription(Client, Stream, Filter) -> Result - create_subscription(Client, Stream, Filter, Timeout) -> Result - - + create_subscription(Client) -> Result + create_subscription(Client, Stream) -> Result + create_subscription(Client, Stream, Filter) -> Result + create_subscription(Client, Stream, Filter, Timeout) -> Result + + Creates a subscription for event notifications.

Creates a subscription for event notifications.

@@ -490,8 +490,8 @@ create_subscription(Client, Stream, Filter, StartTime, StopTime, Timeout)
- - + + Deletes configuration data.

Deletes configuration data.

@@ -502,7 +502,7 @@ create_subscription(Client, Stream, Filter, StartTime, StopTime, Timeout)
- + Closes the given SSH connection.

Closes the given SSH connection.

@@ -514,10 +514,10 @@ create_subscription(Client, Stream, Filter, StartTime, StopTime, Timeout)
- - - - + + + + Edits configuration data.

Edits configuration data.

@@ -542,8 +542,8 @@ create_subscription(Client, Stream, Filter, StartTime, StopTime, Timeout)
- - + + Gets data.

Gets data.

@@ -557,8 +557,8 @@ create_subscription(Client, Stream, Filter, StartTime, StopTime, Timeout)
- - + + Returns the server side capabilities.

Returns the server side capabilities.

@@ -582,8 +582,8 @@ create_subscription(Client, Stream, Filter, StartTime, StopTime, Timeout)
- - + + Gets configuration data.

Gets configuration data.

@@ -597,10 +597,10 @@ create_subscription(Client, Stream, Filter, StartTime, StopTime, Timeout)
- - - - + + + + Sends a request to get the specified event streams.

Sends a request to get the specified event streams.

@@ -637,8 +637,8 @@ create_subscription(Client, Stream, Filter, StartTime, StopTime, Timeout)
- - + + Returns the session Id associated with the specified client. @@ -647,9 +647,9 @@ create_subscription(Client, Stream, Filter, StartTime, StopTime, Timeout) - - - + + + Exchanges hello messages with the server.

Exchanges hello messages with the server.

@@ -660,8 +660,8 @@ create_subscription(Client, Stream, Filter, StartTime, StopTime, Timeout)
- - + + Forces termination of the session associated with the supplied session Id. @@ -682,8 +682,8 @@ create_subscription(Client, Stream, Filter, StartTime, StopTime, Timeout) - - + + Locks the configuration target.

Locks the configuration target.

@@ -703,7 +703,7 @@ create_subscription(Client, Stream, Filter, StartTime, StopTime, Timeout)
- + Opens a NETCONF session, but does not send hello.

Opens a NETCONF session, but does not send hello.

@@ -714,7 +714,7 @@ create_subscription(Client, Stream, Filter, StartTime, StopTime, Timeout)
- + Opens a named NETCONF session, but does not send hello.

Opens a named NETCONF session, but does not send hello.

@@ -725,7 +725,7 @@ create_subscription(Client, Stream, Filter, StartTime, StopTime, Timeout)
- + Opens a NETCONF session and exchanges hello messages.

Opens a NETCONF session and exchanges hello messages.

@@ -749,7 +749,7 @@ create_subscription(Client, Stream, Filter, StartTime, StopTime, Timeout)
- + Opens a named NETCONF session and exchanges hello messages. @@ -791,8 +791,8 @@ create_subscription(Client, Stream, Filter, StartTime, StopTime, Timeout) - - + + Sends an XML document to the server.

Sends an XML document to the server.

@@ -804,8 +804,8 @@ create_subscription(Client, Stream, Filter, StartTime, StopTime, Timeout)
- - + + Sends a NETCONF rpc request to the server.

Sends a NETCONF rpc request to the server.

@@ -820,10 +820,10 @@ create_subscription(Client, Stream, Filter, StartTime, StopTime, Timeout)
- - - - + + + + Opens a NETCONF session as a channel on the given SSH connection, and exchanges hello messages with the server. @@ -848,8 +848,8 @@ create_subscription(Client, Stream, Filter, StartTime, StopTime, Timeout) - - + + Unlocks the configuration target.

Unlocks the configuration target.

diff --git a/lib/common_test/doc/src/ct_property_test.xml b/lib/common_test/doc/src/ct_property_test.xml index 028e5eb69f..1e01d9a5d7 100644 --- a/lib/common_test/doc/src/ct_property_test.xml +++ b/lib/common_test/doc/src/ct_property_test.xml @@ -32,7 +32,7 @@ A ct_property_test.xml - ct_property_test + ct_property_test EXPERIMENTAL support in Common Test for calling property-based tests. @@ -79,7 +79,7 @@ - init_per_suite(Config) -> Config | {skip, Reason} + init_per_suite(Config) -> Config | {skip, Reason} Initializes Config for property testing.

Initializes Config for property testing.

@@ -98,7 +98,7 @@
- quickcheck(Property, Config) -> true | {fail, Reason} + quickcheck(Property, Config) -> true | {fail, Reason} Calls quickcheck and returns the result in a form suitable for Common Test. diff --git a/lib/common_test/doc/src/ct_slave.xml b/lib/common_test/doc/src/ct_slave.xml index 9d9aa50051..84e619482d 100644 --- a/lib/common_test/doc/src/ct_slave.xml +++ b/lib/common_test/doc/src/ct_slave.xml @@ -32,7 +32,7 @@ A ct_slave.xml - ct_slave + ct_slave Common Test framework functions for starting and stopping nodes for Large-Scale Testing. @@ -50,7 +50,7 @@ - start(Node) -> Result + start(Node) -> Result Starts an Erlang node with name Node on the local host. @@ -68,7 +68,7 @@ - start(HostOrNode, NodeOrOpts) -> Result + start(HostOrNode, NodeOrOpts) -> Result Starts an Erlang node with default options on a specified host, or on the local host with specified options. @@ -90,7 +90,7 @@ - start(Host, Node, Opts) -> Result + start(Host, Node, Opts) -> Result Starts an Erlang node with name Node on host Host as specified by the combination of options in Opts. @@ -184,7 +184,7 @@ - stop(Node) -> Result + stop(Node) -> Result Stops the running Erlang node with name Node on the local host. @@ -199,7 +199,7 @@ - stop(Host, Node) -> Result + stop(Host, Node) -> Result Stops the running Erlang node with name Node on host Host. diff --git a/lib/common_test/doc/src/ct_snmp.xml b/lib/common_test/doc/src/ct_snmp.xml index 0a5e52b16c..3d8c5d3e92 100644 --- a/lib/common_test/doc/src/ct_snmp.xml +++ b/lib/common_test/doc/src/ct_snmp.xml @@ -430,7 +430,7 @@ - unload_mibs(Mibs) -> ok | {error, Reason} + unload_mibs(Mibs) -> ok | {error, Reason} Unloads the MIBs from agent snmp_master_agent. Mibs = [MibName] @@ -455,7 +455,7 @@ - unregister_agents(MgrAgentConfName, ManagedAgents) -> ok + unregister_agents(MgrAgentConfName, ManagedAgents) -> ok Unregisters the specified managed agents. MgrAgentConfName = atom() @@ -480,7 +480,7 @@ - unregister_users(MgrAgentConfName, Users) -> ok + unregister_users(MgrAgentConfName, Users) -> ok Unregisters the specified users. MgrAgentConfName = atom() @@ -493,7 +493,7 @@ - unregister_usm_users(MgrAgentConfName) -> ok + unregister_usm_users(MgrAgentConfName) -> ok Unregisters all USM users. MgrAgentConfName = atom() @@ -505,7 +505,7 @@ - unregister_usm_users(MgrAgentConfName, UsmUsers) -> ok + unregister_usm_users(MgrAgentConfName, UsmUsers) -> ok Unregisters the specified USM users. MgrAgentConfName = atom() diff --git a/lib/common_test/doc/src/ct_ssh.xml b/lib/common_test/doc/src/ct_ssh.xml index 0c7efed154..bb0aaa46b7 100644 --- a/lib/common_test/doc/src/ct_ssh.xml +++ b/lib/common_test/doc/src/ct_ssh.xml @@ -1034,7 +1034,7 @@ ChannelId, 0, Data, End, Timeout).

- shell(SSH, ChannelId) -> ok | {error, Reason} + shell(SSH, ChannelId) -> ok | {error, Reason} Equivalent to shell(SSH, ChannelId, DefaultTimeout).

Equivalent to @@ -1044,7 +1044,7 @@ ChannelId, 0, Data, End, Timeout).

- shell(SSH, ChannelId, Timeout) -> ok | {error, Reason} + shell(SSH, ChannelId, Timeout) -> ok | {error, Reason} Requests that the user default shell is executed at the server end. diff --git a/lib/common_test/doc/src/ct_telnet.xml b/lib/common_test/doc/src/ct_telnet.xml index 8e85cccc99..2d69338bca 100644 --- a/lib/common_test/doc/src/ct_telnet.xml +++ b/lib/common_test/doc/src/ct_telnet.xml @@ -541,7 +541,7 @@ - send(Connection, Cmd, Opts) -> ok | {error, Reason} + send(Connection, Cmd, Opts) -> ok | {error, Reason} Sends a Telnet command and returns immediately. Connection = connection() @@ -576,7 +576,7 @@ - sendf(Connection, CmdFormat, Args, Opts) -> ok | {error, Reason} + sendf(Connection, CmdFormat, Args, Opts) -> ok | {error, Reason} Sends a Telnet command and returns immediately (uses a format string and a list of arguments to build the command). diff --git a/lib/common_test/doc/src/ct_testspec.xml b/lib/common_test/doc/src/ct_testspec.xml index 36893f66cf..9cb9a2ae9f 100644 --- a/lib/common_test/doc/src/ct_testspec.xml +++ b/lib/common_test/doc/src/ct_testspec.xml @@ -32,7 +32,7 @@ A ct_testspec.xml - ct_testspec + ct_testspec Parsing of test specifications for Common Test. @@ -46,7 +46,7 @@ - get_tests(SpecsIn) -> {ok, [{Specs,Tests}]} | {error, Reason} + get_tests(SpecsIn) -> {ok, [{Specs,Tests}]} | {error, Reason} Parse the given test specification files and return the tests to run and skip. SpecsIn = [string()] | [[string()]] diff --git a/lib/common_test/doc/src/unix_telnet.xml b/lib/common_test/doc/src/unix_telnet.xml index b2314a53ec..eaa184d8fc 100644 --- a/lib/common_test/doc/src/unix_telnet.xml +++ b/lib/common_test/doc/src/unix_telnet.xml @@ -80,7 +80,7 @@ - connect(ConnName, Ip, Port, Timeout, KeepAlive, TCPNoDelay, Extra) -> {ok, Handle} | {error, Reason} + connect(ConnName, Ip, Port, Timeout, KeepAlive, TCPNoDelay, Extra) -> {ok, Handle} | {error, Reason} Callback for ct_telnet.erl. ConnName = target_name() diff --git a/lib/compiler/doc/src/compile.xml b/lib/compiler/doc/src/compile.xml index cfbd4c7fda..4c8b34e278 100644 --- a/lib/compiler/doc/src/compile.xml +++ b/lib/compiler/doc/src/compile.xml @@ -40,7 +40,7 @@ - env_compiler_options() + env_compiler_options() Compiler options defined via the environment variable ERL_COMPILER_OPTIONS diff --git a/lib/crypto/doc/src/crypto.xml b/lib/crypto/doc/src/crypto.xml index b33db0d6e4..5a2343fb7e 100644 --- a/lib/crypto/doc/src/crypto.xml +++ b/lib/crypto/doc/src/crypto.xml @@ -524,7 +524,7 @@ - + Encrypt PlainText according to Type block cipher

Encrypt PlainText according to Type block cipher.

@@ -537,7 +537,7 @@
- + Decrypt CipherText according to Type block cipher

Decrypt CipherText according to Type block cipher.

@@ -550,9 +550,9 @@
- block_encrypt(Type, Key, Ivec, PlainText) -> CipherText - block_encrypt(AeadType, Key, Ivec, {AAD, PlainText}) -> {CipherText, CipherTag} - block_encrypt(aes_gcm | aes_ccm, Key, Ivec, {AAD, PlainText, TagLength}) -> {CipherText, CipherTag} + block_encrypt(Type, Key, Ivec, PlainText) -> CipherText + block_encrypt(AeadType, Key, Ivec, {AAD, PlainText}) -> {CipherText, CipherTag} + block_encrypt(aes_gcm | aes_ccm, Key, Ivec, {AAD, PlainText, TagLength}) -> {CipherText, CipherTag} Encrypt PlainText according to Type block cipher Type = block_cipher_with_iv() @@ -577,8 +577,8 @@ - block_decrypt(Type, Key, Ivec, CipherText) -> PlainText - block_decrypt(AeadType, Key, Ivec, {AAD, CipherText, CipherTag}) -> PlainText | error + block_decrypt(Type, Key, Ivec, CipherText) -> PlainText + block_decrypt(AeadType, Key, Ivec, {AAD, CipherText, CipherTag}) -> PlainText | error Decrypt CipherText according to Type block cipher Type = block_cipher_with_iv() @@ -603,7 +603,7 @@ - + Convert binary representation, of an integer, to an Erlang integer.

Convert binary representation, of an integer, to an Erlang integer. @@ -612,7 +612,7 @@ - + Computes the shared secret

Computes the shared secret from the private key and the other party's public key. @@ -631,8 +631,8 @@ - - + + Generates a public key of type Type

Generates a public key of type Type. @@ -653,7 +653,7 @@ - +

Computes a message digest of type Type from Data.

@@ -663,7 +663,7 @@
- +

Initializes the context for streaming hash operations. Type determines @@ -675,7 +675,7 @@ - +

Updates the digest represented by Context using the given Data. Context @@ -687,7 +687,7 @@ - +

Finalizes the hash operation referenced by Context returned @@ -698,8 +698,8 @@ - - + +

Computes a HMAC of type Type from Data using @@ -709,7 +709,7 @@ - +

Initializes the context for streaming HMAC operations. Type determines @@ -719,7 +719,7 @@ - +

Updates the HMAC represented by Context using the given Data. Context @@ -738,7 +738,7 @@ - +

Finalizes the HMAC operation referenced by Context. The size of the resultant MAC is @@ -747,7 +747,7 @@ - +

Finalizes the HMAC operation referenced by Context. HashLen must be greater than @@ -756,8 +756,8 @@ - - + + Calculates the Cipher-based Message Authentication Code.

Computes a CMAC of type Type from Data using @@ -767,7 +767,7 @@ - + Provides information about the FIPS operating status.

Provides information about the FIPS operating status of @@ -790,7 +790,7 @@ - + Change FIPS mode.

Enables (Enable = true) or disables (Enable = false) FIPS mode. Returns true if @@ -826,7 +826,7 @@ - + Computes the function: N^P mod M

Computes the function N^P mod M.

@@ -834,8 +834,8 @@
- - + +

Returns the initialization vector to be used in the next @@ -847,7 +847,7 @@ - +

Computes a POLY1305 message authentication code (Mac) from Data using @@ -856,7 +856,7 @@ - + Decrypts CipherText using the private Key.

Decrypts the CipherText, encrypted with @@ -870,7 +870,7 @@ - + Encrypts PlainText using the private Key.

Encrypts the PlainText using the PrivateKey @@ -883,7 +883,7 @@ - + Decrypts CipherText using the public Key.

Decrypts the CipherText, encrypted with @@ -897,7 +897,7 @@ - + Encrypts PlainText using the public Key.

Encrypts the PlainText (message digest) using the PublicKey @@ -909,7 +909,7 @@ - + Set the seed for random bytes generation

Set the seed for PRNG to the given binary. This calls the @@ -951,7 +951,7 @@ - + Generate a binary of random bytes

Generates N bytes randomly uniform 0..255, and returns the @@ -964,7 +964,7 @@ - + Strong random number generation plugin state

@@ -992,7 +992,7 @@ _FloatValue = rand:uniform(). % [0.0; 1.0[ - + Strong random number generation plugin state

@@ -1027,7 +1027,7 @@ _FloatValue = rand:uniform(). % [0.0; 1.0[ - rand_seed_alg(Alg) -> rand:state() + rand_seed_alg(Alg) -> rand:state() Strong random number generation plugin state Alg = crypto | crypto_cache @@ -1063,7 +1063,7 @@ _FloatValue = rand:uniform(). % [0.0; 1.0[ - rand_seed_alg_s(Alg) -> rand:state() + rand_seed_alg_s(Alg) -> rand:state() Strong random number generation plugin state Alg = crypto | crypto_cache @@ -1121,7 +1121,7 @@ _FloatValue = rand:uniform(). % [0.0; 1.0[ - +

Initializes the state for use in RC4 stream encryption @@ -1134,7 +1134,7 @@ _FloatValue = rand:uniform(). % [0.0; 1.0[ - +

Initializes the state for use in streaming AES encryption using Counter mode (CTR). @@ -1149,7 +1149,7 @@ _FloatValue = rand:uniform(). % [0.0; 1.0[ - +

Encrypts PlainText according to the stream cipher Type specified in stream_init/3. @@ -1160,7 +1160,7 @@ _FloatValue = rand:uniform(). % [0.0; 1.0[ - +

Decrypts CipherText according to the stream cipher Type specified in stream_init/3. @@ -1171,7 +1171,7 @@ _FloatValue = rand:uniform(). % [0.0; 1.0[ - + Provide a list of available crypto algorithms.

Can be used to determine which crypto algorithms that are supported @@ -1183,7 +1183,7 @@ _FloatValue = rand:uniform(). % [0.0; 1.0[ - + Provide a list of available named elliptic curves.

Can be used to determine which named elliptic curves are supported.

@@ -1191,7 +1191,7 @@ _FloatValue = rand:uniform(). % [0.0; 1.0[
- + Get the defining parameters of a elliptic curve.

Return the defining parameters of a elliptic curve.

@@ -1199,8 +1199,8 @@ _FloatValue = rand:uniform(). % [0.0; 1.0[
- - + + Create digital signature.

Creates a digital signature.

@@ -1214,8 +1214,8 @@ _FloatValue = rand:uniform(). % [0.0; 1.0[
- - + + Verifies a digital signature.

Verifies a digital signature

@@ -1231,7 +1231,7 @@ _FloatValue = rand:uniform(). % [0.0; 1.0[ - + Fetches a public key from an Engine stored private key.

Fetches the corresponding public key from a private key stored in an Engine. @@ -1241,7 +1241,7 @@ _FloatValue = rand:uniform(). % [0.0; 1.0[ - + Return list of all possible engine methods

@@ -1259,7 +1259,7 @@ _FloatValue = rand:uniform(). % [0.0; 1.0[ - + Dynamical load an encryption engine

@@ -1281,7 +1281,7 @@ _FloatValue = rand:uniform(). % [0.0; 1.0[ - + Dynamical load an encryption engine

@@ -1301,7 +1301,7 @@ _FloatValue = rand:uniform(). % [0.0; 1.0[ - + Dynamical load an encryption engine

@@ -1321,7 +1321,7 @@ _FloatValue = rand:uniform(). % [0.0; 1.0[ - + Get a reference to an already loaded engine

@@ -1341,7 +1341,7 @@ _FloatValue = rand:uniform(). % [0.0; 1.0[ - + Sends ctrl commands to an OpenSSL engine

@@ -1358,7 +1358,7 @@ _FloatValue = rand:uniform(). % [0.0; 1.0[ - + Sends ctrl commands to an OpenSSL engine

@@ -1379,7 +1379,7 @@ _FloatValue = rand:uniform(). % [0.0; 1.0[ - + Add engine to OpenSSL internal list

Add the engine to OpenSSL's internal list.

@@ -1392,7 +1392,7 @@ _FloatValue = rand:uniform(). % [0.0; 1.0[
- + Remove engine to OpenSSL internal list

Remove the engine from OpenSSL's internal list.

@@ -1405,7 +1405,7 @@ _FloatValue = rand:uniform(). % [0.0; 1.0[
- + Fetch engine ID

Return the ID for the engine, or an empty binary if there is no id set.

@@ -1418,7 +1418,7 @@ _FloatValue = rand:uniform(). % [0.0; 1.0[
- + Fetch engine name

Return the name (eg a description) for the engine, or an empty binary if there is no name set.

@@ -1431,7 +1431,7 @@ _FloatValue = rand:uniform(). % [0.0; 1.0[
- + List the known engine ids

List the id's of all engines in OpenSSL's internal list.

@@ -1451,7 +1451,7 @@ _FloatValue = rand:uniform(). % [0.0; 1.0[
- + Ensure encryption engine just loaded once

@@ -1473,7 +1473,7 @@ _FloatValue = rand:uniform(). % [0.0; 1.0[ - + Ensure encryption engine just loaded once

@@ -1496,7 +1496,7 @@ _FloatValue = rand:uniform(). % [0.0; 1.0[ - + Unload an engine loaded with the ensure function

@@ -1519,7 +1519,7 @@ _FloatValue = rand:uniform(). % [0.0; 1.0[ - + Unload an engine loaded with the ensure function

diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml index dfa4c803ed..0a0194af2d 100644 --- a/lib/diameter/doc/src/diameter.xml +++ b/lib/diameter/doc/src/diameter.xml @@ -55,7 +55,7 @@ limitations under the License. -diameter +diameter Main API of the diameter application. @@ -1574,7 +1574,7 @@ identifies the configuration.

-add_transport(SvcName, {connect|listen, [Opt]}) +add_transport(SvcName, {connect|listen, [Opt]}) -> {ok, Ref} | {error, Reason} Add transport capability to a service. @@ -1624,7 +1624,7 @@ its transports.

-call(SvcName, App, Request, [Opt]) -> Answer | ok | {error, Reason} +call(SvcName, App, Request, [Opt]) -> Answer | ok | {error, Reason} Send a Diameter request message. SvcName = &service_name; @@ -1730,7 +1730,7 @@ transport connection.

-origin_state_id() -> &dict_Unsigned32; +origin_state_id() -> &dict_Unsigned32; Returns a reasonable Origin-State-Id.

@@ -1748,7 +1748,7 @@ at the time the diameter application was started.

-remove_transport(SvcName, Pred) -> ok | {error, Reason} +remove_transport(SvcName, Pred) -> ok | {error, Reason} Remove previously added transports. SvcName = &service_name; @@ -1795,7 +1795,7 @@ configured on the transport.

-service_info(SvcName, Info) -> term() +service_info(SvcName, Info) -> term() Return information about a started service. SvcName = &service_name; @@ -2114,7 +2114,7 @@ For example:

-services() -> [SvcName] +services() -> [SvcName] Return the list of started services. SvcName = &service_name; @@ -2129,7 +2129,7 @@ Return the list of started services.

-session_id(Ident) -> &dict_OctetString; +session_id(Ident) -> &dict_OctetString; Return a value for a Session-Id AVP. Ident = &dict_DiameterIdentity; @@ -2148,7 +2148,7 @@ the message containing the returned value will be sent.

-start() -> ok | {error, Reason} +start() -> ok | {error, Reason} Start the diameter application.

@@ -2164,7 +2164,7 @@ file, not by calling start/0 explicitly.

-start_service(SvcName, Options) -> ok | {error, Reason} +start_service(SvcName, Options) -> ok | {error, Reason} Start a Diameter service. SvcName = &service_name; @@ -2194,7 +2194,7 @@ necessarily the case.

-stop() -> ok | {error, Reason} +stop() -> ok | {error, Reason} Stop the diameter application.

@@ -2208,7 +2208,7 @@ Stop the diameter application.

-stop_service(SvcName) -> ok | {error, Reason} +stop_service(SvcName) -> ok | {error, Reason} Stop a Diameter service. SvcName = &service_name; @@ -2236,7 +2236,7 @@ be called to remove transport configuration.

-subscribe(SvcName) -> true +subscribe(SvcName) -> true Subscribe to event messages. SvcName = &service_name; @@ -2258,7 +2258,7 @@ reception of all transport-related events.

-unsubscribe(SvcName) -> true +unsubscribe(SvcName) -> true Unsubscribe to event messages. SvcName = &service_name; diff --git a/lib/diameter/doc/src/diameter_app.xml b/lib/diameter/doc/src/diameter_app.xml index aa334beb21..82e3d449ef 100644 --- a/lib/diameter/doc/src/diameter_app.xml +++ b/lib/diameter/doc/src/diameter_app.xml @@ -44,7 +44,7 @@ limitations under the License. -diameter_app +diameter_app Callback module of a Diameter application. @@ -180,7 +180,7 @@ process.

-Mod:peer_up(SvcName, Peer, State) -> NewState +Mod:peer_up(SvcName, Peer, State) -> NewState Invoked when a transport connection has been established SvcName = &mod_service_name; @@ -215,7 +215,7 @@ handled independently of &peer_up; and &peer_down;.

-Mod:peer_down(SvcName, Peer, State) -> NewState +Mod:peer_down(SvcName, Peer, State) -> NewState Invoked when a transport connection has been lost. SvcName = &mod_service_name; @@ -234,7 +234,7 @@ candidate in &pick_peer; callbacks.

-Mod:pick_peer(LocalCandidates, RemoteCandidates, SvcName, State) +Mod:pick_peer(LocalCandidates, RemoteCandidates, SvcName, State) -> Selection | false Select a target peer for an outgoing request. @@ -311,7 +311,7 @@ or &peer_down; callback.

-Mod:prepare_request(Packet, SvcName, Peer) -> Action +Mod:prepare_request(Packet, SvcName, Peer) -> Action Return a request for encoding and transport. Packet = &packet; @@ -363,7 +363,7 @@ discarded}.

-Mod:prepare_retransmit(Packet, SvcName, Peer) -> Action +Mod:prepare_retransmit(Packet, SvcName, Peer) -> Action Return a request for encoding and retransmission. Packet = &packet; @@ -393,7 +393,7 @@ discarded}.

-Mod:handle_answer(Packet, Request, SvcName, Peer) -> Result +Mod:handle_answer(Packet, Request, SvcName, Peer) -> Result Receive an answer message from a peer. Packet = &packet; @@ -437,7 +437,7 @@ The &mod_application_opt; -Mod:handle_error(Reason, Request, SvcName, Peer) -> Result +Mod:handle_error(Reason, Request, SvcName, Peer) -> Result Return an error from a outgoing request. Reason = timeout | failover | term() @@ -465,7 +465,7 @@ not selected.

-Mod:handle_request(Packet, SvcName, Peer) -> Action +Mod:handle_request(Packet, SvcName, Peer) -> Action Receive an incoming request. Packet = &packet; diff --git a/lib/diameter/doc/src/diameter_codec.xml b/lib/diameter/doc/src/diameter_codec.xml index 0a34dd7ec7..0384ad2913 100644 --- a/lib/diameter/doc/src/diameter_codec.xml +++ b/lib/diameter/doc/src/diameter_codec.xml @@ -46,7 +46,7 @@ limitations under the License. diameter_codec.xml -diameter_codec +diameter_codec Decode and encode of Diameter messages. @@ -346,7 +346,7 @@ question, as documented in &man_transport;.

-decode(Mod, Bin) -> Pkt +decode(Mod, Bin) -> Pkt Decode a Diameter message. Mod = &dictionary; @@ -362,7 +362,7 @@ Decode a Diameter message.

-encode(Mod, Msg) -> Pkt +encode(Mod, Msg) -> Pkt Encode a Diameter message. Mod = &dictionary; diff --git a/lib/diameter/doc/src/diameter_make.xml b/lib/diameter/doc/src/diameter_make.xml index 112355816f..57e83bbca1 100644 --- a/lib/diameter/doc/src/diameter_make.xml +++ b/lib/diameter/doc/src/diameter_make.xml @@ -45,7 +45,7 @@ limitations under the License. diameter_make.xml -diameter_make +diameter_make Diameter dictionary compilation. @@ -67,7 +67,7 @@ interface.

-codec(File :: iolist() | binary(), [Opt]) -> ok +codec(File :: iolist() | binary(), [Opt]) -> ok | {ok, [Out]} | {error, Reason} Compile a dictionary file into Erlang source. @@ -186,7 +186,7 @@ A returned error reason can be converted into a readable string using -format(Parsed) -> iolist() +format(Parsed) -> iolist() Format a parsed dictionary.

@@ -198,7 +198,7 @@ dictionary format.

-flatten(Parsed) -> term() +flatten(Parsed) -> term() Flatten a parsed dictionary. @@ -214,7 +214,7 @@ The return value is also a parsed dictionary.

-format_error(Reason) -> string() +format_error(Reason) -> string() Turn an error reason into a readable string. diff --git a/lib/diameter/doc/src/diameter_sctp.xml b/lib/diameter/doc/src/diameter_sctp.xml index 62e958870e..2cf924ee6b 100644 --- a/lib/diameter/doc/src/diameter_sctp.xml +++ b/lib/diameter/doc/src/diameter_sctp.xml @@ -47,7 +47,7 @@ limitations under the License. diameter_sctp.xml -diameter_sctp +diameter_sctp Diameter transport over SCTP. @@ -67,7 +67,7 @@ and implements the behaviour documented in -start({Type, Ref}, Svc, [Opt]) +start({Type, Ref}, Svc, [Opt]) -> {ok, Pid, [LAddr]} | {error, Reason} Start a transport process. diff --git a/lib/diameter/doc/src/diameter_tcp.xml b/lib/diameter/doc/src/diameter_tcp.xml index 9f84eeb9fd..fe0cb2d067 100644 --- a/lib/diameter/doc/src/diameter_tcp.xml +++ b/lib/diameter/doc/src/diameter_tcp.xml @@ -57,7 +57,7 @@ limitations under the License. diameter_tcp.xml -diameter_tcp +diameter_tcp Diameter transport over TCP. @@ -83,7 +83,7 @@ before configuring TLS capability on diameter transports.

-start({Type, Ref}, Svc, [Opt]) +start({Type, Ref}, Svc, [Opt]) -> {ok, Pid} | {ok, Pid, [LAddr]} | {error, Reason} diff --git a/lib/diameter/doc/src/diameter_transport.xml b/lib/diameter/doc/src/diameter_transport.xml index 294e8a8864..67fd54bc56 100644 --- a/lib/diameter/doc/src/diameter_transport.xml +++ b/lib/diameter/doc/src/diameter_transport.xml @@ -43,7 +43,7 @@ limitations under the License. diameter_transport.xml -diameter_transport +diameter_transport Diameter transport interface. @@ -94,7 +94,7 @@ and has the binary() to send in its bin field.

-Mod:start({Type, Ref}, Svc, Config) +Mod:start({Type, Ref}, Svc, Config) -> {ok, Pid} | {ok, Pid, LAddrs} | {error, Reason} diff --git a/lib/eldap/doc/src/eldap.xml b/lib/eldap/doc/src/eldap.xml index f2c7889e58..790a2f4e26 100644 --- a/lib/eldap/doc/src/eldap.xml +++ b/lib/eldap/doc/src/eldap.xml @@ -28,7 +28,7 @@ 2000-06-20 B - eldap + eldap LDAP Client

This module provides a client api to the Lightweight Directory Access Protocol (LDAP). @@ -103,7 +103,7 @@ - open([Host]) -> {ok, Handle} | {error, Reason} + open([Host]) -> {ok, Handle} | {error, Reason} Open a connection to an LDAP server. Handle = handle() @@ -113,7 +113,7 @@ - open([Host], [Option]) -> {ok, Handle} | {error, Reason} + open([Host], [Option]) -> {ok, Handle} | {error, Reason} Open a connection to an LDAP server. Handle = handle() @@ -129,7 +129,7 @@ - close(Handle) -> ok + close(Handle) -> ok Shutdown the connection. Handle = handle() @@ -140,14 +140,14 @@ - start_tls(Handle, Options) -> return_value() + start_tls(Handle, Options) -> return_value() Upgrade a connection to TLS.

Same as start_tls(Handle, Options, infinity)

- start_tls(Handle, Options, Timeout) -> return_value() + start_tls(Handle, Options, Timeout) -> return_value() Upgrade a connection to TLS. Handle = handle() @@ -176,7 +176,7 @@
- simple_bind(Handle, Dn, Password) -> return_value() + simple_bind(Handle, Dn, Password) -> return_value() Authenticate the connection. Handle = handle() @@ -188,7 +188,7 @@
- add(Handle, Dn, [Attribute]) -> return_value() + add(Handle, Dn, [Attribute]) -> return_value() Add an entry. Handle = handle() @@ -209,7 +209,7 @@
- delete(Handle, Dn) -> return_value() + delete(Handle, Dn) -> return_value() Delete an entry. Dn = string() @@ -223,7 +223,7 @@ - mod_add(Type, [Value]) -> modify_op() + mod_add(Type, [Value]) -> modify_op() Create a modification operation. Type = string() @@ -232,7 +232,7 @@

Create an add modification operation.

- mod_delete(Type, [Value]) -> modify_op() + mod_delete(Type, [Value]) -> modify_op() Create a modification operation. Type = string() @@ -241,7 +241,7 @@

Create a delete modification operation.

- mod_replace(Type, [Value]) -> modify_op() + mod_replace(Type, [Value]) -> modify_op() Create a modification operation. Type = string() @@ -251,7 +251,7 @@ - modify(Handle, Dn, [ModifyOp]) -> return_value() + modify(Handle, Dn, [ModifyOp]) -> return_value() Modify an entry. Dn = string() @@ -267,7 +267,7 @@
- modify_password(Handle, Dn, NewPasswd) -> return_value() | {ok, GenPasswd} + modify_password(Handle, Dn, NewPasswd) -> return_value() | {ok, GenPasswd} Modify the password of a user. Dn = string() @@ -278,7 +278,7 @@
- modify_password(Handle, Dn, NewPasswd, OldPasswd) -> return_value() | {ok, GenPasswd} + modify_password(Handle, Dn, NewPasswd, OldPasswd) -> return_value() | {ok, GenPasswd} Modify the password of a user. Dn = string() @@ -307,7 +307,7 @@
- modify_dn(Handle, Dn, NewRDN, DeleteOldRDN, NewSupDN) -> return_value() + modify_dn(Handle, Dn, NewRDN, DeleteOldRDN, NewSupDN) -> return_value() Modify the DN of an entry. Dn = string() @@ -327,7 +327,7 @@
- search(Handle, SearchOptions) -> {ok, #eldap_search_result{}} | {ok, {referral,referrals()}} | {error, Reason} + search(Handle, SearchOptions) -> {ok, #eldap_search_result{}} | {ok, {referral,referrals()}} | {error, Reason} Search the Directory SearchOptions = #eldap_search{} | [SearchOption] @@ -354,44 +354,44 @@ - baseObject() -> scope() + baseObject() -> scope() Create search scope.

Search baseobject only.

- singleLevel() -> scope() + singleLevel() -> scope() Create search scope.

Search the specified level only, i.e. do not recurse.

- wholeSubtree() -> scope() + wholeSubtree() -> scope() Create search scope.

Search the entire subtree.

- neverDerefAliases() -> dereference() + neverDerefAliases() -> dereference() Create search option.

Never derefrence aliases, treat aliases as entries.

- derefAlways() -> dereference() + derefAlways() -> dereference() Create search option.

Always derefrence aliases.

- derefInSearching() -> dereference() + derefInSearching() -> dereference() Create search option.

Derefrence aliases only when searching.

- derefFindingBaseObj() -> dereference() + derefFindingBaseObj() -> dereference() Create search option.

Derefrence aliases only in finding the base.

- present(Type) -> filter() + present(Type) -> filter() Create search filter option. Type = string() @@ -399,7 +399,7 @@

Create a filter which filters on attribute type presence.

- substrings(Type, [SubString]) -> filter() + substrings(Type, [SubString]) -> filter() Create search filter option. Type = string() @@ -409,7 +409,7 @@

Create a filter which filters on substrings.

- equalityMatch(Type, Value) -> filter() + equalityMatch(Type, Value) -> filter() Create search filter option. Type = string() @@ -418,7 +418,7 @@

Create a equality filter.

- greaterOrEqual(Type, Value) -> filter() + greaterOrEqual(Type, Value) -> filter() Create search filter option. Type = string() @@ -427,7 +427,7 @@

Create a greater or equal filter.

- lessOrEqual(Type, Value) -> filter() + lessOrEqual(Type, Value) -> filter() Create search filter option. Type = string() @@ -436,7 +436,7 @@

Create a less or equal filter.

- approxMatch(Type, Value) -> filter() + approxMatch(Type, Value) -> filter() Create search filter option. Type = string() @@ -445,7 +445,7 @@

Create a approximation match filter.

- extensibleMatch(MatchValue, OptionalAttrs) -> filter() + extensibleMatch(MatchValue, OptionalAttrs) -> filter() Create search filter option. MatchValue = string() @@ -459,7 +459,7 @@

creates a filter which performs a caseExactMatch on the attribute sn and matches with the value "Bar". The default value of dnAttributes is false.

- 'and'([Filter]) -> filter() + 'and'([Filter]) -> filter() Create search filter option. Filter = filter() @@ -467,7 +467,7 @@

Creates a filter where all Filter must be true.

- 'or'([Filter]) -> filter() + 'or'([Filter]) -> filter() Create search filter option. Filter = filter() @@ -475,7 +475,7 @@

Create a filter where at least one of the Filter must be true.

- 'not'(Filter) -> filter() + 'not'(Filter) -> filter() Create search filter option. Filter = filter() diff --git a/lib/erl_docgen/doc/src/docgen_xml_check.xml b/lib/erl_docgen/doc/src/docgen_xml_check.xml index 68253edef7..8d6dceef43 100644 --- a/lib/erl_docgen/doc/src/docgen_xml_check.xml +++ b/lib/erl_docgen/doc/src/docgen_xml_check.xml @@ -30,7 +30,7 @@ - docgen_xml_check + docgen_xml_check Validate XML documentation source code

docgen_xml_check contains functions for validating XML @@ -39,7 +39,7 @@ - validate(File) -> ok | error | {error, badfile} + validate(File) -> ok | error | {error, badfile} Validate XML source code. File = string() diff --git a/lib/erl_interface/doc/src/ei.xml b/lib/erl_interface/doc/src/ei.xml index 9502fb1ee7..2a17643270 100644 --- a/lib/erl_interface/doc/src/ei.xml +++ b/lib/erl_interface/doc/src/ei.xml @@ -134,7 +134,7 @@ typedef enum { - intei_decode_atom_as(const char *buf, int *index, char *p, int plen, erlang_char_encoding want, erlang_char_encoding* was, erlang_char_encoding* result) + intei_decode_atom_as(const char *buf, int *index, char *p, int plen, erlang_char_encoding want, erlang_char_encoding* was, erlang_char_encoding* result) Decode an atom.

Decodes an atom from the binary format. The NULL-terminated @@ -286,7 +286,7 @@ typedef enum { - intei_decode_map_header(const char *buf, int *index, int *arity) + intei_decode_map_header(const char *buf, int *index, int *arity) Decode a map.

Decodes a map header from the binary @@ -415,10 +415,10 @@ typedef enum { - intei_encode_atom_as(char *buf, int *index, const char *p, erlang_char_encoding from_enc, erlang_char_encoding to_enc) - intei_encode_atom_len_as(char *buf, int *index, const char *p, int len, erlang_char_encoding from_enc, erlang_char_encoding to_enc) - intei_x_encode_atom_as(ei_x_buff* x, const char *p, erlang_char_encoding from_enc, erlang_char_encoding to_enc) - intei_x_encode_atom_len_as(ei_x_buff* x, const char *p, int len, erlang_char_encoding from_enc, erlang_char_encoding to_enc) + intei_encode_atom_as(char *buf, int *index, const char *p, erlang_char_encoding from_enc, erlang_char_encoding to_enc) + intei_encode_atom_len_as(char *buf, int *index, const char *p, int len, erlang_char_encoding from_enc, erlang_char_encoding to_enc) + intei_x_encode_atom_as(ei_x_buff* x, const char *p, erlang_char_encoding from_enc, erlang_char_encoding to_enc) + intei_x_encode_atom_len_as(ei_x_buff* x, const char *p, int len, erlang_char_encoding from_enc, erlang_char_encoding to_enc) Encode an atom.

Encodes an atom in the binary format. Parameter p is the name of the atom with @@ -574,8 +574,8 @@ ei_x_encode_empty_list(&x); - intei_encode_map_header(char *buf, int *index, int arity) - intei_x_encode_map_header(ei_x_buff* x, int arity) + intei_encode_map_header(char *buf, int *index, int arity) + intei_x_encode_map_header(ei_x_buff* x, int arity) Encode a map.

Encodes a map header, with a specified arity. The next diff --git a/lib/erl_interface/doc/src/ei_connect.xml b/lib/erl_interface/doc/src/ei_connect.xml index d5a55087a3..9c35b75db3 100644 --- a/lib/erl_interface/doc/src/ei_connect.xml +++ b/lib/erl_interface/doc/src/ei_connect.xml @@ -286,8 +286,8 @@ if (ei_connect_init(&ec, "madonna", "cookie...", n++) < 0) { - intei_get_tracelevel(void) - voidei_set_tracelevel(int level) + intei_get_tracelevel(void) + voidei_set_tracelevel(int level) Get and set functions for tracing.

Used to set tracing on the distribution. The levels are different diff --git a/lib/et/doc/src/et.xml b/lib/et/doc/src/et.xml index 3009b559e1..ec7381f633 100644 --- a/lib/et/doc/src/et.xml +++ b/lib/et/doc/src/et.xml @@ -39,7 +39,7 @@ - trace_me(DetailLevel, From, To, Label, Contents) -> hopefully_traced + trace_me(DetailLevel, From, To, Label, Contents) -> hopefully_traced A function that is intended to be traced. DetailLevel = integer(X) when X =< 0, X >= 100 @@ -70,7 +70,7 @@ - trace_me(DetailLevel, FromTo, Label, Contents) -> hopefully_traced + trace_me(DetailLevel, FromTo, Label, Contents) -> hopefully_traced A function that is intended to be traced.

Invokes et:trace_me/5 with both From and To diff --git a/lib/ftp/doc/src/ftp.xml b/lib/ftp/doc/src/ftp.xml index 34e3ff84b0..21bb7cd133 100644 --- a/lib/ftp/doc/src/ftp.xml +++ b/lib/ftp/doc/src/ftp.xml @@ -801,7 +801,7 @@ - start_service(ServiceConfig) -> {ok, Pid} | {error, Reason} + start_service(ServiceConfig) -> {ok, Pid} | {error, Reason} Dynamically starts an FTP session after the ftp application has been started. @@ -820,7 +820,7 @@ - stop_service(Reference) -> ok | {error, Reason} + stop_service(Reference) -> ok | {error, Reason} Stops an FTP session. Reference = pid() | term() - service-specified reference diff --git a/lib/inets/doc/src/http_uri.xml b/lib/inets/doc/src/http_uri.xml index 2dec5acbf9..6d3547f4fe 100644 --- a/lib/inets/doc/src/http_uri.xml +++ b/lib/inets/doc/src/http_uri.xml @@ -30,7 +30,7 @@ - http_uri + http_uri URI utility module @@ -79,7 +79,7 @@ - decode(HexEncodedURI) -> URI + decode(HexEncodedURI) -> URI Decodes a hexadecimal encoded URI. @@ -93,7 +93,7 @@ - encode(URI) -> HexEncodedURI + encode(URI) -> HexEncodedURI Encodes a hexadecimal encoded URI. @@ -109,8 +109,8 @@ - parse(URI) -> {ok, Result} | {error, Reason} - parse(URI, Options) -> {ok, Result} | {error, Reason} + parse(URI) -> {ok, Result} | {error, Reason} + parse(URI, Options) -> {ok, Result} | {error, Reason} Parses a URI. URI = uri() @@ -165,7 +165,7 @@ fun(SchemeStr :: string() | binary()) -> - scheme_defaults() -> SchemeDefaults + scheme_defaults() -> SchemeDefaults A list of the scheme and their default ports. SchemeDefaults = [{scheme(), default_scheme_port_number()}] diff --git a/lib/inets/doc/src/httpc.xml b/lib/inets/doc/src/httpc.xml index a2871f3b95..7451b314ec 100644 --- a/lib/inets/doc/src/httpc.xml +++ b/lib/inets/doc/src/httpc.xml @@ -30,7 +30,7 @@ - httpc + httpc An HTTP/1.1 client @@ -151,8 +151,8 @@ - cancel_request(RequestId) -> - cancel_request(RequestId, Profile) -> ok + cancel_request(RequestId) -> + cancel_request(RequestId, Profile) -> ok Cancels an asynchronous HTTP request. RequestId = request_id() - A unique identifier as returned @@ -169,9 +169,9 @@ - cookie_header(Url) -> - cookie_header(Url, Profile | Opts) -> header() | {error, Reason} - cookie_header(Url, Opts, Profile) -> header() | {error, Reason} + cookie_header(Url) -> + cookie_header(Url, Profile | Opts) -> header() | {error, Reason} + cookie_header(Url, Opts, Profile) -> header() | {error, Reason} Returns the cookie header that would have been sent when making a request to URL using the profile Profile. @@ -193,8 +193,8 @@ - get_options(OptionItems) -> {ok, Values} | {error, Reason} - get_options(OptionItems, Profile) -> {ok, Values} | {error, Reason} + get_options(OptionItems) -> {ok, Values} | {error, Reason} + get_options(OptionItems, Profile) -> {ok, Values} | {error, Reason} Gets the currently used options. OptionItems = all | [option_item()] @@ -223,8 +223,8 @@ - info() -> list() - info(Profile) -> list() + info() -> list() + info(Profile) -> list() Produces a list of miscellaneous information. Profile = profile() | pid() @@ -239,8 +239,8 @@ - reset_cookies() -> void() - reset_cookies(Profile) -> void() + reset_cookies() -> void() + reset_cookies(Profile) -> void() Resets the cookie database. Profile = profile() | pid() @@ -254,8 +254,8 @@ - request(Url) -> - request(Url, Profile) -> {ok, Result} | {error, Reason} + request(Url) -> + request(Url, Profile) -> {ok, Result} | {error, Reason} Sends a get HTTP request. Url = url() @@ -272,8 +272,8 @@ - request(Method, Request, HTTPOptions, Options) -> - request(Method, Request, HTTPOptions, Options, Profile) -> {ok, Result} | {ok, saved_to_file} | {error, Reason} + request(Method, Request, HTTPOptions, Options) -> + request(Method, Request, HTTPOptions, Options, Profile) -> {ok, Result} | {ok, saved_to_file} | {error, Reason} Sends an HTTP request. @@ -521,8 +521,8 @@ - set_options(Options) -> - set_options(Options, Profile) -> ok | {error, Reason} + set_options(Options) -> + set_options(Options, Profile) -> ok | {error, Reason} Sets options to be used for subsequent requests. Options = [Option] @@ -639,8 +639,8 @@ - store_cookies(SetCookieHeaders, Url) -> - store_cookies(SetCookieHeaders, Url, Profile) -> ok | {error, Reason} + store_cookies(SetCookieHeaders, Url) -> + store_cookies(SetCookieHeaders, Url, Profile) -> ok | {error, Reason} Saves the cookies defined in SetCookieHeaders in the client profile cookie database. @@ -658,7 +658,7 @@ - stream_next(Pid) -> ok + stream_next(Pid) -> ok Triggers the next message to be streamed, that is, the same behavior as active one for sockets. @@ -676,8 +676,8 @@ - which_cookies() -> cookies() - which_cookies(Profile) -> cookies() + which_cookies() -> cookies() + which_cookies(Profile) -> cookies() Dumps the entire cookie database. Profile = profile() | pid() @@ -695,8 +695,8 @@ - which_sessions() -> session_info() - which_sessions(Profile) -> session_info() + which_sessions() -> session_info() + which_sessions(Profile) -> session_info() Produces a slightly processed dump of the sessions database. Profile = profile() | pid() diff --git a/lib/inets/doc/src/httpd.xml b/lib/inets/doc/src/httpd.xml index 2c70c2b050..1a203fae90 100644 --- a/lib/inets/doc/src/httpd.xml +++ b/lib/inets/doc/src/httpd.xml @@ -901,7 +901,7 @@ text/plain asc txt info(Address, Port) -> info(Address, Port, Profile) -> - info(Address, Port, Profile, Properties) -> [{Option, Value}] + info(Address, Port, Profile, Properties) -> [{Option, Value}] info(Address, Port, Properties) -> [{Option, Value}] Fetches information about the HTTP server. diff --git a/lib/inets/doc/src/httpd_custom_api.xml b/lib/inets/doc/src/httpd_custom_api.xml index d2e5441895..2c0f92ff83 100644 --- a/lib/inets/doc/src/httpd_custom_api.xml +++ b/lib/inets/doc/src/httpd_custom_api.xml @@ -25,7 +25,7 @@ httpd_custom_api httpd_custom_api.xml - httpd_custom_api + httpd_custom_api Behaviour with optional callbacks to customize the inets HTTP server.

The module implementing this behaviour shall be supplied to to the servers @@ -34,7 +34,7 @@ - response_default_headers() -> [Header] + response_default_headers() -> [Header] Provide default headers for the HTTP servers responses. Header = {HeaderName :: string(), HeaderValue::string()} @@ -48,7 +48,7 @@ - response_header({HeaderName, HeaderValue}) -> {true, Header} | false + response_header({HeaderName, HeaderValue}) -> {true, Header} | false Filter and possible alter HTTP response headers. Header = {HeaderName :: string(), HeaderValue::string()} @@ -61,7 +61,7 @@ - request_header({HeaderName, HeaderValue}) -> {true, Header} | false + request_header({HeaderName, HeaderValue}) -> {true, Header} | false Filter and possible alter HTTP request headers. Header = {HeaderName :: string(), HeaderValue::string()} diff --git a/lib/inets/doc/src/mod_auth.xml b/lib/inets/doc/src/mod_auth.xml index c4f844622b..6400444601 100644 --- a/lib/inets/doc/src/mod_auth.xml +++ b/lib/inets/doc/src/mod_auth.xml @@ -241,7 +241,7 @@ list_users(Options) -> {ok, Users} | {error, Reason} - list_users(Port, Dir) -> {ok, Users} | {error, Reason} + list_users(Port, Dir) -> {ok, Users} | {error, Reason} list_users(Address, Port, Dir) -> {ok, Users} | {error, Reason} Lists users in the user database. diff --git a/lib/inets/doc/src/mod_security.xml b/lib/inets/doc/src/mod_security.xml index 6f3f3c048a..340705f697 100644 --- a/lib/inets/doc/src/mod_security.xml +++ b/lib/inets/doc/src/mod_security.xml @@ -129,8 +129,8 @@ - Module:event(What, Port, Dir, Data) -> ignored - Module:event(What, Address, Port, Dir, Data) -> ignored + Module:event(What, Port, Dir, Data) -> ignored + Module:event(What, Address, Port, Dir, Data) -> ignored Called whenever an event occurs in mod_security. What = atom() diff --git a/lib/kernel/doc/src/application.xml b/lib/kernel/doc/src/application.xml index 38c7b5acf1..ec5d081676 100644 --- a/lib/kernel/doc/src/application.xml +++ b/lib/kernel/doc/src/application.xml @@ -67,8 +67,8 @@ - - + + Load and start an application and its dependencies, recursively.

Equivalent to calling @@ -85,8 +85,8 @@ - - + + Load and start an application.

Equivalent to @@ -153,7 +153,7 @@ - + Get the value of a configuration parameter using a default.

Works like get_env/2 but returns diff --git a/lib/kernel/doc/src/code.xml b/lib/kernel/doc/src/code.xml index aff3e8133c..8dae6d90f3 100644 --- a/lib/kernel/doc/src/code.xml +++ b/lib/kernel/doc/src/code.xml @@ -507,7 +507,7 @@ zip:create("mnesia-4.4.7.ez", - + Load a list of modules atomically

Tries to load all of the modules in the list @@ -566,7 +566,7 @@ ok = code:finish_loading(Prepared), - + Prepare a list of modules atomically

Prepares to load the modules in the list @@ -598,7 +598,7 @@ ok = code:finish_loading(Prepared), - + Finish loading a list of prepared modules atomically

Tries to load code for all modules that have been previously @@ -627,7 +627,7 @@ ok = code:finish_loading(Prepared), - + Ensure that a list of modules is loaded

Tries to load any modules not already loaded in the list @@ -901,7 +901,7 @@ rpc:call(Node, code, load_binary, [Module, Filename, Binary]), - + Return the status of the module in relation to object file on disk.

Returns:

@@ -934,7 +934,7 @@ rpc:call(Node, code, load_binary, [Module, Filename, Binary]),
- + Return a list of all modules modified on disk.

Returns the list of all currently loaded modules for which @@ -961,7 +961,7 @@ rpc:call(Node, code, load_binary, [Module, Filename, Binary]), - + The mode of the code server.

Returns an atom describing the mode of the code server: diff --git a/lib/kernel/doc/src/erl_epmd.xml b/lib/kernel/doc/src/erl_epmd.xml index 8b076cd2d7..2adbf11a28 100644 --- a/lib/kernel/doc/src/erl_epmd.xml +++ b/lib/kernel/doc/src/erl_epmd.xml @@ -28,7 +28,7 @@ 2018-02-19 A - erl_epmd + erl_epmd Erlang interface towards epmd @@ -41,7 +41,7 @@ - + Callback for erl_distribution supervisor.

This function is invoked as this module is added as a child of the @@ -50,8 +50,8 @@ - - + + Registers the node with epmd.

Registers the node with epmd and tells epmd what port will be @@ -62,8 +62,8 @@ - - + + Returns the port number for a given node.

Requests the distribution port for the given node of an EPMD @@ -73,7 +73,7 @@ - + Returns address and port.

Called by the distribution module. Resolves the Host to an IP @@ -84,7 +84,7 @@ - + Names of Erlang nodes at a host.

Called by net_adm:names/0. diff --git a/lib/kernel/doc/src/error_handler.xml b/lib/kernel/doc/src/error_handler.xml index e5639487dc..28d15d0b67 100644 --- a/lib/kernel/doc/src/error_handler.xml +++ b/lib/kernel/doc/src/error_handler.xml @@ -38,7 +38,7 @@ - + Raise an undef exception. A (possibly empty) list of arguments Arg1,..,ArgN diff --git a/lib/kernel/doc/src/error_logger.xml b/lib/kernel/doc/src/error_logger.xml index c3d68fd79f..8cb3e2ce16 100644 --- a/lib/kernel/doc/src/error_logger.xml +++ b/lib/kernel/doc/src/error_logger.xml @@ -191,7 +191,7 @@ ok - + Get the value of the Kernel application variable error_logger_format_depth. diff --git a/lib/kernel/doc/src/file.xml b/lib/kernel/doc/src/file.xml index 9acaf6b41e..87ac8071c6 100644 --- a/lib/kernel/doc/src/file.xml +++ b/lib/kernel/doc/src/file.xml @@ -186,7 +186,7 @@ - + Predeclare an access pattern for file data. @@ -197,7 +197,7 @@ - + Allocate file space.

allocate/3 can be used to preallocate space for a file.

@@ -217,7 +217,7 @@
- + Change permissions of a file.

Changes permissions of a file. See @@ -346,7 +346,7 @@ f.txt: {person, "kalle", 25}. - + Synchronize the in-memory data of a file, ignoring most of its metadata, with that on the physical medium.

Ensures that any buffers kept by the operating system @@ -578,7 +578,7 @@ f.txt: {person, "kalle", 25}. - + List all files in a directory.

Lists all the files in a directory, @@ -702,7 +702,7 @@ f.txt: {person, "kalle", 25}. - + Return the configured filename encoding of the VM.

Returns @@ -1408,7 +1408,7 @@ f.txt: {person, "kalle", 25}. - + Retrieve information about a file.

Retrieves information about a file. Returns @@ -1649,7 +1649,7 @@ f.txt: {person, "kalle", 25}. - + See what a link is pointing to.

Returns {ok, Filename} if @@ -1678,7 +1678,7 @@ f.txt: {person, "kalle", 25}. - + Retrieve information about a link or file.

Works like @@ -1807,7 +1807,7 @@ f.txt: {person, "kalle", 25}. - + Send a file to a socket.

Sends the file Filename to Socket. @@ -1816,7 +1816,7 @@ f.txt: {person, "kalle", 25}. - + Send a file to a socket. @@ -1990,7 +1990,7 @@ f.txt: {person, "kalle", 25}. - + Change file information.

Changes file information. Returns ok if successful, diff --git a/lib/kernel/doc/src/gen_sctp.xml b/lib/kernel/doc/src/gen_sctp.xml index 1e08b25f66..591079aef8 100644 --- a/lib/kernel/doc/src/gen_sctp.xml +++ b/lib/kernel/doc/src/gen_sctp.xml @@ -213,7 +213,7 @@ connect(Socket, Ip, Port>, - + Same as connect_init(Socket, Addr, Port, Opts, infinity)..

Same as connect_init(Socket, Addr, @@ -222,7 +222,7 @@ connect(Socket, Ip, Port>, - + Initiate a new association for socket Socket, with a peer (SCTP server socket). @@ -366,7 +366,7 @@ connect(Socket, Ip, Port>, - + Peel off a type stream socket from a type seqpacket one. diff --git a/lib/kernel/doc/src/heart.xml b/lib/kernel/doc/src/heart.xml index ad1a2ffeb9..8c4fcbaacd 100644 --- a/lib/kernel/doc/src/heart.xml +++ b/lib/kernel/doc/src/heart.xml @@ -154,7 +154,7 @@ - + Set a validation callback

This validation callback will be executed before any @@ -166,14 +166,14 @@ - + Clear the validation callback

Removes the validation callback call before heartbeats.

- + Get the validation callback

Get the validation callback. If the callback is cleared, none will be returned.

@@ -181,7 +181,7 @@
- + Set a list of options

Valid options set_options are:

@@ -199,7 +199,7 @@
- + Get the temporary reboot command

Returns {ok, Options} where Options is a list of current options enabled for heart. diff --git a/lib/kernel/doc/src/inet.xml b/lib/kernel/doc/src/inet.xml index 87b08e4e36..8e7ca99084 100644 --- a/lib/kernel/doc/src/inet.xml +++ b/lib/kernel/doc/src/inet.xml @@ -394,7 +394,7 @@ fe80::204:acff:fe17:bf38 - + Return a list of interfaces and their addresses.

@@ -416,7 +416,7 @@ fe80::204:acff:fe17:bf38 - getifaddrs(Opts) -> + getifaddrs(Opts) -> {ok, [{Ifname, Ifopts}]} | {error, Posix} Return a list of interfaces and their addresses. @@ -586,9 +586,9 @@ get_tcpi_sacked(Sock) -> - - - + + + Displays information and statistics about sockets on the terminal

@@ -641,7 +641,7 @@ get_tcpi_sacked(Sock) -> - + Convert IPv6/IPV4 address to ASCII.

Parses an @@ -651,7 +651,7 @@ get_tcpi_sacked(Sock) -> - + Parse an IPv4 or IPv6 address.

Parses an IPv4 or IPv6 address string and returns an @@ -662,7 +662,7 @@ get_tcpi_sacked(Sock) -> - + Parse an IPv4 address.

Parses an IPv4 address string and returns an @@ -672,7 +672,7 @@ get_tcpi_sacked(Sock) -> - + Parse an IPv4 address strict.

Parses an IPv4 address string containing four fields, that is, @@ -683,7 +683,7 @@ get_tcpi_sacked(Sock) -> - + Parse an IPv6 address.

Parses an IPv6 address string and returns an @@ -694,7 +694,7 @@ get_tcpi_sacked(Sock) -> - + Parse an IPv6 address strict.

Parses an IPv6 address string and returns an @@ -704,7 +704,7 @@ get_tcpi_sacked(Sock) -> - + Convert to and from IPv4-mapped IPv6 address.

@@ -717,7 +717,7 @@ get_tcpi_sacked(Sock) -> - + Parse an IPv4 or IPv6 address strict.

Parses an IPv4 or IPv6 address string and returns an @@ -741,7 +741,7 @@ get_tcpi_sacked(Sock) -> - + Return all address/port numbers for the other end of a connection. @@ -755,7 +755,7 @@ get_tcpi_sacked(Sock) -> - + Return all address/port numbers for the other end of a connection. @@ -1499,7 +1499,7 @@ inet:setopts(Sock,[{raw,6,8,<<30:32/native>>}]),]]> - + Return all local address/port numbers for a socket.

Equivalent to @@ -1509,7 +1509,7 @@ inet:setopts(Sock,[{raw,6,8,<<30:32/native>>}]),]]> - + Return all local address/port numbers for a socket.

Returns a list of all local address/port number pairs for a socket diff --git a/lib/kernel/doc/src/logger.xml b/lib/kernel/doc/src/logger.xml index 556f25f96a..e09c5db5e3 100644 --- a/lib/kernel/doc/src/logger.xml +++ b/lib/kernel/doc/src/logger.xml @@ -32,7 +32,7 @@ A logger.xml - logger + logger API module for Logger, the standard logging facility in Erlang/OTP. @@ -334,9 +334,9 @@ logger:error("error happened because: ~p", [Reason]). % Without macro - emergency(StringOrReport[,Metadata]) - emergency(Format,Args[,Metadata]) - emergency(Fun,FunArgs[,Metadata]) + emergency(StringOrReport[,Metadata]) + emergency(Format,Args[,Metadata]) + emergency(Fun,FunArgs[,Metadata]) Logs the given message as level emergency.

Equivalent to @@ -345,9 +345,9 @@ logger:error("error happened because: ~p", [Reason]). % Without macro - alert(StringOrReport[,Metadata]) - alert(Format,Args[,Metadata]) - alert(Fun,FunArgs[,Metadata]) + alert(StringOrReport[,Metadata]) + alert(Format,Args[,Metadata]) + alert(Fun,FunArgs[,Metadata]) Logs the given message as level alert.

Equivalent to @@ -356,9 +356,9 @@ logger:error("error happened because: ~p", [Reason]). % Without macro - critical(StringOrReport[,Metadata]) - critical(Format,Args[,Metadata]) - critical(Fun,FunArgs[,Metadata]) + critical(StringOrReport[,Metadata]) + critical(Format,Args[,Metadata]) + critical(Fun,FunArgs[,Metadata]) Logs the given message as level critical.

Equivalent to @@ -367,9 +367,9 @@ logger:error("error happened because: ~p", [Reason]). % Without macro - error(StringOrReport[,Metadata]) - error(Format,Args[,Metadata]) - error(Fun,FunArgs[,Metadata]) + error(StringOrReport[,Metadata]) + error(Format,Args[,Metadata]) + error(Fun,FunArgs[,Metadata]) Logs the given message as level error.

Equivalent to @@ -378,9 +378,9 @@ logger:error("error happened because: ~p", [Reason]). % Without macro - warning(StringOrReport[,Metadata]) - warning(Format,Args[,Metadata]) - warning(Fun,FunArgs[,Metadata]) + warning(StringOrReport[,Metadata]) + warning(Format,Args[,Metadata]) + warning(Fun,FunArgs[,Metadata]) Logs the given message as level warning.

Equivalent to @@ -389,9 +389,9 @@ logger:error("error happened because: ~p", [Reason]). % Without macro - notice(StringOrReport[,Metadata]) - notice(Format,Args[,Metadata]) - notice(Fun,FunArgs[,Metadata]) + notice(StringOrReport[,Metadata]) + notice(Format,Args[,Metadata]) + notice(Fun,FunArgs[,Metadata]) Logs the given message as level notice.

Equivalent to @@ -400,9 +400,9 @@ logger:error("error happened because: ~p", [Reason]). % Without macro - info(StringOrReport[,Metadata]) - info(Format,Args[,Metadata]) - info(Fun,FunArgs[,Metadata]) + info(StringOrReport[,Metadata]) + info(Format,Args[,Metadata]) + info(Fun,FunArgs[,Metadata]) Logs the given message as level info.

Equivalent to @@ -411,9 +411,9 @@ logger:error("error happened because: ~p", [Reason]). % Without macro - debug(StringOrReport[,Metadata]) - debug(Format,Args[,Metadata]) - debug(Fun,FunArgs[,Metadata]) + debug(StringOrReport[,Metadata]) + debug(Format,Args[,Metadata]) + debug(Fun,FunArgs[,Metadata]) Logs the given message as level debug.

Equivalent to @@ -422,12 +422,12 @@ logger:error("error happened because: ~p", [Reason]). % Without macro - - - - - - + + + + + + Logs the given message. @@ -448,7 +448,7 @@ logger:error("error happened because: ~p", [Reason]). % Without macro - + Add a handler with the given configuration.

Add a handler with the given configuration.

@@ -459,7 +459,7 @@ logger:error("error happened because: ~p", [Reason]). % Without macro
- + Add a filter to the specified handler.

Add a filter to the specified handler.

@@ -500,7 +500,7 @@ logger:error("error happened because: ~p", [Reason]). % Without macro
- + Set up log handlers from the application's configuration parameters. @@ -510,7 +510,7 @@ logger:error("error happened because: ~p", [Reason]). % Without macro - + Setup logger handlers. @@ -553,7 +553,7 @@ start(_, []) -> - + Add a primary filter to Logger.

Add a primary filter to Logger.

@@ -594,7 +594,7 @@ start(_, []) ->
- + Look up the current Logger configuration

Look up all current Logger configuration, including primary @@ -603,7 +603,7 @@ start(_, []) -> - + Look up the current configuration for all handlers.

Look up the current configuration for all handlers.

@@ -611,7 +611,7 @@ start(_, []) ->
- + Look up the current configuration for the given handler. @@ -620,7 +620,7 @@ start(_, []) -> - + Look up the identities for all installed handlers.

Look up the identities for all installed handlers.

@@ -628,7 +628,7 @@ start(_, []) ->
- + Look up the current primary configuration for Logger.

Look up the current primary configuration for Logger.

@@ -636,7 +636,7 @@ start(_, []) ->
- + Look up all current module levels.

Look up all current module levels. Returns a list @@ -648,7 +648,7 @@ start(_, []) -> - + Look up the current level for the given modules.

Look up the current level for the given modules. Returns a @@ -660,7 +660,7 @@ start(_, []) -> - + Retrieve data set with set_process_metadata/1.

Retrieve data set @@ -672,7 +672,7 @@ start(_, []) -> - + Remove the handler with the specified identity.

Remove the handler identified by HandlerId.

@@ -680,7 +680,7 @@ start(_, []) ->
- + Remove a filter from the specified handler.

Remove the filter identified @@ -690,7 +690,7 @@ start(_, []) -> - + Remove a primary filter from Logger.

Remove the primary filter identified @@ -699,7 +699,7 @@ start(_, []) -> - + Set the log level for all modules in the specified application.

Set the log level for all the modules of the specified application.

@@ -710,7 +710,7 @@ start(_, []) ->
- + Set configuration data for the specified handler.

Set configuration data for the specified handler. This @@ -731,11 +731,11 @@ start(_, []) -> - - - - - + + + + + Add or update configuration data for the specified handler. @@ -767,7 +767,7 @@ start(_, []) -> - + Set primary configuration data for Logger.

Set primary configuration data for Logger. This @@ -785,9 +785,9 @@ start(_, []) -> - - - + + + Add or update primary configuration data for Logger. @@ -801,7 +801,7 @@ start(_, []) -> - + Set the log level for the specified modules.

Set the log level for the specified modules.

@@ -841,7 +841,7 @@ start(_, []) ->
- + Set metadata to use when logging from current process.

Set metadata which Logger shall automatically insert in @@ -860,7 +860,7 @@ start(_, []) -> - + Unset the log level for all modules in the specified application.

Unset the log level for all the modules of the specified application.

@@ -871,7 +871,7 @@ start(_, []) ->
- + Remove module specific log settings for all modules.

Remove module specific log settings. After this, the @@ -880,7 +880,7 @@ start(_, []) -> - + Remove module specific log settings for the given modules. @@ -890,7 +890,7 @@ start(_, []) -> - + Delete data set with set_process_metadata/1.

Delete data set @@ -902,7 +902,7 @@ start(_, []) -> - + Update the formatter configuration for the specified handler.

Update the formatter configuration for the specified handler.

@@ -917,7 +917,7 @@ start(_, []) ->
- + Update the formatter configuration for the specified handler.

Update the formatter configuration for the specified handler.

@@ -928,7 +928,7 @@ start(_, []) ->
- + Update configuration data for the specified handler.

Update configuration data for the specified handler. This function @@ -944,11 +944,11 @@ logger:set_handler_config(HandlerId, maps:merge(Old, Config)). - - - - - + + + + + Add or update configuration data for the specified handler. @@ -980,7 +980,7 @@ logger:set_handler_config(HandlerId, maps:merge(Old, Config)). - + Update primary configuration data for Logger.

Update primary configuration data for Logger. This function @@ -996,7 +996,7 @@ logger:set_primary_config(maps:merge(Old, Config)). - + Set or update metadata to use when logging from current process. @@ -1021,7 +1021,7 @@ logger:set_process_metadata(maps:merge(logger:get_process_metadata(), Meta)). - + Compare the severity of two log levels.

Compare the severity of two log levels. Returns gt @@ -1032,7 +1032,7 @@ logger:set_process_metadata(maps:merge(logger:get_process_metadata(), Meta)). - + Convert a log message on report form to {Format, Args}.

Convert a log message on report form to {Format, @@ -1062,7 +1062,7 @@ logger:set_process_metadata(maps:merge(logger:get_process_metadata(), Meta)). - HModule:adding_handler(Config1) -> {ok, Config2} | {error, + HModule:adding_handler(Config1) -> {ok, Config2} | {error, Reason} An instance of this handler is about to be added. @@ -1088,7 +1088,7 @@ logger:set_process_metadata(maps:merge(logger:get_process_metadata(), Meta)). - HModule:changing_config(SetOrUpdate, OldConfig, NewConfig) -> {ok, Config} | {error, Reason} + HModule:changing_config(SetOrUpdate, OldConfig, NewConfig) -> {ok, Config} | {error, Reason} The configuration for this handler is about to change. SetOrUpdate = set | update @@ -1126,7 +1126,7 @@ logger:set_process_metadata(maps:merge(logger:get_process_metadata(), Meta)). - HModule:filter_config(Config) -> FilteredConfig + HModule:filter_config(Config) -> FilteredConfig Remove internal data from configuration. Config = FilteredConfig = @@ -1146,7 +1146,7 @@ logger:set_process_metadata(maps:merge(logger:get_process_metadata(), Meta)). - HModule:log(LogEvent, Config) -> void() + HModule:log(LogEvent, Config) -> void() Log the given log event. LogEvent = @@ -1169,7 +1169,7 @@ logger:set_process_metadata(maps:merge(logger:get_process_metadata(), Meta)). - HModule:removing_handler(Config) -> ok + HModule:removing_handler(Config) -> ok The given handler is about to be removed. Config = @@ -1197,7 +1197,7 @@ logger:set_process_metadata(maps:merge(logger:get_process_metadata(), Meta)). - FModule:check_config(FConfig) -> ok | {error, Reason} + FModule:check_config(FConfig) -> ok | {error, Reason} Validate the given formatter configuration. FConfig = @@ -1228,7 +1228,7 @@ logger:set_process_metadata(maps:merge(logger:get_process_metadata(), Meta)). - FModule:format(LogEvent, FConfig) -> FormattedLogEntry + FModule:format(LogEvent, FConfig) -> FormattedLogEntry Format the given log event. LogEvent = diff --git a/lib/kernel/doc/src/logger_disk_log_h.xml b/lib/kernel/doc/src/logger_disk_log_h.xml index d9b941a0a9..5b2374690e 100644 --- a/lib/kernel/doc/src/logger_disk_log_h.xml +++ b/lib/kernel/doc/src/logger_disk_log_h.xml @@ -32,7 +32,7 @@ A logger_disk_log_h.xml - logger_disk_log_h + logger_disk_log_h A disk_log based handler for Logger @@ -148,7 +148,7 @@ erl -kernel logger '[{handler,default,logger_disk_log_h, - + Writes buffered data to disk.

Write buffered data to disk.

diff --git a/lib/kernel/doc/src/logger_filters.xml b/lib/kernel/doc/src/logger_filters.xml index 90f1fcc270..0a02342864 100644 --- a/lib/kernel/doc/src/logger_filters.xml +++ b/lib/kernel/doc/src/logger_filters.xml @@ -32,7 +32,7 @@ A logger_filters.xml - logger_filters + logger_filters Filters to use with Logger. @@ -51,7 +51,7 @@ - + Filter log events based on the domain field in metadata. @@ -152,7 +152,7 @@ ok - + Filter log events based on the log level.

This filter provides a way of filtering log events based @@ -212,7 +212,7 @@ ok - + Filter progress reports from supervisor and application_controller.

This filter matches all progress reports @@ -227,7 +227,7 @@ ok - + Filter events with group leader on remote node.

This filter matches all events originating from a process diff --git a/lib/kernel/doc/src/logger_formatter.xml b/lib/kernel/doc/src/logger_formatter.xml index d066e263df..6dc83d24e1 100644 --- a/lib/kernel/doc/src/logger_formatter.xml +++ b/lib/kernel/doc/src/logger_formatter.xml @@ -32,7 +32,7 @@ A logger_formatter.xml - logger_formatter + logger_formatter Default formatter for Logger. @@ -289,7 +289,7 @@ exit_reason: "It crashed" - + Validates the given formatter configuration.

The function is called by Logger when the formatter @@ -310,7 +310,7 @@ exit_reason: "It crashed" - + Formats the given message.

This the formatter callback function to be called from diff --git a/lib/kernel/doc/src/logger_std_h.xml b/lib/kernel/doc/src/logger_std_h.xml index e156f5719b..fcd180abd6 100644 --- a/lib/kernel/doc/src/logger_std_h.xml +++ b/lib/kernel/doc/src/logger_std_h.xml @@ -32,7 +32,7 @@ A logger_std_h.xml - logger_std_h + logger_std_h Standard handler for Logger. @@ -121,7 +121,7 @@ erl -kernel logger '[{handler,default,logger_std_h, - + Writes buffered data to disk.

Write buffered data to disk.

diff --git a/lib/kernel/doc/src/net_kernel.xml b/lib/kernel/doc/src/net_kernel.xml index bfbe7a6470..1ed5d5cca1 100644 --- a/lib/kernel/doc/src/net_kernel.xml +++ b/lib/kernel/doc/src/net_kernel.xml @@ -131,7 +131,7 @@ $ erl -sname foobar
- + Get distribution socket options.

Get one or more options for the distribution socket @@ -324,7 +324,7 @@ $ erl -sname foobar - + Set distribution socket options.

Set one or more options for distribution sockets. diff --git a/lib/kernel/doc/src/os.xml b/lib/kernel/doc/src/os.xml index c95e615c6b..9bd859452c 100644 --- a/lib/kernel/doc/src/os.xml +++ b/lib/kernel/doc/src/os.xml @@ -135,7 +135,7 @@ - + Execute a command in a shell of the target OS.

Executes Command in a command shell of the @@ -220,7 +220,7 @@ DirOut = os:cmd("dir"), % on Win32 platform - + Get the value of an environment variable.

Returns the Value of the environment variable @@ -277,7 +277,7 @@ DirOut = os:cmd("dir"), % on Win32 platform - + Enables or disables handling of OS signals.

Enables or disables OS signals.

@@ -304,7 +304,7 @@ DirOut = os:cmd("dir"), % on Win32 platform
- + Current OS system time.

Returns the current @@ -317,7 +317,7 @@ DirOut = os:cmd("dir"), % on Win32 platform - + Current OS system time.

Returns the current @@ -373,7 +373,7 @@ calendar:now_to_universal_time(TS), - + Returns a performance counter

Returns the current performance counter value in perf_counter @@ -383,7 +383,7 @@ calendar:now_to_universal_time(TS), - + Returns a performance counter

Returns a performance counter that can be used as a very fast and high resolution timestamp. This counter is read directly from the hardware or operating @@ -417,7 +417,7 @@ calendar:now_to_universal_time(TS), - + Delete an environment variable.

Deletes the environment variable VarName.

diff --git a/lib/mnesia/doc/src/mnesia.xml b/lib/mnesia/doc/src/mnesia.xml index 621b6047ee..5f11b55ab9 100644 --- a/lib/mnesia/doc/src/mnesia.xml +++ b/lib/mnesia/doc/src/mnesia.xml @@ -595,7 +595,7 @@ mnesia:change_table_copy_type(person, node(), disc_copies)
- change_table_majority(Tab, Majority) -> {aborted, R} | {atomic, ok} + change_table_majority(Tab, Majority) -> {aborted, R} | {atomic, ok} Changes the majority check setting for the table.

Majority must be a boolean. Default is false. @@ -2143,7 +2143,7 @@ mnesia:create_table(employee, - sync_log() -> ok | {error, Reason} + sync_log() -> ok | {error, Reason} Performs a file sync of the local log file.

Ensures that the local transaction log file is synced to disk. diff --git a/lib/observer/doc/src/crashdump.xml b/lib/observer/doc/src/crashdump.xml index 48f944cbce..59679d794e 100644 --- a/lib/observer/doc/src/crashdump.xml +++ b/lib/observer/doc/src/crashdump.xml @@ -47,7 +47,7 @@ start() -> ok - start(File) -> ok + start(File) -> ok Start the Crashdump Viewer. File = string() diff --git a/lib/observer/doc/src/etop.xml b/lib/observer/doc/src/etop.xml index e7a83d0514..dcf3fe252a 100644 --- a/lib/observer/doc/src/etop.xml +++ b/lib/observer/doc/src/etop.xml @@ -98,7 +98,7 @@ - start() -> ok + start() -> ok Start etop.

Starts etop. @@ -106,7 +106,7 @@ - start(Options) -> ok + start(Options) -> ok Start etop. Options = [Option] @@ -120,7 +120,7 @@ - help() -> ok + help() -> ok Display the etop help.

Displays the help of etop and diff --git a/lib/observer/doc/src/observer.xml b/lib/observer/doc/src/observer.xml index 843be26ee1..7fb1dd044e 100644 --- a/lib/observer/doc/src/observer.xml +++ b/lib/observer/doc/src/observer.xml @@ -33,7 +33,7 @@ PA1 observer.xml - observer + observer A GUI tool for observing an Erlang system.

Observer is a graphical tool for observing the characteristics of @@ -48,7 +48,7 @@ - start() -> ok + start() -> ok Start the Observer GUI.

Starts the Observer GUI. diff --git a/lib/observer/doc/src/ttb.xml b/lib/observer/doc/src/ttb.xml index 7cd15e15d3..2aa2b0c8a5 100644 --- a/lib/observer/doc/src/ttb.xml +++ b/lib/observer/doc/src/ttb.xml @@ -44,7 +44,7 @@ - start_trace(Nodes, Patterns, FlagSpec, Opts) -> Result + start_trace(Nodes, Patterns, FlagSpec, Opts) -> Result Start a trace port on each specified node. Result = see p/2 @@ -573,7 +573,7 @@ ttb:p(all, call). - get_et_handler() + get_et_handler() Return the et handler.

Returns the et handler, which can be used with format/2 diff --git a/lib/public_key/doc/src/public_key.xml b/lib/public_key/doc/src/public_key.xml index ee3877ddd0..5259cb9dd3 100644 --- a/lib/public_key/doc/src/public_key.xml +++ b/lib/public_key/doc/src/public_key.xml @@ -176,7 +176,7 @@ - + Computes shared secret.

Computes shared secret.

@@ -184,7 +184,7 @@
- + Computes shared secret.

Computes shared secret.

@@ -192,8 +192,8 @@
- - + + Public-key decryption.

Public-key decryption using the private key. See also - - + + Public-key decryption.

Public-key decryption using the public key. See also - + Decodes a public-key ASN.1 DER encoded entity.

Decodes a public-key ASN.1 DER encoded entity.

@@ -220,7 +220,7 @@
- + Encodes a public-key entity with ASN.1 DER encoding.

Encodes a public-key entity with ASN.1 DER encoding.

@@ -228,7 +228,7 @@
- + Selects a group for Diffie-Hellman key exchange

Selects a group for Diffie-Hellman key exchange with the key size in the range MinSize...MaxSize @@ -249,8 +249,8 @@ - - + + Public-key encryption using the private key.

Public-key encryption using the private key. @@ -260,8 +260,8 @@ - - + + Public-key encryption using the public key.

Public-key encryption using the public key. See also - + Generates a new keypair.

Generates a new keypair. Note that except for Diffie-Hellman @@ -281,7 +281,7 @@ - + Decodes PEM binary data and returns entries as ASN.1 DER encoded entities. @@ -291,7 +291,7 @@ - + Creates a PEM binary.

Creates a PEM binary.

@@ -299,8 +299,8 @@
- - + + Decodes a PEM entry.

Decodes a PEM entry. pem_decode/1 returns a list of PEM @@ -311,8 +311,8 @@ - - + + Creates a PEM entry that can be fed to pem_encode/1.

Creates a PEM entry that can be feed to pem_encode/1.

@@ -337,7 +337,7 @@
- + DER encodes a PKIX x509 certificate or part of such a certificate. @@ -349,7 +349,7 @@ - + Checks if IssuerCert issued Cert.

Checks if IssuerCert issued Cert.

@@ -357,7 +357,7 @@
- + Checks if a certificate is a fixed Diffie-Hellman certificate.

Checks if a certificate is a fixed Diffie-Hellman certificate.

@@ -365,7 +365,7 @@
- + Checks if a certificate is self-signed.

Checks if a certificate is self-signed.

@@ -373,7 +373,7 @@
- + Returns the issuer id.

Returns the issuer id.

@@ -381,7 +381,7 @@
- + Normalizes an issuer name so that it can be easily compared to another issuer name. @@ -391,7 +391,7 @@ - pkix_path_validation(TrustedCert, CertChain, Options) -> {ok, {PublicKeyInfo, PolicyTree}} | {error, {bad_cert, Reason}} + pkix_path_validation(TrustedCert, CertChain, Options) -> {ok, {PublicKeyInfo, PolicyTree}} | {error, {bad_cert, Reason}} Performs a basic path validation according to RFC 5280. TrustedCert = #'OTPCertificate'{} | der_encoded() | atom() @@ -491,7 +491,7 @@ fun(OtpCert :: #'OTPCertificate'{}, - + Returns the issuer of the CRL.

Returns the issuer of the CRL.

@@ -499,7 +499,7 @@ fun(OtpCert :: #'OTPCertificate'{},
- + Performs CRL validation.

Performs CRL validation. It is intended to be called from @@ -551,7 +551,7 @@ fun(#'DistributionPoint'{}, #'CertificateList'{}, - + Verify that Cert is the CRL signer.

Verify that Cert is the CRL signer.

@@ -559,7 +559,7 @@ fun(#'DistributionPoint'{}, #'CertificateList'{},
- + Creates a distribution point for CRLs issued by the same issuer as Cert.

Creates a distribution point for CRLs issued by the same issuer as Cert. @@ -570,7 +570,7 @@ fun(#'DistributionPoint'{}, #'CertificateList'{}, - + Extracts distribution points from the certificates extensions.

Extracts distribution points from the certificates extensions.

@@ -578,7 +578,7 @@ fun(#'DistributionPoint'{}, #'CertificateList'{},
- + Checks whether the given distribution point matches the Issuing Distribution Point of the CRL. @@ -590,7 +590,7 @@ fun(#'DistributionPoint'{}, #'CertificateList'{}, - + Signs certificate.

Signs an 'OTPTBSCertificate'. Returns the corresponding @@ -599,7 +599,7 @@ fun(#'DistributionPoint'{}, #'CertificateList'{}, - + Translates signature algorithm OID to Erlang digest and signature algorithm types.

Translates signature algorithm OID to Erlang digest and signature types. @@ -609,8 +609,8 @@ fun(#'DistributionPoint'{}, #'CertificateList'{}, - pkix_test_data(Options) -> Config - pkix_test_data([chain_opts()]) -> [conf_opt()] + pkix_test_data(Options) -> Config + pkix_test_data([chain_opts()]) -> [conf_opt()] Creates certificate test data. Options = #{chain_type() := chain_opts()} @@ -742,7 +742,7 @@ fun(#'DistributionPoint'{}, #'CertificateList'{}, - pkix_test_root_cert(Name, Options) -> RootCert + pkix_test_root_cert(Name, Options) -> RootCert Generates a test data root cert. Name = string() @@ -772,7 +772,7 @@ fun(#'DistributionPoint'{}, #'CertificateList'{}, - + Verifies PKIX x.509 certificate signature.

Verifies PKIX x.509 certificate signature.

@@ -780,8 +780,8 @@ fun(#'DistributionPoint'{}, #'CertificateList'{},
- pkix_verify_hostname(Cert, ReferenceIDs) -> boolean() - pkix_verify_hostname(Cert, ReferenceIDs, Opts) -> boolean() + pkix_verify_hostname(Cert, ReferenceIDs) -> boolean() + pkix_verify_hostname(Cert, ReferenceIDs, Opts) -> boolean() Verifies that a PKIX x.509 certificate presented identifier (e.g hostname) is an expected one. @@ -864,7 +864,7 @@ end - pkix_verify_hostname_match_fun(Protcol) -> fun(RefId | FQDN::string(), PresentedID) -> boolean() | default + pkix_verify_hostname_match_fun(Protcol) -> fun(RefId | FQDN::string(), PresentedID) -> boolean() | default Returns a fun that is intendended as argument to the match_fun option in pkix_verify_hostname/3. @@ -890,7 +890,7 @@ end - + Creates a digital signature.

Creates a digital signature.

@@ -901,7 +901,7 @@ end
- + Decodes an SSH file-binary.

Decodes an SSH file-binary. In the case of known_hosts or @@ -933,7 +933,7 @@ end - + Encodes a list of SSH file entries to a binary.

Encodes a list of SSH file entries (public keys and attributes) to a binary. Possible @@ -947,9 +947,9 @@ end - ssh_hostkey_fingerprint(HostKey) -> string() - ssh_hostkey_fingerprint(DigestType, HostKey) -> string() - ssh_hostkey_fingerprint([DigestType], HostKey) -> [string()] + ssh_hostkey_fingerprint(HostKey) -> string() + ssh_hostkey_fingerprint(DigestType, HostKey) -> string() + ssh_hostkey_fingerprint([DigestType], HostKey) -> [string()] Calculates a ssh fingerprint for a hostkey. HostKey = public_key() @@ -982,8 +982,8 @@ end - - + + Verifies a digital signature.

Verifies a digital signature.

@@ -993,7 +993,7 @@ end
- + Generates a short hash of an issuer name.

Generates a short hash of an issuer name. The hash is diff --git a/lib/reltool/doc/src/reltool.xml b/lib/reltool/doc/src/reltool.xml index 874cda8369..8a269365c9 100644 --- a/lib/reltool/doc/src/reltool.xml +++ b/lib/reltool/doc/src/reltool.xml @@ -711,7 +711,7 @@ target_spec() = [target_spec()] - get_status(Server) -> {ok, [Warning]} | {error, Reason} + get_status(Server) -> {ok, [Warning]} | {error, Reason} Get contents of a release file Server = server() diff --git a/lib/runtime_tools/doc/src/dbg.xml b/lib/runtime_tools/doc/src/dbg.xml index 3262cafefc..06701ed5b4 100644 --- a/lib/runtime_tools/doc/src/dbg.xml +++ b/lib/runtime_tools/doc/src/dbg.xml @@ -442,7 +442,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - tpe(Event, MatchSpec) -> {ok, MatchDesc} | {error, term()} + tpe(Event, MatchSpec) -> {ok, MatchDesc} | {error, term()} Set pattern for traced event Event = send | 'receive' @@ -607,7 +607,7 @@ Error: fun containing local erlang function calls ('is_atomm' called in guard)\ - ctpe(Event) -> {ok, MatchDesc} | {error, term()} + ctpe(Event) -> {ok, MatchDesc} | {error, term()} Clear trace pattern for the specified event Event = send | 'receive' diff --git a/lib/runtime_tools/doc/src/dyntrace.xml b/lib/runtime_tools/doc/src/dyntrace.xml index 0cdcecab68..4935dfcd71 100644 --- a/lib/runtime_tools/doc/src/dyntrace.xml +++ b/lib/runtime_tools/doc/src/dyntrace.xml @@ -32,7 +32,7 @@ A dyntrace.xml - dyntrace + dyntrace Interface to dynamic tracing

This module implements interfaces to dynamic tracing, should such be compiled into the virtual machine. For a standard and/or commercial build, no dynamic tracing is available, in which case none of the functions in this module is usable or give any effect.

@@ -47,7 +47,7 @@
- available() -> boolean() + available() -> boolean() Check if dynamic tracing is available

This function uses the NIF library to determine if dynamic @@ -59,42 +59,42 @@ - p() -> true | false | error | badarg + p() -> true | false | error | badarg Trigger the user trace probe.

Calling this function will trigger the "user" trace probe user_trace_i4s4 in the dyntrace NIF module, sending a trace message only containing the user tag and zeroes/empty strings in all other fields.

- p(integer() | string()) -> true | false | error | badarg + p(integer() | string()) -> true | false | error | badarg Trigger the user trace probe.

Calling this function will trigger the "user" trace probe user_trace_i4s4 in the dyntrace NIF module, sending a trace message containing the user tag and the integer or string parameter in the first integer/string field.

- p(integer() | string(), integer() | string()) -> true | false | error | badarg + p(integer() | string(), integer() | string()) -> true | false | error | badarg Trigger the user trace probe.

Calling this function will trigger the "user" trace probe user_trace_i4s4 in the dyntrace NIF module, sending a trace message containing the user tag and the integer() or string() parameters as the first fields of respective type. integer() parameters should be put before any string() parameters. I.e. p(1,"Hello") is ok, as is p(1,1) and p("Hello","Again"), but not p("Hello",1).

- p(integer() | string(), integer() | string(), integer() | string()) -> true | false | error | badarg + p(integer() | string(), integer() | string(), integer() | string()) -> true | false | error | badarg Trigger the user trace probe.

Calling this function will trigger the "user" trace probe user_trace_i4s4 in the dyntrace NIF module, sending a trace message containing the user tag and the integer() or string() parameters as the first fields of respective type. integer() parameters should be put before any string() parameters, as in p/2.

- p(integer() | string(), integer() | string(), integer() | string(), integer() | string()) -> true | false | error | badarg + p(integer() | string(), integer() | string(), integer() | string(), integer() | string()) -> true | false | error | badarg Trigger the user trace probe.

Calling this function will trigger the "user" trace probe user_trace_i4s4 in the dyntrace NIF module, sending a trace message containing the user tag and the integer() or string() parameters as the first fields of respective type. integer() parameters should be put before any string() parameters, as in p/2.

- p(integer(), integer() | string(), integer() | string(), integer() | string(), string()) -> true | false | error | badarg + p(integer(), integer() | string(), integer() | string(), integer() | string(), string()) -> true | false | error | badarg Trigger the user trace probe.

Calling this function will trigger the "user" trace probe user_trace_i4s4 in the dyntrace NIF module, sending a trace message containing the user tag and the integer() or string() parameters as the first fields of respective type. integer() parameters should be put before any string() parameters, as in p/2.

@@ -102,7 +102,7 @@
- p(integer(), integer(), integer() | string(), integer() | string(), string(), string()) -> true | false | error | badarg + p(integer(), integer(), integer() | string(), integer() | string(), string(), string()) -> true | false | error | badarg Trigger the user trace probe.

Calling this function will trigger the "user" trace probe user_trace_i4s4 in the dyntrace NIF module, sending a trace message containing the user tag and the integer() or string() parameters as the first fields of respective type. integer() parameters should be put before any string() parameters, as in p/2.

@@ -110,7 +110,7 @@
- p(integer(), integer(), integer(), integer() | string(), string(), string(), string()) -> true | false | error | badarg + p(integer(), integer(), integer(), integer() | string(), string(), string(), string()) -> true | false | error | badarg Trigger the user trace probe.

Calling this function will trigger the "user" trace probe user_trace_i4s4 in the dyntrace NIF module, sending a trace message containing the user tag and the integer() or string() parameters as the first fields of respective type. integer() parameters should be put before any string() parameters, as in p/2.

@@ -118,14 +118,14 @@
- p(integer(), integer(), integer(), integer(), string(), string(), string(), string()) -> true | false | error | badarg + p(integer(), integer(), integer(), integer(), string(), string(), string(), string()) -> true | false | error | badarg Trigger the user trace probe.

Calling this function will trigger the "user" trace probe user_trace_i4s4 in the dyntrace NIF module, sending a trace message containing all the integer()'s and string()'s provided, as well as any user tag set in the current process.

- get_tag() -> binary() | undefined + get_tag() -> binary() | undefined Get the user tag set in the process.

This function returns the user tag set in the current @@ -134,7 +134,7 @@ - get_tag() -> binary() | undefined + get_tag() -> binary() | undefined Get the user tag set in the process or sent to the process.

This function returns the user tag set in the current @@ -151,7 +151,7 @@ - put_tag(Item) -> binary() | undefined + put_tag(Item) -> binary() | undefined Set the user tag of the current process. Item = iodata() @@ -163,7 +163,7 @@ - spread_tag(boolean()) -> TagData + spread_tag(boolean()) -> TagData Start or stop spreading dynamic trace user tags with the next message. TagData = opaque data that can be used as parameter to restore_tag/1 @@ -185,7 +185,7 @@ f() -> - restore_tag(TagData) -> true + restore_tag(TagData) -> true Restore to a previous state of user tag spreading. TagData = opaque data returned by spread_tag/1 diff --git a/lib/runtime_tools/doc/src/msacc.xml b/lib/runtime_tools/doc/src/msacc.xml index 129da3d230..ae089de8d0 100644 --- a/lib/runtime_tools/doc/src/msacc.xml +++ b/lib/runtime_tools/doc/src/msacc.xml @@ -31,7 +31,7 @@ A msacc.xml - msacc + msacc Convenience functions for microstate accounting

This module implements some convenience functions for analyzing @@ -146,7 +146,7 @@ ok - + Check if microstate accounting is available

This function checks whether microstate accounting @@ -154,7 +154,7 @@ ok - + Start microstate accounting.

Start microstate accounting. Returns whether it was @@ -162,7 +162,7 @@ ok - + Start microstate accounting for a time.

Resets all counters and then starts microstate accounting @@ -170,7 +170,7 @@ ok - + Stop microstate accounting.

Stop microstate accounting. @@ -178,7 +178,7 @@ ok - + Reset microstate accounting counters

Reset microstate accounting counters. @@ -186,7 +186,7 @@ ok - + Print microstate statistics

@@ -199,7 +199,7 @@ ok - + Print microstate statistics

Print the given microstate statistics values to stdout. @@ -211,7 +211,7 @@ ok - + Print microstate statistics

Print the given microstate statistics values to standard out. @@ -234,7 +234,7 @@ ok - + Print microstate statistics

Print the given microstate statistics values to the given file @@ -243,7 +243,7 @@ ok - +

Returns a runtime system independent version of the microstate @@ -254,7 +254,7 @@ ok - +

Returns the system time for the given microstate statistics values. @@ -269,7 +269,7 @@ ok - +

Returns fractions of real-time or run-time spent in the various @@ -277,7 +277,7 @@ ok - +

Returns a list of microstate statistics values where the values @@ -285,7 +285,7 @@ ok - +

Dumps the current microstate statistics counters to a file that can @@ -294,7 +294,7 @@ ok - +

Read a file dump produced by diff --git a/lib/runtime_tools/doc/src/scheduler.xml b/lib/runtime_tools/doc/src/scheduler.xml index dd8bf73bae..b033430183 100644 --- a/lib/runtime_tools/doc/src/scheduler.xml +++ b/lib/runtime_tools/doc/src/scheduler.xml @@ -32,7 +32,7 @@ scheduler.xml - scheduler + scheduler Measure scheduler utilization

This module contains utility functions for easier measurement and @@ -84,7 +84,7 @@ - + Get scheduler utilization sample.

Return a scheduler utilization sample for normal and dirty-cpu @@ -93,7 +93,7 @@ - + Get scheduler utilization sample.

Return a scheduler utilization sample for all schedulers, @@ -102,7 +102,7 @@ - + Measure scheduler utilizations during a period of time.

Measure utilization for normal and dirty-cpu schedulers during @@ -111,7 +111,7 @@ - + Measure scheduler utilizations since sample.

Calculate scheduler utilizations for the time interval from when @@ -121,7 +121,7 @@ - + Measure scheduler utilizations between two samples.

Calculates scheduler utilizations for the time interval between diff --git a/lib/runtime_tools/doc/src/system_information.xml b/lib/runtime_tools/doc/src/system_information.xml index 53dc595e64..a356b5c6f8 100644 --- a/lib/runtime_tools/doc/src/system_information.xml +++ b/lib/runtime_tools/doc/src/system_information.xml @@ -32,14 +32,14 @@ system_information.xml - system_information + system_information System Information

- + Perform a sanity check

Performs a sanity check on the system. If no issues @@ -88,7 +88,7 @@ - + Write miscellaneous system information to file

Writes miscellaneous system information to file. This information will typically be requested by the Erlang/OTP team diff --git a/lib/sasl/doc/src/rb.xml b/lib/sasl/doc/src/rb.xml index d5df4fd345..6e118e177b 100644 --- a/lib/sasl/doc/src/rb.xml +++ b/lib/sasl/doc/src/rb.xml @@ -43,8 +43,8 @@ - filter(Filters) - filter(Filters, Dates) + filter(Filters) + filter(Filters, Dates) Filters reports and displays them on the screen. Filters = [filter()] @@ -137,8 +137,8 @@ - log_list() - log_list(Type) + log_list() + log_list(Type) Logs report lists. Type = type() diff --git a/lib/sasl/doc/src/release_handler.xml b/lib/sasl/doc/src/release_handler.xml index 9ba276aeac..a77dace675 100644 --- a/lib/sasl/doc/src/release_handler.xml +++ b/lib/sasl/doc/src/release_handler.xml @@ -169,7 +169,7 @@ check_install_release(Vsn) -> {ok, OtherVsn, Descr} | {error, Reason} - check_install_release(Vsn,Opts) -> {ok, OtherVsn, Descr} | {error, Reason} + check_install_release(Vsn,Opts) -> {ok, OtherVsn, Descr} | {error, Reason} Checks installation of a release in the system. Vsn = OtherVsn = string() @@ -495,7 +495,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]). - which_releases(Status) -> [{Name, Vsn, Apps, Status}] + which_releases(Status) -> [{Name, Vsn, Apps, Status}] Returns all known releases of a specific status. Name = Vsn = string() diff --git a/lib/snmp/doc/src/snmp.xml b/lib/snmp/doc/src/snmp.xml index 480ed2e825..bd671bb40e 100644 --- a/lib/snmp/doc/src/snmp.xml +++ b/lib/snmp/doc/src/snmp.xml @@ -344,7 +344,7 @@ log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile) -> ok | {ok, Cnt} | {error, Reason} log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block | Start) -> ok | {ok, Cnt} | {error, Reason} log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start, Block | Stop) -> ok | {ok, Cnt} | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start, Stop, Block) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start, Stop, Block) -> ok | {ok, Cnt} | {error, Reason} Convert an Audit Trail Log to text format LogDir = string() @@ -412,10 +412,10 @@ - log_to_io(LogDir, Mibs, LogName, LogFile) -> ok | {ok, Cnt} | {error, Reason} - log_to_io(LogDir, Mibs, LogName, LogFile, Block | Start) -> ok | {ok, Cnt} | {error, Reason} - log_to_io(LogDir, Mibs, LogName, LogFile, Start, Block | Stop) -> ok | {ok, Cnt} | {error, Reason} - log_to_io(LogDir, Mibs, LogName, LogFile, Start, Stop, Block) -> ok | {ok, Cnt} | {error, Reason} + log_to_io(LogDir, Mibs, LogName, LogFile) -> ok | {ok, Cnt} | {error, Reason} + log_to_io(LogDir, Mibs, LogName, LogFile, Block | Start) -> ok | {ok, Cnt} | {error, Reason} + log_to_io(LogDir, Mibs, LogName, LogFile, Start, Block | Stop) -> ok | {ok, Cnt} | {error, Reason} + log_to_io(LogDir, Mibs, LogName, LogFile, Start, Stop, Block) -> ok | {ok, Cnt} | {error, Reason} Convert an Audit Trail Log to text format LogDir = string() diff --git a/lib/snmp/doc/src/snmp_community_mib.xml b/lib/snmp/doc/src/snmp_community_mib.xml index 61dea05950..60d5b840be 100644 --- a/lib/snmp/doc/src/snmp_community_mib.xml +++ b/lib/snmp/doc/src/snmp_community_mib.xml @@ -109,7 +109,7 @@ add_community(Idx, CommName, SecName, CtxName, TransportTag) -> Ret - add_community(Idx, CommName, SecName, EngineId, CtxName, TransportTag) -> Ret + add_community(Idx, CommName, SecName, EngineId, CtxName, TransportTag) -> Ret Added one community Idx = string() diff --git a/lib/snmp/doc/src/snmp_generic.xml b/lib/snmp/doc/src/snmp_generic.xml index 44762dec59..54c2bd6291 100644 --- a/lib/snmp/doc/src/snmp_generic.xml +++ b/lib/snmp/doc/src/snmp_generic.xml @@ -163,7 +163,7 @@ value() = term() - get_table_info(Name, Item) -> table_info_result() + get_table_info(Name, Item) -> table_info_result() Get table info item of MIB table Name Name = name() diff --git a/lib/snmp/doc/src/snmpa.xml b/lib/snmp/doc/src/snmpa.xml index b78f14da01..995608b71b 100644 --- a/lib/snmp/doc/src/snmpa.xml +++ b/lib/snmp/doc/src/snmpa.xml @@ -251,8 +251,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - load_mib(Mib) -> ok | {error, Reason} - load_mib(Agent, Mib) -> ok | {error, Reason} + load_mib(Mib) -> ok | {error, Reason} + load_mib(Agent, Mib) -> ok | {error, Reason} Load single MIB into the agent Agent = pid() | atom() @@ -276,7 +276,7 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} load_mibs(Mibs) -> ok | {error, Reason} load_mibs(Mibs, Force) -> ok | {error, Reason} load_mibs(Agent, Mibs) -> ok | {error, Reason} - load_mibs(Agent, Mibs, Force) -> ok | {error, Reason} + load_mibs(Agent, Mibs, Force) -> ok | {error, Reason} Load MIBs into the agent Agent = pid() | atom() @@ -305,8 +305,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - unload_mib(Mib) -> ok | {error, Reason} - unload_mib(Agent, Mib) -> ok | {error, Reason} + unload_mib(Mib) -> ok | {error, Reason} + unload_mib(Agent, Mib) -> ok | {error, Reason} Unload single MIB from the agent Agent = pid() | atom() @@ -324,7 +324,7 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} unload_mibs(Mibs) -> ok | {error, Reason} unload_mibs(Mibs, Force) -> ok | {error, Reason} unload_mibs(Agent, Mibs) -> ok | {error, Reason} - unload_mibs(Agent, Mibs, Force) -> ok | {error, Reason} + unload_mibs(Agent, Mibs, Force) -> ok | {error, Reason} Unload MIBs from the agent Agent = pid() | atom() @@ -557,7 +557,7 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - log_to_txt(LogDir) + log_to_txt(LogDir) log_to_txt(LogDir, Block | Mibs) log_to_txt(LogDir, Mibs, Block | OutFile) -> ok | {ok, Cnt} | {error, Reason} log_to_txt(LogDir, Mibs, OutFile, Block | LogName) -> ok | {ok, Cnt} | {error, Reason} @@ -565,7 +565,7 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block | Start) -> ok | {ok, Cnt} | {error, Reason} log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block, Start) -> ok | {ok, Cnt} | {error, Reason} log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start, Stop) -> ok | {ok, Cnt} | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block, Start, Stop) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block, Start, Stop) -> ok | {ok, Cnt} | {error, Reason} Convert an Audit Trail Log to text format LogDir = string() @@ -600,14 +600,14 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - log_to_io(LogDir) -> ok | {ok, Cnt} | {error, Reason} - log_to_io(LogDir, Block | Mibs) -> ok | {ok, Cnt} | {error, Reason} - log_to_io(LogDir, Mibs, Block | LogName) -> ok | {ok, Cnt} | {error, Reason} - log_to_io(LogDir, Mibs, LogName, Block | LogFile) -> ok | {ok, Cnt} | {error, Reason} - log_to_io(LogDir, Mibs, LogName, LogFile, Block | Start) -> ok | {ok, Cnt} | {error, Reason} - log_to_io(LogDir, Mibs, LogName, LogFile, Block, Start) -> ok | {ok, Cnt} | {error, Reason} - log_to_io(LogDir, Mibs, LogName, LogFile, Start, Stop) -> ok | {ok, Cnt} | {error, Reason} - log_to_io(LogDir, Mibs, LogName, LogFile, Block, Start, Stop) -> ok | {ok, Cnt} | {error, Reason} + log_to_io(LogDir) -> ok | {ok, Cnt} | {error, Reason} + log_to_io(LogDir, Block | Mibs) -> ok | {ok, Cnt} | {error, Reason} + log_to_io(LogDir, Mibs, Block | LogName) -> ok | {ok, Cnt} | {error, Reason} + log_to_io(LogDir, Mibs, LogName, Block | LogFile) -> ok | {ok, Cnt} | {error, Reason} + log_to_io(LogDir, Mibs, LogName, LogFile, Block | Start) -> ok | {ok, Cnt} | {error, Reason} + log_to_io(LogDir, Mibs, LogName, LogFile, Block, Start) -> ok | {ok, Cnt} | {error, Reason} + log_to_io(LogDir, Mibs, LogName, LogFile, Start, Stop) -> ok | {ok, Cnt} | {error, Reason} + log_to_io(LogDir, Mibs, LogName, LogFile, Block, Start, Stop) -> ok | {ok, Cnt} | {error, Reason} Convert an Audit Trail Log to text format LogDir = string() @@ -767,8 +767,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - which_mibs_cache_size() -> void() - which_mibs_cache_size(Agent) -> void() + which_mibs_cache_size() -> void() + which_mibs_cache_size(Agent) -> void() The size of the mib server cache Agent = pid() | atom() @@ -992,7 +992,7 @@ snmp_agent:register_subagent(SA1,[1,2,3], SA2). - send_notification2(Agent, Notification, SendOpts) -> void() + send_notification2(Agent, Notification, SendOpts) -> void() Send notification Agent = pid() | atom() @@ -1123,7 +1123,7 @@ snmp_agent:register_subagent(SA1,[1,2,3], SA2). send_notification(Agent, Notification, Receiver, Varbinds) send_notification(Agent, Notification, Receiver, NotifyName, Varbinds) send_notification(Agent, Notification, Receiver, NotifyName, ContextName, Varbinds) -> void() - send_notification(Agent, Notification, Receiver, NotifyName, ContextName, Varbinds, LocalEngineID) -> void() + send_notification(Agent, Notification, Receiver, NotifyName, ContextName, Varbinds, LocalEngineID) -> void() Send a notification Agent = pid() | atom() @@ -1435,7 +1435,7 @@ snmp_agent:register_subagent(SA1,[1,2,3], SA2). - print_mib_info() -> void() + print_mib_info() -> void() Print mib info

Prints the content of all the (snmp) tables and variables @@ -1446,7 +1446,7 @@ snmp_agent:register_subagent(SA1,[1,2,3], SA2). - print_mib_tables() -> void() + print_mib_tables() -> void() Print mib tables

Prints the content of all the (snmp) tables @@ -1457,7 +1457,7 @@ snmp_agent:register_subagent(SA1,[1,2,3], SA2). - print_mib_variables() -> void() + print_mib_variables() -> void() Print mib variables

Prints the content of all the (snmp) variables diff --git a/lib/snmp/doc/src/snmpa_conf.xml b/lib/snmp/doc/src/snmpa_conf.xml index 503e44a6a2..01c52c3c8a 100644 --- a/lib/snmp/doc/src/snmpa_conf.xml +++ b/lib/snmp/doc/src/snmpa_conf.xml @@ -428,7 +428,7 @@ word() = 0..65535 target_addr_entry(Name, Domain, Addr, TagList, ParamsName, EngineId) -> target_addr_entry() - target_addr_entry(Name, Domain, Addr, TagList, ParamsName, EngineId, TMask) -> target_addr_entry() + target_addr_entry(Name, Domain, Addr, TagList, ParamsName, EngineId, TMask) -> target_addr_entry() target_addr_entry(Name, Domain, Addr, TagList, ParamsName, EngineId, TMask, MaxMessageSize) -> target_addr_entry() target_addr_entry(Name, Domain, Addr, Timeout, RetryCount, TagList, ParamsName, EngineId, TMask, MaxMessageSize) -> target_addr_entry() Create an target_addr entry diff --git a/lib/snmp/doc/src/snmpa_mib_data.xml b/lib/snmp/doc/src/snmpa_mib_data.xml index 1a73c9b634..b849a2826a 100644 --- a/lib/snmp/doc/src/snmpa_mib_data.xml +++ b/lib/snmp/doc/src/snmpa_mib_data.xml @@ -30,7 +30,7 @@ snmpa_mib_data.xml - snmpa_mib_data + snmpa_mib_data Behaviour module for the SNMP agent mib-server data module. @@ -108,7 +108,7 @@ - Module:new(Storage) -> State + Module:new(Storage) -> State Create new (mib-server) data instance Storage = mib_storage() @@ -122,7 +122,7 @@ - Module:close(State) -> void() + Module:close(State) -> void() Close the mib-server data instance State = term() @@ -135,7 +135,7 @@ - Module:sync(State) -> void() + Module:sync(State) -> void() Synchronize to disc State = term() @@ -151,7 +151,7 @@ - Module:load_mib(State, Filename, MeOverride, TeOverride) -> {ok, NewState} | {error, Reason} + Module:load_mib(State, Filename, MeOverride, TeOverride) -> {ok, NewState} | {error, Reason} Load a mib into the mib-server State = NewState = term() @@ -172,7 +172,7 @@ - Module:unload_mib(State, Filename) -> {ok, NewState} | {error, Reason} + Module:unload_mib(State, Filename) -> {ok, NewState} | {error, Reason} Unload mib from the mib-server State = NewState = term() @@ -188,7 +188,7 @@ - Module:lookup(State, Oid) -> Reply + Module:lookup(State, Oid) -> Reply Find the mib-entry corresponding to the Oid State = term() @@ -210,7 +210,7 @@ - Module:next(State, Oid, MibView) -> Reply + Module:next(State, Oid, MibView) -> Reply Finds the lexicographically next oid State = term() @@ -227,7 +227,7 @@ - Module:register_subagent(State, Oid, Pid) -> Reply + Module:register_subagent(State, Oid, Pid) -> Reply Register the subagent State = NewState = term() @@ -245,7 +245,7 @@ - Module:unregister_subagent(State, PidOrOid) -> Reply + Module:unregister_subagent(State, PidOrOid) -> Reply Unregister the subagent State = NewState = term() @@ -266,7 +266,7 @@ - Module:dump(State, Destination) -> Reply + Module:dump(State, Destination) -> Reply Unregister the subagent State = term() @@ -284,7 +284,7 @@ - Module:which_mib(State, Oid) -> Reply + Module:which_mib(State, Oid) -> Reply Retrieve the mib file for an oid() State = term() @@ -301,7 +301,7 @@ - Module:which_mibs(State) -> Reply + Module:which_mibs(State) -> Reply Retrieve all loaded mib files State = term() @@ -317,7 +317,7 @@ - Module:whereis_mib(State, MibName) -> Reply + Module:whereis_mib(State, MibName) -> Reply Retrieve the mib file for the mib State = term() @@ -334,7 +334,7 @@ - Module:info(State) -> Reply + Module:info(State) -> Reply Retrieve misc info for the mib data State = term() @@ -352,7 +352,7 @@ - Module:backup(State, BackupDir) -> Reply + Module:backup(State, BackupDir) -> Reply Perform a backup of the mib-server data State = term() @@ -370,7 +370,7 @@ - Module:code_change(Destination, Vsn, Extra, State) -> NewState + Module:code_change(Destination, Vsn, Extra, State) -> NewState Perform a code-change Destination = up | down diff --git a/lib/snmp/doc/src/snmpa_mib_storage.xml b/lib/snmp/doc/src/snmpa_mib_storage.xml index 58ce2167ec..ee2b009e77 100644 --- a/lib/snmp/doc/src/snmpa_mib_storage.xml +++ b/lib/snmp/doc/src/snmpa_mib_storage.xml @@ -30,7 +30,7 @@ snmpa_mib_storage.xml - snmpa_mib_storage + snmpa_mib_storage Behaviour module for the SNMP agent mib storage. @@ -96,7 +96,7 @@ - Module:open(Name, RecordName, Fields, Type, Options) -> {ok, TabId} | {error, Reason} + Module:open(Name, RecordName, Fields, Type, Options) -> {ok, TabId} | {error, Reason} Create new (mib-server) data instance Name = atom() @@ -122,7 +122,7 @@ - Module:close(TabId) -> void() + Module:close(TabId) -> void() Close the mib-storage table State = term() @@ -135,7 +135,7 @@ - Module:read(TabId, Key) -> false | {value, Record} + Module:read(TabId, Key) -> false | {value, Record} Read a record from the mib-storage table TabId = term() @@ -150,7 +150,7 @@ - Module:write(TabId, Record) -> ok | {error, Reason} + Module:write(TabId, Record) -> ok | {error, Reason} Write a record to the mib-storage table TabId = term() @@ -165,7 +165,7 @@ - Module:delete(TabId) -> void() + Module:delete(TabId) -> void() Delete an entire mib-storage table TabId = term() @@ -178,7 +178,7 @@ - Module:delete(TabId, Key) -> ok | {error, Reason} + Module:delete(TabId, Key) -> ok | {error, Reason} Delete a record from the mib-storage table TabId = term() @@ -193,7 +193,7 @@ - Module:match_object(TabId, Pattern) -> {ok, Recs} | {error, Reason} + Module:match_object(TabId, Pattern) -> {ok, Recs} | {error, Reason} Search the mib-storage table for record matching pattern TabId = term() @@ -210,7 +210,7 @@ - Module:match_delete(TabId, Pattern) -> {ok, Recs} | {error, Reason} + Module:match_delete(TabId, Pattern) -> {ok, Recs} | {error, Reason} Delete records in the mib-storage table matching pattern TabId = term() @@ -228,7 +228,7 @@ - Module:tab2list(TabId) -> Recs + Module:tab2list(TabId) -> Recs Return all records of the mib-storage table TabId = term() @@ -243,7 +243,7 @@ - Module:info(TabId) -> {ok, Info} | {error, Reason} + Module:info(TabId) -> {ok, Info} | {error, Reason} Returns information about the mib-storage table. TabId = term() @@ -259,7 +259,7 @@ - Module:sync(TabId) -> void() + Module:sync(TabId) -> void() Synchronize mib-storage table TabId = term() @@ -273,7 +273,7 @@ - Module:backup(TabId, BackupDir) -> ok | {error, Reason} + Module:backup(TabId, BackupDir) -> ok | {error, Reason} Perform a backup of the mib-storage table TabId = term() diff --git a/lib/snmp/doc/src/snmpa_mpd.xml b/lib/snmp/doc/src/snmpa_mpd.xml index a39c087c20..4a0c5b61d5 100644 --- a/lib/snmp/doc/src/snmpa_mpd.xml +++ b/lib/snmp/doc/src/snmpa_mpd.xml @@ -70,8 +70,8 @@ - process_packet(Packet, From, State, NoteStore, Log) -> {ok, Vsn, Pdu, PduMS, ACMData} | {discarded, Reason} | {discovery, DiscoPacket} - process_packet(Packet, From, LocalEngineID, State, NoteStore, Log) -> {ok, Vsn, Pdu, PduMS, ACMData} | {discarded, Reason} | {discovery, DiscoPacket} + process_packet(Packet, From, State, NoteStore, Log) -> {ok, Vsn, Pdu, PduMS, ACMData} | {discarded, Reason} | {discovery, DiscoPacket} + process_packet(Packet, From, LocalEngineID, State, NoteStore, Log) -> {ok, Vsn, Pdu, PduMS, ACMData} | {discarded, Reason} | {discovery, DiscoPacket} Process a packet received from the network Packet = binary() @@ -108,8 +108,8 @@ - generate_response_msg(Vsn, RePdu, Type, ACMData, Log) -> {ok, Packet} | {discarded, Reason} - generate_response_msg(Vsn, RePdu, Type, ACMData, LocalEngineID, Log) -> {ok, Packet} | {discarded, Reason} + generate_response_msg(Vsn, RePdu, Type, ACMData, Log) -> {ok, Packet} | {discarded, Reason} + generate_response_msg(Vsn, RePdu, Type, ACMData, LocalEngineID, Log) -> {ok, Packet} | {discarded, Reason} Generate a response packet to be sent to the network Vsn = 'version-1' | 'version-2' | 'version-3' @@ -136,8 +136,8 @@ - generate_msg(Vsn, NoteStore, Pdu, MsgData, To) -> {ok, PacketsAndAddresses} | {discarded, Reason} - generate_msg(Vsn, NoteStore, Pdu, MsgData, LocalEngineID, To) -> {ok, PacketsAndAddresses} | {discarded, Reason} + generate_msg(Vsn, NoteStore, Pdu, MsgData, To) -> {ok, PacketsAndAddresses} | {discarded, Reason} + generate_msg(Vsn, NoteStore, Pdu, MsgData, LocalEngineID, To) -> {ok, PacketsAndAddresses} | {discarded, Reason} Generate a request message to be sent to the network Vsn = 'version-1' | 'version-2' | 'version-3' @@ -185,7 +185,7 @@ - process_taddrs(TDests) -> Dests + process_taddrs(TDests) -> Dests Transform addresses from internal MIB format to a less internal diff --git a/lib/snmp/doc/src/snmpm.xml b/lib/snmp/doc/src/snmpm.xml index be4cd58a1a..9b8029330e 100644 --- a/lib/snmp/doc/src/snmpm.xml +++ b/lib/snmp/doc/src/snmpm.xml @@ -354,7 +354,7 @@ sec_level = noAuthNoPriv | authNoPriv | authPriv - update_agent_info(UserId, TargetName, Info) -> ok | {error, Reason} + update_agent_info(UserId, TargetName, Info) -> ok | {error, Reason} update_agent_info(UserId, TargetName, Item, Val) -> ok | {error, Reason} Update agent config @@ -505,8 +505,8 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - sync_get2(UserId, TargetName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_get2(UserId, TargetName, Oids, SendOpts) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get2(UserId, TargetName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get2(UserId, TargetName, Oids, SendOpts) -> {ok, SnmpReply, Remaining} | {error, Reason} Synchronous get-request UserId = term() @@ -605,8 +605,8 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - async_get2(UserId, TargetName, Oids) -> {ok, ReqId} | {error, Reason} - async_get2(UserId, TargetName, Oids, SendOpts) -> {ok, ReqId} | {error, Reason} + async_get2(UserId, TargetName, Oids) -> {ok, ReqId} | {error, Reason} + async_get2(UserId, TargetName, Oids, SendOpts) -> {ok, ReqId} | {error, Reason} Asynchronous get-request UserId = term() @@ -683,8 +683,8 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - sync_get_next2(UserId, TargetName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_get_next2(UserId, TargetName, Oids, SendOpts) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get_next2(UserId, TargetName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get_next2(UserId, TargetName, Oids, SendOpts) -> {ok, SnmpReply, Remaining} | {error, Reason} Synchronous get-next-request UserId = term() @@ -775,8 +775,8 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - async_get_next2(UserId, TargetName, Oids) -> {ok, ReqId} | {error, Reason} - async_get_next2(UserId, TargetName, Oids, SendOpts) -> {ok, ReqId} | {error, Reason} + async_get_next2(UserId, TargetName, Oids) -> {ok, ReqId} | {error, Reason} + async_get_next2(UserId, TargetName, Oids, SendOpts) -> {ok, ReqId} | {error, Reason} Asynchronous get-next-request UserId = term() @@ -849,8 +849,8 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - sync_set2(UserId, TargetName, VarsAndVals) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_set2(UserId, TargetName, VarsAndVals, SendOpts) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_set2(UserId, TargetName, VarsAndVals) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_set2(UserId, TargetName, VarsAndVals, SendOpts) -> {ok, SnmpReply, Remaining} | {error, Reason} Synchronous set-request UserId = term() @@ -946,8 +946,8 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - async_set2(UserId, TargetName, VarsAndVals) -> {ok, ReqId} | {error, Reason} - async_set2(UserId, TargetName, VarsAndVals, SendOpts) -> {ok, ReqId} | {error, Reason} + async_set2(UserId, TargetName, VarsAndVals) -> {ok, ReqId} | {error, Reason} + async_set2(UserId, TargetName, VarsAndVals, SendOpts) -> {ok, ReqId} | {error, Reason} Asynchronous set-request UserId = term() @@ -1026,8 +1026,8 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - sync_get_bulk2(UserId, TragetName, NonRep, MaxRep, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_get_bulk2(UserId, TragetName, NonRep, MaxRep, Oids, SendOpts) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get_bulk2(UserId, TragetName, NonRep, MaxRep, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get_bulk2(UserId, TragetName, NonRep, MaxRep, Oids, SendOpts) -> {ok, SnmpReply, Remaining} | {error, Reason} Synchronous get-bulk-request UserId = term() @@ -1121,8 +1121,8 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - async_get_bulk2(UserId, TargetName, NonRep, MaxRep, Oids) -> {ok, ReqId} | {error, Reason} - async_get_bulk2(UserId, TargetName, NonRep, MaxRep, Oids, SendOpts) -> {ok, ReqId} | {error, Reason} + async_get_bulk2(UserId, TargetName, NonRep, MaxRep, Oids) -> {ok, ReqId} | {error, Reason} + async_get_bulk2(UserId, TargetName, NonRep, MaxRep, Oids, SendOpts) -> {ok, ReqId} | {error, Reason} Asynchronous get-bulk-request UserId = term() @@ -1214,7 +1214,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - log_to_txt(LogDir) + log_to_txt(LogDir) log_to_txt(LogDir, Block | Mibs) log_to_txt(LogDir, Mibs, Block | OutFile) -> ok | {ok, Cnt} | {error, Reason} log_to_txt(LogDir, Mibs, OutFile, Block | LogName) -> ok | {ok, Cnt} | {error, Reason} @@ -1222,7 +1222,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block | Start) -> ok | {ok, Cnt} | {error, Reason} log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block, Start) -> ok | {ok, Cnt} | {error, Reason} log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start, Stop) -> ok | {ok, Cnt} | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block, Start, Stop) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block, Start, Stop) -> ok | {ok, Cnt} | {error, Reason} Convert an Audit Trail Log to text format LogDir = string() @@ -1257,15 +1257,15 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - log_to_io(LogDir) -> ok | {ok, Cnt} | {error, Reason} - log_to_io(LogDir, Block | Mibs) -> ok | {ok, Cnt} | {error, Reason} - log_to_io(LogDir, Mibs) -> ok | {error, Reason} - log_to_io(LogDir, Mibs, Block | LogName) -> ok | {ok, Cnt} | {error, Reason} - log_to_io(LogDir, Mibs, LogName, Block | LogFile) -> ok | {ok, Cnt} | {error, Reason} - log_to_io(LogDir, Mibs, LogName, LogFile, Block | Start) -> ok | {ok, Cnt} | {error, Reason} - log_to_io(LogDir, Mibs, LogName, LogFile, Block, Start) -> ok | {ok, Cnt} | {error, Reason} - log_to_io(LogDir, Mibs, LogName, LogFile, Start, Stop) -> ok | {ok, Cnt} | {error, Reason} - log_to_io(LogDir, Mibs, LogName, LogFile, Block, Start, Stop) -> ok | {ok, Cnt} | {error, Reason} + log_to_io(LogDir) -> ok | {ok, Cnt} | {error, Reason} + log_to_io(LogDir, Block | Mibs) -> ok | {ok, Cnt} | {error, Reason} + log_to_io(LogDir, Mibs) -> ok | {error, Reason} + log_to_io(LogDir, Mibs, Block | LogName) -> ok | {ok, Cnt} | {error, Reason} + log_to_io(LogDir, Mibs, LogName, Block | LogFile) -> ok | {ok, Cnt} | {error, Reason} + log_to_io(LogDir, Mibs, LogName, LogFile, Block | Start) -> ok | {ok, Cnt} | {error, Reason} + log_to_io(LogDir, Mibs, LogName, LogFile, Block, Start) -> ok | {ok, Cnt} | {error, Reason} + log_to_io(LogDir, Mibs, LogName, LogFile, Start, Stop) -> ok | {ok, Cnt} | {error, Reason} + log_to_io(LogDir, Mibs, LogName, LogFile, Block, Start, Stop) -> ok | {ok, Cnt} | {error, Reason} Convert an Audit Trail Log to text format LogDir = string() diff --git a/lib/snmp/doc/src/snmpm_mpd.xml b/lib/snmp/doc/src/snmpm_mpd.xml index 08276e4b30..c8b2797ea7 100644 --- a/lib/snmp/doc/src/snmpm_mpd.xml +++ b/lib/snmp/doc/src/snmpm_mpd.xml @@ -64,7 +64,7 @@ - process_msg(Msg, Domain, Addr, State, NoteStore, Logger) -> {ok, Vsn, Pdu, PduMS, MsgData} | {discarded, Reason} + process_msg(Msg, Domain, Addr, State, NoteStore, Logger) -> {ok, Vsn, Pdu, PduMS, MsgData} | {discarded, Reason} Process a message received from the network Msg = binary() diff --git a/lib/snmp/doc/src/snmpm_user.xml b/lib/snmp/doc/src/snmpm_user.xml index 87ae1d224a..ef35f0eaaf 100644 --- a/lib/snmp/doc/src/snmpm_user.xml +++ b/lib/snmp/doc/src/snmpm_user.xml @@ -278,7 +278,7 @@ snmp_v1_trap_info() :: {Enteprise :: snmp:oid(), - handle_invalid_result(IN, OUT) -> void() + handle_invalid_result(IN, OUT) -> void() Handle a report message IN = {Func, Args} diff --git a/lib/ssh/doc/src/ssh.xml b/lib/ssh/doc/src/ssh.xml index 8435fced11..759c66d63c 100644 --- a/lib/ssh/doc/src/ssh.xml +++ b/lib/ssh/doc/src/ssh.xml @@ -1068,7 +1068,7 @@ connect(Host, Port, Options) -> Result connect(Host, Port, Options, NegotiationTimeout) -> Result - connect(TcpSocket, Options) -> Result + connect(TcpSocket, Options) -> Result connect(TcpSocket, Options, NegotiationTimeout) -> Result Connects to an SSH server. @@ -1154,7 +1154,7 @@ - + Get info about a daemon

Returns a key-value list with information about the daemon.

@@ -1164,7 +1164,7 @@ - + Get a list declaring the supported algorithms

Returns a key-value list, where the keys are the different types of algorithms and the values are the @@ -1227,7 +1227,7 @@ - + Stops the listener and all connections started by the listener.

Stops the listener and all connections started by the listener.

@@ -1237,7 +1237,7 @@ - + Stops the listener, but leaves existing connections started by the listener operational.

Stops the listener, but leaves existing connections started by the listener operational.

diff --git a/lib/ssh/doc/src/ssh_client_channel.xml b/lib/ssh/doc/src/ssh_client_channel.xml index 9be4007c68..cd28b95fd3 100644 --- a/lib/ssh/doc/src/ssh_client_channel.xml +++ b/lib/ssh/doc/src/ssh_client_channel.xml @@ -29,7 +29,7 @@ - ssh_client_channel + ssh_client_channel -behaviour(ssh_client_channel). (Replaces ssh_channel) @@ -68,8 +68,8 @@ - call(ChannelRef, Msg) -> - call(ChannelRef, Msg, Timeout) -> Reply | {error, Reason} + call(ChannelRef, Msg) -> + call(ChannelRef, Msg, Timeout) -> Reply | {error, Reason} Makes a synchronous call to a channel. ChannelRef = pid() @@ -92,7 +92,7 @@ - cast(ChannelRef, Msg) -> ok + cast(ChannelRef, Msg) -> ok Sends an asynchronous message to the channel ChannelRef and returns ok. @@ -111,7 +111,7 @@ - enter_loop(State) -> _ + enter_loop(State) -> _ Makes an existing process an ssh_client_channel (replaces ssh_channel) process. State = term() @@ -131,7 +131,7 @@ - init(Options) -> {ok, State} | {ok, State, Timeout} | {stop, Reason} + init(Options) -> {ok, State} | {ok, State, Timeout} | {stop, Reason} Initiates an ssh_client_channel process. Options = [{Option, Value}] @@ -173,7 +173,7 @@ - reply(Client, Reply) -> _ + reply(Client, Reply) -> _ Sends a reply to a client. Client = opaque() @@ -193,8 +193,8 @@ - start(SshConnection, ChannelId, ChannelCb, CbInitArgs) -> - start_link(SshConnection, ChannelId, ChannelCb, CbInitArgs) -> + start(SshConnection, ChannelId, ChannelCb, CbInitArgs) -> + start_link(SshConnection, ChannelId, ChannelCb, CbInitArgs) -> {ok, ChannelRef} | {error, Reason} Starts a process that handles an SSH channel. @@ -244,7 +244,7 @@ - Module:code_change(OldVsn, State, Extra) -> {ok, + Module:code_change(OldVsn, State, Extra) -> {ok, NewState} Converts process state when code is changed. @@ -287,7 +287,7 @@ - Module:init(Args) -> {ok, State} | {ok, State, timeout()} | + Module:init(Args) -> {ok, State} | {ok, State, timeout()} | {stop, Reason} Makes necessary initializations and returns the initial channel state if the initializations succeed. @@ -307,7 +307,7 @@ - Module:handle_call(Msg, From, State) -> Result + Module:handle_call(Msg, From, State) -> Result Handles messages sent by calling call/[2,3]. @@ -334,7 +334,7 @@ - Module:handle_cast(Msg, State) -> Result + Module:handle_cast(Msg, State) -> Result Handles messages sent by calling cast/2. @@ -355,7 +355,7 @@ - Module:handle_msg(Msg, State) -> {ok, State} | + Module:handle_msg(Msg, State) -> {ok, State} | {stop, ChannelId, State} Handles other messages than SSH connection protocol, @@ -389,7 +389,7 @@ - Module:handle_ssh_msg(Msg, State) -> {ok, State} | {stop, + Module:handle_ssh_msg(Msg, State) -> {ok, State} | {stop, ChannelId, State} Handles ssh connection protocol messages. @@ -416,7 +416,7 @@ - Module:terminate(Reason, State) -> _ + Module:terminate(Reason, State) -> _ Does cleaning up before channel process termination. diff --git a/lib/ssh/doc/src/ssh_client_key_api.xml b/lib/ssh/doc/src/ssh_client_key_api.xml index bc77756147..9f2f3013e5 100644 --- a/lib/ssh/doc/src/ssh_client_key_api.xml +++ b/lib/ssh/doc/src/ssh_client_key_api.xml @@ -29,7 +29,7 @@ - ssh_client_key_api + ssh_client_key_api -behaviour(ssh_client_key_api). @@ -86,7 +86,7 @@ - Module:add_host_key(HostNames, PublicHostKey, ConnectOptions) -> ok | {error, Reason} + Module:add_host_key(HostNames, PublicHostKey, ConnectOptions) -> ok | {error, Reason} Adds a host key to the set of trusted host keys. HostNames = string() @@ -103,7 +103,7 @@ - Module:is_host_key(Key, Host, Algorithm, ConnectOptions) -> Result + Module:is_host_key(Key, Host, Algorithm, ConnectOptions) -> Result Checks if a host key is trusted. Key = public_key:public_key() @@ -125,7 +125,7 @@ - Module:user_key(Algorithm, ConnectOptions) -> + Module:user_key(Algorithm, ConnectOptions) -> {ok, PrivateKey} | {error, Reason} Fetches the users public key matching the Algorithm. diff --git a/lib/ssh/doc/src/ssh_connection.xml b/lib/ssh/doc/src/ssh_connection.xml index 8e1cf156a8..7933cff511 100644 --- a/lib/ssh/doc/src/ssh_connection.xml +++ b/lib/ssh/doc/src/ssh_connection.xml @@ -298,8 +298,8 @@ - ptty_alloc(ConnectionRef, ChannelId, Options) -> - ptty_alloc(ConnectionRef, ChannelId, Options, Timeout) -> > ssh_request_status() | + ptty_alloc(ConnectionRef, ChannelId, Options) -> + ptty_alloc(ConnectionRef, ChannelId, Options, Timeout) -> > ssh_request_status() | {error, reason()} Sends an SSH Connection Protocol pty_req, to allocate a pseudo-terminal. diff --git a/lib/ssh/doc/src/ssh_file.xml b/lib/ssh/doc/src/ssh_file.xml index 6681d9c306..f1fef09083 100644 --- a/lib/ssh/doc/src/ssh_file.xml +++ b/lib/ssh/doc/src/ssh_file.xml @@ -28,7 +28,7 @@ - ssh_file + ssh_file Default callback module for the client's and server's database operations in the ssh application

This module is the default callback handler for the client's and the server's user and host "database" operations. @@ -169,7 +169,7 @@ - host_key(Algorithm, DaemonOptions) -> {ok, Key} | {error, Reason} + host_key(Algorithm, DaemonOptions) -> {ok, Key} | {error, Reason}

Types and description

@@ -195,7 +195,7 @@
- is_auth_key(PublicUserKey, User, DaemonOptions) -> Result + is_auth_key(PublicUserKey, User, DaemonOptions) -> Result

Types and description

@@ -216,7 +216,7 @@
- add_host_key(HostNames, PublicHostKey, ConnectOptions) -> ok | {error, Reason} + add_host_key(HostNames, PublicHostKey, ConnectOptions) -> ok | {error, Reason}

Types and description

@@ -235,7 +235,7 @@
- is_host_key(Key, Host, Algorithm, ConnectOptions) -> Result + is_host_key(Key, Host, Algorithm, ConnectOptions) -> Result

Types and description

@@ -254,7 +254,7 @@
- user_key(Algorithm, ConnectOptions) -> {ok, PrivateKey} | {error, Reason} + user_key(Algorithm, ConnectOptions) -> {ok, PrivateKey} | {error, Reason}

Types and description

diff --git a/lib/ssh/doc/src/ssh_server_channel.xml b/lib/ssh/doc/src/ssh_server_channel.xml index 31ba9a3231..a4e18bbfbf 100644 --- a/lib/ssh/doc/src/ssh_server_channel.xml +++ b/lib/ssh/doc/src/ssh_server_channel.xml @@ -29,7 +29,7 @@ - ssh_server_channel + ssh_server_channel -behaviour(ssh_server_channel). (Replaces ssh_daemon_channel) @@ -70,7 +70,7 @@ - Module:init(Args) -> {ok, State} | {ok, State, timeout()} | + Module:init(Args) -> {ok, State} | {ok, State, timeout()} | {stop, Reason} Makes necessary initializations and returns the initial channel state if the initializations succeed. @@ -93,7 +93,7 @@ - Module:handle_msg(Msg, State) -> {ok, State} | + Module:handle_msg(Msg, State) -> {ok, State} | {stop, ChannelId, State} Handles other messages than SSH connection protocol, @@ -125,7 +125,7 @@ - Module:handle_ssh_msg(Msg, State) -> {ok, State} | {stop, + Module:handle_ssh_msg(Msg, State) -> {ok, State} | {stop, ChannelId, State} Handles ssh connection protocol messages. @@ -152,7 +152,7 @@ - Module:terminate(Reason, State) -> _ + Module:terminate(Reason, State) -> _ Does cleaning up before channel process termination. diff --git a/lib/ssh/doc/src/ssh_server_key_api.xml b/lib/ssh/doc/src/ssh_server_key_api.xml index e2a31bd5f5..013a788a4a 100644 --- a/lib/ssh/doc/src/ssh_server_key_api.xml +++ b/lib/ssh/doc/src/ssh_server_key_api.xml @@ -29,7 +29,7 @@ - ssh_server_key_api + ssh_server_key_api -behaviour(ssh_server_key_api). @@ -87,7 +87,7 @@ - Module:host_key(Algorithm, DaemonOptions) -> + Module:host_key(Algorithm, DaemonOptions) -> {ok, Key} | {error, Reason} Fetches the host’s private key. @@ -111,7 +111,7 @@ - Module:is_auth_key(PublicUserKey, User, DaemonOptions) -> Result + Module:is_auth_key(PublicUserKey, User, DaemonOptions) -> Result Checks if the user key is authorized. PublicUserKey = public_key:public_key() diff --git a/lib/ssh/doc/src/ssh_sftp.xml b/lib/ssh/doc/src/ssh_sftp.xml index 8c105147d6..780e132ae2 100644 --- a/lib/ssh/doc/src/ssh_sftp.xml +++ b/lib/ssh/doc/src/ssh_sftp.xml @@ -285,8 +285,8 @@ - open_tar(ChannelPid, Path, Mode) -> - open_tar(ChannelPid, Path, Mode, Timeout) -> {ok, Handle} | {error, reason()} + open_tar(ChannelPid, Path, Mode) -> + open_tar(ChannelPid, Path, Mode, Timeout) -> {ok, Handle} | {error, reason()} Opens a tar file on the server to which ChannelPid is connected and returns a handle. diff --git a/lib/ssl/doc/src/ssl.xml b/lib/ssl/doc/src/ssl.xml index 3029977745..e13393bf63 100644 --- a/lib/ssl/doc/src/ssl.xml +++ b/lib/ssl/doc/src/ssl.xml @@ -873,7 +873,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - append_cipher_suites(Deferred, Suites) -> ciphers() + append_cipher_suites(Deferred, Suites) -> ciphers() Deferred = ciphers() | cipher_filters() @@ -889,8 +889,8 @@ fun(srp, Username :: string(), UserState :: term()) -> - cipher_suites() -> - cipher_suites(Type) -> old_ciphers() + cipher_suites() -> + cipher_suites(Type) -> old_ciphers() Returns a list of supported cipher suites. Type = erlang | openssl | all @@ -901,7 +901,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - cipher_suites(Supported, Version) -> ciphers() + cipher_suites(Supported, Version) -> ciphers() Returns a list of all default or all supported cipher suites. @@ -915,8 +915,8 @@ fun(srp, Username :: string(), UserState :: term()) -> - eccs() -> - eccs(protocol_version()) -> [named_curve()] + eccs() -> + eccs(protocol_version()) -> [named_curve()] Returns a list of supported ECCs.

Returns a list of supported ECCs. eccs() @@ -926,7 +926,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - clear_pem_cache() -> ok + clear_pem_cache() -> ok Clears the pem cache

PEM files, used by ssl API-functions, are cached. The @@ -938,7 +938,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - connect(Socket, SslOptions) -> + connect(Socket, SslOptions) -> connect(Socket, SslOptions, Timeout) -> {ok, SslSocket} | {ok, SslSocket, Ext} | {error, Reason} Upgrades a gen_tcp, or @@ -1029,7 +1029,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - close(SslSocket, How) -> ok | {ok, port()} | {error, Reason} + close(SslSocket, How) -> ok | {ok, port()} | {error, Reason} Closes an TLS connection. SslSocket = sslsocket() @@ -1060,7 +1060,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - connection_information(SslSocket) -> + connection_information(SslSocket) -> {ok, Result} | {error, Reason} Returns all the connection information. @@ -1081,7 +1081,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - connection_information(SslSocket, Items) -> + connection_information(SslSocket, Items) -> {ok, Result} | {error, Reason} Returns the requested connection information. @@ -1103,7 +1103,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - filter_cipher_suites(Suites, Filters) -> ciphers() + filter_cipher_suites(Suites, Filters) -> ciphers() Suites = ciphers() @@ -1143,9 +1143,9 @@ fun(srp, Username :: string(), UserState :: term()) -> - getstat(SslSocket) -> + getstat(SslSocket) -> {ok, OptionValues} | {error, inet:posix()} - getstat(SslSocket, OptionNames) -> + getstat(SslSocket, OptionNames) -> {ok, OptionValues} | {error, inet:posix()} Get one or more statistic options for a socket @@ -1160,8 +1160,8 @@ fun(srp, Username :: string(), UserState :: term()) -> - handshake(HsSocket) -> - handshake(HsSocket, Timeout) -> {ok, SslSocket} | {error, Reason} + handshake(HsSocket) -> + handshake(HsSocket, Timeout) -> {ok, SslSocket} | {error, Reason} Performs server-side SSL/TLS handshake. HsSocket = SslSocket = sslsocket() @@ -1175,8 +1175,8 @@ fun(srp, Username :: string(), UserState :: term()) -> - handshake(Socket, SslOptions) -> - handshake(Socket, SslOptions, Timeout) -> {ok, SslSocket} | {ok, SslSocket, Ext} | {error, Reason} + handshake(Socket, SslOptions) -> + handshake(Socket, SslOptions, Timeout) -> {ok, SslSocket} | {ok, SslSocket, Ext} | {error, Reason} Performs server-side SSL/TLS/DTLS handshake. Socket = socket() | sslsocket() @@ -1214,7 +1214,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - handshake_cancel(SslSocket) -> ok + handshake_cancel(SslSocket) -> ok Cancel handshake with a fatal alert SslSocket = sslsocket() @@ -1225,8 +1225,8 @@ fun(srp, Username :: string(), UserState :: term()) -> - handshake_continue(HsSocket, SSLOptions) -> {ok, SslSocket} | {error, Reason} - handshake_continue(HsSocket, SSLOptions, Timeout) -> {ok, SslSocket} | {error, Reason} + handshake_continue(HsSocket, SSLOptions) -> {ok, SslSocket} | {error, Reason} + handshake_continue(HsSocket, SSLOptions, Timeout) -> {ok, SslSocket} | {error, Reason} Continue the SSL/TLS handshake. HsSocket = SslSocket = sslsocket() @@ -1254,7 +1254,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - negotiated_protocol(SslSocket) -> {ok, Protocol} | {error, protocol_not_negotiated} + negotiated_protocol(SslSocket) -> {ok, Protocol} | {error, protocol_not_negotiated} Returns the protocol negotiated through ALPN or NPN extensions. SslSocket = sslsocket() @@ -1297,7 +1297,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - prepend_cipher_suites(Preferred, Suites) -> ciphers() + prepend_cipher_suites(Preferred, Suites) -> ciphers() Preferred = ciphers() | cipher_filters() @@ -1313,7 +1313,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - prf(Socket, Secret, Label, Seed, WantedLength) -> {ok, binary()} | {error, reason()} + prf(Socket, Secret, Label, Seed, WantedLength) -> {ok, binary()} | {error, reason()} Uses a session Pseudo-Random Function to generate key material. Socket = sslsocket() @@ -1360,7 +1360,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - renegotiate(SslSocket) -> ok | {error, Reason} + renegotiate(SslSocket) -> ok | {error, Reason} Initiates a new handshake. SslSocket = sslsocket() @@ -1400,7 +1400,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - shutdown(SslSocket, How) -> ok | {error, Reason} + shutdown(SslSocket, How) -> ok | {error, Reason} Immediately closes a socket. SslSocket = sslsocket() @@ -1434,7 +1434,7 @@ fun(srp, Username :: string(), UserState :: term()) -> ssl_accept(Socket, SslOptions) -> - ssl_accept(Socket, SslOptions, Timeout) -> {ok, Socket} | ok | {error, Reason} + ssl_accept(Socket, SslOptions, Timeout) -> {ok, Socket} | ok | {error, Reason} Performs server-side SSL/TLS/DTLS handshake. Socket = socket() | sslsocket() @@ -1464,8 +1464,8 @@ fun(srp, Username :: string(), UserState :: term()) -> - start() -> - start(Type) -> ok | {error, Reason} + start() -> + start(Type) -> ok | {error, Reason} Starts the SSL application. Type = permanent | transient | temporary @@ -1477,7 +1477,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - stop() -> ok + stop() -> ok Stops the SSL application.

Stops the SSL application.

@@ -1485,7 +1485,7 @@ fun(srp, Username :: string(), UserState :: term()) ->
- suite_to_str(CipherSuite) -> String + suite_to_str(CipherSuite) -> String Returns the string representation of a cipher suite. CipherSuite = erl_cipher_suite() @@ -1532,7 +1532,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - versions() -> [versions_info()] + versions() -> [versions_info()] Returns version information relevant for the SSL application. diff --git a/lib/ssl/doc/src/ssl_crl_cache.xml b/lib/ssl/doc/src/ssl_crl_cache.xml index 71c6d5e49e..b766cfd2d9 100644 --- a/lib/ssl/doc/src/ssl_crl_cache.xml +++ b/lib/ssl/doc/src/ssl_crl_cache.xml @@ -24,7 +24,7 @@ ssl_crl_cache.xml - ssl_crl_cache + ssl_crl_cache CRL cache

@@ -37,7 +37,7 @@ - delete(Entries) -> ok | {error, Reason} + delete(Entries) -> ok | {error, Reason} Entries = uri_string:uri_string() | {file, string()} | {der, [ - insert(CRLSrc) -> ok | {error, Reason} - insert(URI, CRLSrc) -> ok | {error, Reason} + insert(CRLSrc) -> ok | {error, Reason} + insert(URI, CRLSrc) -> ok | {error, Reason} CRLSrc = {file, string()} | {der, [ ssl_crl_cache_api.xml - ssl_crl_cache_api + ssl_crl_cache_api API for a SSL/TLS CRL (Certificate Revocation List) cache.

@@ -59,7 +59,7 @@ - fresh_crl(DistributionPoint, CRL) -> FreshCRL + fresh_crl(DistributionPoint, CRL) -> FreshCRL fun fresh_crl/2 will be used as input option update_crl to public_key:pkix_crls_validate/3 @@ -76,8 +76,8 @@ - lookup(DistributionPoint, Issuer, DbHandle) -> not_available | CRLs - lookup(DistributionPoint, DbHandle) -> not_available | CRLs + lookup(DistributionPoint, Issuer, DbHandle) -> not_available | CRLs + lookup(DistributionPoint, DbHandle) -> not_available | CRLs DistributionPoint = dist_point() @@ -106,7 +106,7 @@ - select(Issuer, DbHandle) -> CRLs + select(Issuer, DbHandle) -> CRLs Select the CRLs in the cache that are issued by Issuer Issuer = ssl_session_cache_api.xml - ssl_session_cache_api + ssl_session_cache_api TLS session cache API @@ -66,7 +66,7 @@ - delete(Cache, Key) -> _ + delete(Cache, Key) -> _ Deletes a cache entry. Cache = cache_ref() @@ -80,7 +80,7 @@ - foldl(Fun, Acc0, Cache) -> Acc + foldl(Fun, Acc0, Cache) -> Acc @@ -96,7 +96,7 @@ - init(Args) -> opaque() + init(Args) -> opaque() Returns cache reference. Args = proplists:proplist() @@ -121,7 +121,7 @@ - lookup(Cache, Key) -> Entry + lookup(Cache, Key) -> Entry Looks up a cache entry. Cache = cache_ref() @@ -136,7 +136,7 @@ - select_session(Cache, PartialKey) -> [session()] + select_session(Cache, PartialKey) -> [session()] Selects sessions that can be reused. Cache = cache_ref() @@ -151,7 +151,7 @@ - size(Cache) -> integer() + size(Cache) -> integer() Returns the number of sessions in the cache. Cache = cache_ref() @@ -166,7 +166,7 @@ - terminate(Cache) -> _ + terminate(Cache) -> _ Called by the process that handles the cache when it is about to terminate. @@ -180,7 +180,7 @@ - update(Cache, Key, Session) -> _ + update(Cache, Key, Session) -> _ Caches a new session or updates an already cached one. Cache = cache_ref() diff --git a/lib/stdlib/doc/src/beam_lib.xml b/lib/stdlib/doc/src/beam_lib.xml index 213170df7f..473170c839 100644 --- a/lib/stdlib/doc/src/beam_lib.xml +++ b/lib/stdlib/doc/src/beam_lib.xml @@ -267,7 +267,7 @@ io:fwrite("~s~n", [erl_prettypr:format(erl_syntax:form_list(AC))]). - + Read all chunks from a BEAM file or binary

Reads chunk data for all chunks.

@@ -275,7 +275,7 @@ io:fwrite("~s~n", [erl_prettypr:format(erl_syntax:form_list(AC))]).
- + Create a BEAM module from a list of chunks.

Builds a BEAM module (as a binary) from a list of chunks.

diff --git a/lib/stdlib/doc/src/binary.xml b/lib/stdlib/doc/src/binary.xml index 6a86d6c7ba..f3d4edd30f 100644 --- a/lib/stdlib/doc/src/binary.xml +++ b/lib/stdlib/doc/src/binary.xml @@ -34,7 +34,7 @@ A binary.xml - binary + binary Library for handling binary data. @@ -79,7 +79,7 @@ - + Return the byte at a specific position in a binary.

Returns the byte at position Pos (zero-based) in @@ -90,7 +90,7 @@ - + Convert a binary to a list of integers.

Same as bin_to_list(Subject, {0,byte_size(Subject)}).

@@ -98,7 +98,7 @@
- + Convert a binary to a list of integers.

Converts Subject to a list of byte()s, each @@ -118,7 +118,7 @@ - + Convert a binary to a list of integers.

Same as bin_to_list(Subject, {Pos, Len}).

@@ -126,7 +126,7 @@
- + Precompile a binary search pattern.

Builds an internal structure representing a compilation of a @@ -158,7 +158,7 @@ - + Create a duplicate of a binary.

Same as copy(Subject, 1).

@@ -166,7 +166,7 @@
- + Duplicate a binary N times and create a new.

Creates a binary with the content of Subject @@ -193,7 +193,7 @@ - + Decode a whole binary into an integer of arbitrary size. @@ -202,7 +202,7 @@ - + Decode a whole binary into an integer of arbitrary size. @@ -219,7 +219,7 @@ - + Encode an unsigned integer into the minimal binary.

Same as encode_unsigned(Unsigned, big).

@@ -227,7 +227,7 @@
- + Encode an unsigned integer into the minimal binary.

Converts a positive integer to the smallest possible @@ -243,7 +243,7 @@ - + Return the first byte of a binary.

Returns the first byte of binary Subject as an @@ -253,7 +253,7 @@ - + Return the last byte of a binary.

Returns the last byte of binary Subject as an @@ -263,7 +263,7 @@ - + Convert a list of integers and binaries to a binary.

Works exactly as @@ -273,7 +273,7 @@ - + Return length of longest common prefix for a set of binaries. @@ -294,7 +294,7 @@ - + Return length of longest common suffix for a set of binaries. @@ -315,7 +315,7 @@ - + Search for the first match of a pattern in a binary.

Same as match(Subject, Pattern, []). @@ -324,7 +324,7 @@ - + Search for the first match of a pattern in a binary. @@ -372,7 +372,7 @@ - + Search for all matches of a pattern in a binary.

Same as matches(Subject, Pattern, []). @@ -381,7 +381,7 @@ - + Search for all matches of a pattern in a binary. @@ -425,7 +425,7 @@ - + Extract a part of a binary.

Extracts the part of binary Subject described by @@ -453,7 +453,7 @@ - + Extract a part of a binary.

Same as part(Subject, {Pos, @@ -462,7 +462,7 @@ - + Determine the size of the binary pointed out by a subbinary. @@ -525,7 +525,7 @@ store(Binary, GBSet) -> - + Replace bytes in a binary according to a pattern.

Same as replace(Subject, Pattern, Replacement,[]).

@@ -533,7 +533,7 @@ store(Binary, GBSet) ->
- + Replace bytes in a binary according to a pattern. An integer() =< byte_size(Replacement) @@ -575,7 +575,7 @@ store(Binary, GBSet) -> - + Split a binary according to a pattern.

Same as split(Subject, Pattern, @@ -584,7 +584,7 @@ store(Binary, GBSet) -> - + Split a binary according to a pattern.

Splits Subject into a list of binaries based on diff --git a/lib/stdlib/doc/src/c.xml b/lib/stdlib/doc/src/c.xml index b6cb6f5aae..40e6d9d43e 100644 --- a/lib/stdlib/doc/src/c.xml +++ b/lib/stdlib/doc/src/c.xml @@ -52,7 +52,7 @@ - + Compile and load a file or module.

Compiles and then purges and loads the code for a module. @@ -94,7 +94,7 @@ - + Load an erlang resource file.

Search PathList and load .erlang resource file if @@ -171,7 +171,7 @@ - + Loads all modified modules.

Reloads all currently loaded modules that have changed on disk (see mm()). @@ -214,7 +214,7 @@ - + Lists all modified modules.

Lists all modified modules. Shorthand for @@ -301,7 +301,7 @@ compile:file(File, Options ++ [report_errors, report_w - + Print node uptime.

Prints the node uptime (as specified by diff --git a/lib/stdlib/doc/src/calendar.xml b/lib/stdlib/doc/src/calendar.xml index 5aee635c38..0d2f3ab3d3 100644 --- a/lib/stdlib/doc/src/calendar.xml +++ b/lib/stdlib/doc/src/calendar.xml @@ -195,7 +195,7 @@ - + Compute the ISO week number for the actual date.

Returns tuple {Year, WeekNum} representing @@ -206,7 +206,7 @@ - + Compute the ISO week number for the specified date.

Returns tuple {Year, WeekNum} representing @@ -317,8 +317,8 @@ - - + + Convert from RFC 3339 timestamp to system time. @@ -365,7 +365,7 @@ - + Convert system time to local date and time.

Converts a specified system time into local date and time.

@@ -373,8 +373,8 @@
- - + + Convert from system to RFC 3339 timestamp. @@ -426,7 +426,7 @@ - + Convert system time to universal date and time.

Converts a specified system time into universal date and time.

diff --git a/lib/stdlib/doc/src/dict.xml b/lib/stdlib/doc/src/dict.xml index c229a18721..e35b64d5e2 100644 --- a/lib/stdlib/doc/src/dict.xml +++ b/lib/stdlib/doc/src/dict.xml @@ -106,7 +106,7 @@
- + Return value and new dictionary without element with this value.

This function returns value from dictionary and a @@ -162,7 +162,7 @@ - + Return true if the dictionary is empty.

Returns true if dictionary Dict has no diff --git a/lib/stdlib/doc/src/epp.xml b/lib/stdlib/doc/src/epp.xml index d803d259aa..d9eefc19e0 100644 --- a/lib/stdlib/doc/src/epp.xml +++ b/lib/stdlib/doc/src/epp.xml @@ -85,7 +85,7 @@ - + Return the default encoding of Erlang source files.

Returns the default encoding of Erlang source files.

@@ -93,7 +93,7 @@
- + Return a string representation of an encoding.

Returns a string representation of an encoding. The string @@ -107,7 +107,7 @@ - + Format an error descriptor.

Takes an ErrorDescriptor and returns @@ -120,7 +120,7 @@ - + Open a file for preprocessing.

Opens a file for preprocessing.

@@ -167,7 +167,7 @@
- + Preprocess and parse an Erlang source file.

Preprocesses and parses an Erlang source file. @@ -194,8 +194,8 @@ - - + + Read the encoding from a file.

Read the encoding from @@ -209,8 +209,8 @@ - - + + Read the encoding from a binary.

Read the encoding from @@ -224,7 +224,7 @@ - + Read and set the encoding of an I/O device.

Reads the encoding from @@ -239,7 +239,7 @@ - + Read and set the encoding of an I/O device.

Reads the encoding from diff --git a/lib/stdlib/doc/src/erl_anno.xml b/lib/stdlib/doc/src/erl_anno.xml index f316f63d98..dff93619ab 100644 --- a/lib/stdlib/doc/src/erl_anno.xml +++ b/lib/stdlib/doc/src/erl_anno.xml @@ -34,7 +34,7 @@ A erl_anno.xml - erl_anno + erl_anno Abstract datatype for the annotations of the Erlang Compiler. @@ -135,7 +135,7 @@ - + Return the column. @@ -144,7 +144,7 @@ - + Return the end location of the text. @@ -155,7 +155,7 @@ - + Return the filename. @@ -165,7 +165,7 @@ - + Return annotations given a term.

Returns annotations with representation Term.

@@ -174,7 +174,7 @@
- + Return the generated Boolean. @@ -185,7 +185,7 @@ - + Test for a collection of annotations.

Returns true if Term is a collection of @@ -194,7 +194,7 @@ - + Return the line. @@ -203,7 +203,7 @@ - + Return the location. @@ -212,7 +212,7 @@ - + Create a new collection of annotations. @@ -221,7 +221,7 @@ - + Modify the filename. @@ -230,7 +230,7 @@ - + Modify the generated marker. @@ -240,7 +240,7 @@ - + Modify the line. @@ -249,7 +249,7 @@ - + Modify the location. @@ -258,7 +258,7 @@ - + Modify the record marker. @@ -267,7 +267,7 @@ - + Modify the text. @@ -276,7 +276,7 @@ - + Return the text. @@ -286,7 +286,7 @@ - + Return the term representing a collection of annotations. diff --git a/lib/stdlib/doc/src/erl_internal.xml b/lib/stdlib/doc/src/erl_internal.xml index 17cd0fb240..45264e82a8 100644 --- a/lib/stdlib/doc/src/erl_internal.xml +++ b/lib/stdlib/doc/src/erl_internal.xml @@ -44,7 +44,7 @@ - + Add code for pre-defined functions.

Adds to Forms the code for the standard diff --git a/lib/stdlib/doc/src/erl_parse.xml b/lib/stdlib/doc/src/erl_parse.xml index 647f36883c..dd15d495a4 100644 --- a/lib/stdlib/doc/src/erl_parse.xml +++ b/lib/stdlib/doc/src/erl_parse.xml @@ -102,7 +102,7 @@ - + Convert an Erlang term into an abstract form. @@ -124,7 +124,7 @@ - + Return annotations as terms.

Assumes that Term is a term with the same @@ -140,7 +140,7 @@ - + Return the representation of annotations.

Returns a term where each collection of annotations @@ -154,7 +154,7 @@ - + Fold a function over the annotations of an erl_parse tree. @@ -188,7 +188,7 @@ - + Map a function over the annotations of an erl_parse tree. @@ -201,7 +201,7 @@ - + Map and fold a function over the annotations of an erl_parse tree. @@ -220,7 +220,7 @@ - + Create new annotations.

Assumes that Term is a term with the same diff --git a/lib/stdlib/doc/src/erl_scan.xml b/lib/stdlib/doc/src/erl_scan.xml index 137ccd3416..6507f23dab 100644 --- a/lib/stdlib/doc/src/erl_scan.xml +++ b/lib/stdlib/doc/src/erl_scan.xml @@ -74,7 +74,7 @@ - + Return the category.

Returns the category of Token.

@@ -82,7 +82,7 @@
- + Return the column.

Returns the column of Token's @@ -91,7 +91,7 @@ - + Return the end location of the text.

Returns the end location of the text of @@ -113,7 +113,7 @@ - + Return the line.

Returns the line of Token's collection @@ -122,7 +122,7 @@ - + Return the location.

Returns the location of Token's @@ -229,7 +229,7 @@ - + Return the symbol.

Returns the symbol of Token.

@@ -237,7 +237,7 @@
- + Return the text.

Returns the text of Token's collection diff --git a/lib/stdlib/doc/src/erl_tar.xml b/lib/stdlib/doc/src/erl_tar.xml index 68fa071090..0a0b5fa115 100644 --- a/lib/stdlib/doc/src/erl_tar.xml +++ b/lib/stdlib/doc/src/erl_tar.xml @@ -423,7 +423,7 @@ - init(UserPrivate, AccessMode, Fun) -> + init(UserPrivate, AccessMode, Fun) -> {ok,TarDescriptor} | {error,Reason} Create a TarDescriptor used in subsequent tar operations when defining own low-level storage access functions. diff --git a/lib/stdlib/doc/src/ets.xml b/lib/stdlib/doc/src/ets.xml index ad006f9a2b..98c5c39f2b 100644 --- a/lib/stdlib/doc/src/ets.xml +++ b/lib/stdlib/doc/src/ets.xml @@ -1510,7 +1510,7 @@ is_integer(X), is_integer(Y), X + Y < 4711]]> - + Match and replace objects atomically in an ETS table

Matches the objects in the table Tab using a @@ -1549,7 +1549,7 @@ Success = (1 =:= ets:select_replace(T, [{Old, [], [{const, New}]}])), - + Continue matching objects in an ETS table.

Continues a match started with @@ -1582,7 +1582,7 @@ Success = (1 =:= ets:select_replace(T, [{Old, [], [{const, New}]}])), - + Match the objects in an ETS table against a match specification. @@ -1594,7 +1594,7 @@ Success = (1 =:= ets:select_replace(T, [{Old, [], [{const, New}]}])), - + Match the objects in an ETS table against a match specification and return part of the answers. @@ -1869,7 +1869,7 @@ true - + Return and remove all objects with a specified key from an ETS table. @@ -1923,11 +1923,11 @@ true - + - + - + Update a counter object in an ETS table. @@ -2049,7 +2049,7 @@ true - + Retrieves the tid() of a named table.

This function returns the diff --git a/lib/stdlib/doc/src/filelib.xml b/lib/stdlib/doc/src/filelib.xml index 3b5be75bc0..790f289ae5 100644 --- a/lib/stdlib/doc/src/filelib.xml +++ b/lib/stdlib/doc/src/filelib.xml @@ -263,8 +263,8 @@ filelib:wildcard("lib/**/*.{erl,hrl}") - - + + Find a file relative to a given directory.

Looks for a file of the given name by applying suffix rules to @@ -278,7 +278,7 @@ filelib:wildcard("lib/**/*.{erl,hrl}") - + Find the source file for a given object file.

Equivalent to find_source(Base, Dir), where Dir is @@ -287,8 +287,8 @@ filelib:wildcard("lib/**/*.{erl,hrl}") - - + + Find a source file relative to a given directory.

Applies file extension specific rules to find the source file for diff --git a/lib/stdlib/doc/src/filename.xml b/lib/stdlib/doc/src/filename.xml index 36254c2d00..e4cca2074a 100644 --- a/lib/stdlib/doc/src/filename.xml +++ b/lib/stdlib/doc/src/filename.xml @@ -144,8 +144,8 @@ - - + + Equivalent to basedir(PathType, Application,#{}) or basedir(PathsType, Application,#{}). @@ -165,8 +165,8 @@ basedir(PathsType, Application, #{}). - - + + @@ -557,7 +557,7 @@ true - + Sanitize a relative path to avoid directory traversal attacks.

Sanitizes the relative path by eliminating ".." and "." diff --git a/lib/stdlib/doc/src/gb_sets.xml b/lib/stdlib/doc/src/gb_sets.xml index 03397b4503..16db0906f5 100644 --- a/lib/stdlib/doc/src/gb_sets.xml +++ b/lib/stdlib/doc/src/gb_sets.xml @@ -336,7 +336,7 @@ - + Return an iterator for a set starting from a specified element. diff --git a/lib/stdlib/doc/src/gb_trees.xml b/lib/stdlib/doc/src/gb_trees.xml index 5cfff021c1..3b55c2c75d 100644 --- a/lib/stdlib/doc/src/gb_trees.xml +++ b/lib/stdlib/doc/src/gb_trees.xml @@ -109,7 +109,7 @@ - + Returns a value and new tree without node with key Key.

Returns a value Value from node with key Key @@ -120,7 +120,7 @@ - + Returns a value and new tree without node with key Key.

Returns a value Value from node with key Key @@ -218,7 +218,7 @@ - + Return an iterator for a tree starting from a specified key. diff --git a/lib/stdlib/doc/src/gen_event.xml b/lib/stdlib/doc/src/gen_event.xml index fc34e51216..ff7da620c7 100644 --- a/lib/stdlib/doc/src/gen_event.xml +++ b/lib/stdlib/doc/src/gen_event.xml @@ -351,7 +351,7 @@ gen_event:stop -----> Module:terminate/2 start() -> Result start(EventMgrName | Options) -> Result - start(EventMgrName, Options) -> Result + start(EventMgrName, Options) -> Result Create a stand-alone event manager process. EventMgrName = {local,Name} | {global,GlobalName} | {via,Module,ViaName} @@ -377,7 +377,7 @@ gen_event:stop -----> Module:terminate/2 start_link() -> Result start_link(EventMgrName | Options) -> Result - start_link(EventMgrName, Options) -> Result + start_link(EventMgrName, Options) -> Result Create a generic event manager process in a supervision tree. @@ -437,7 +437,7 @@ gen_event:stop -----> Module:terminate/2 stop(EventMgrRef) -> ok - stop(EventMgrRef, Reason, Timeout) -> ok + stop(EventMgrRef, Reason, Timeout) -> ok Terminate a generic event manager. EventMgrRef = Name | {Name,Node} | {global,GlobalName} @@ -611,7 +611,7 @@ gen_event:stop -----> Module:terminate/2 - Module:format_status(Opt, [PDict, State]) -> Status + Module:format_status(Opt, [PDict, State]) -> Status Optional function for providing a term describing the current event handler state. diff --git a/lib/stdlib/doc/src/gen_server.xml b/lib/stdlib/doc/src/gen_server.xml index 106bda85f5..f3742fb8fb 100644 --- a/lib/stdlib/doc/src/gen_server.xml +++ b/lib/stdlib/doc/src/gen_server.xml @@ -466,8 +466,8 @@ gen_server:abcast -----> Module:handle_cast/2 - stop(ServerRef) -> ok - stop(ServerRef, Reason, Timeout) -> ok + stop(ServerRef) -> ok + stop(ServerRef, Reason, Timeout) -> ok Synchronously stop a generic server. ServerRef = Name | {Name,Node} | {global,GlobalName} @@ -550,7 +550,7 @@ gen_server:abcast -----> Module:handle_cast/2 - Module:format_status(Opt, [PDict, State]) -> Status + Module:format_status(Opt, [PDict, State]) -> Status Optional function for providing a term describing the current gen_server status. @@ -703,7 +703,7 @@ gen_server:abcast -----> Module:handle_cast/2 - Module:handle_continue(Continue, State) -> Result + Module:handle_continue(Continue, State) -> Result Handle a continue instruction. Continue = term() diff --git a/lib/stdlib/doc/src/gen_statem.xml b/lib/stdlib/doc/src/gen_statem.xml index a808d3af55..aaa26df18d 100644 --- a/lib/stdlib/doc/src/gen_statem.xml +++ b/lib/stdlib/doc/src/gen_statem.xml @@ -28,7 +28,7 @@ - gen_statem + gen_statem Generic state machine behavior.

@@ -1398,8 +1398,8 @@ handle_event(_, _, State, Data) -> - - + + Make a synchronous call to a gen_statem.

@@ -1474,7 +1474,7 @@ handle_event(_, _, State, Data) -> - + Send an asynchronous event to a gen_statem.

@@ -1493,7 +1493,7 @@ handle_event(_, _, State, Data) -> - + Enter the gen_statem receive loop.

@@ -1507,7 +1507,7 @@ handle_event(_, _, State, Data) -> - + Enter the gen_statem receive loop.

@@ -1531,7 +1531,7 @@ handle_event(_, _, State, Data) -> - + Enter the gen_statem receive loop.

@@ -1588,8 +1588,8 @@ handle_event(_, _, State, Data) -> - - + + Reply to a caller.

@@ -1621,8 +1621,8 @@ handle_event(_, _, State, Data) -> - - + + Create a standalone gen_statem process.

@@ -1642,8 +1642,8 @@ handle_event(_, _, State, Data) -> - - + + Create a linked gen_statem process.

@@ -1750,7 +1750,7 @@ handle_event(_, _, State, Data) -> - + Synchronously stop a generic server.

@@ -1761,7 +1761,7 @@ handle_event(_, _, State, Data) -> - + Synchronously stop a generic server.

@@ -1807,7 +1807,7 @@ handle_event(_, _, State, Data) -> - Module:callback_mode() -> CallbackMode + Module:callback_mode() -> CallbackMode Update the internal state during upgrade/downgrade. @@ -1858,7 +1858,7 @@ handle_event(_, _, State, Data) -> - Module:code_change(OldVsn, OldState, OldData, Extra) -> + Module:code_change(OldVsn, OldState, OldData, Extra) -> Result Update the internal state during upgrade/downgrade. @@ -1947,7 +1947,7 @@ handle_event(_, _, State, Data) -> - Module:init(Args) -> Result(StateType) + Module:init(Args) -> Result(StateType) Initializing process and internal state. @@ -1989,7 +1989,7 @@ init(Args) -> erlang:error(not_implemented, [Args]). - Module:format_status(Opt, [PDict,State,Data]) -> + Module:format_status(Opt, [PDict,State,Data]) -> Status Optional function for providing a term describing the @@ -2088,16 +2088,16 @@ init(Args) -> erlang:error(not_implemented, [Args]). - Module:StateName(enter, OldState, Data) -> + Module:StateName(enter, OldState, Data) -> StateEnterResult(StateName) - Module:StateName(EventType, EventContent, Data) -> + Module:StateName(EventType, EventContent, Data) -> StateFunctionResult - Module:handle_event(enter, OldState, State, Data) -> + Module:handle_event(enter, OldState, State, Data) -> StateEnterResult(State) - Module:handle_event(EventType, EventContent, State, Data) -> + Module:handle_event(EventType, EventContent, State, Data) -> HandleEventResult Handle an event. @@ -2216,7 +2216,7 @@ init(Args) -> erlang:error(not_implemented, [Args]). - Module:terminate(Reason, State, Data) -> Ignored + Module:terminate(Reason, State, Data) -> Ignored Clean up before termination. Reason = normal | shutdown | {shutdown,term()} | term() diff --git a/lib/stdlib/doc/src/io.xml b/lib/stdlib/doc/src/io.xml index d4a2713840..943b3479ca 100644 --- a/lib/stdlib/doc/src/io.xml +++ b/lib/stdlib/doc/src/io.xml @@ -794,7 +794,7 @@ enter>: alan : joe - + Read, tokenize, and parse Erlang expressions. @@ -847,7 +847,7 @@ enter>abc("hey". - + Read, tokenize, and parse an Erlang form. @@ -888,7 +888,7 @@ enter>abc("hey". - + Get user-requested printable character range.

Returns the user-requested range of printable Unicode characters.

@@ -961,7 +961,7 @@ enter>abc("hey". - + Read a term. @@ -1012,7 +1012,7 @@ enter>abc("hey". - + Read and tokenize Erlang expressions. @@ -1063,7 +1063,7 @@ enter>1.0er. - + Read and tokenize an Erlang form. diff --git a/lib/stdlib/doc/src/io_lib.xml b/lib/stdlib/doc/src/io_lib.xml index a3df2897ac..8a0b674126 100644 --- a/lib/stdlib/doc/src/io_lib.xml +++ b/lib/stdlib/doc/src/io_lib.xml @@ -99,7 +99,7 @@ - + Build the output text for a preparsed format list.

For details, see @@ -126,7 +126,7 @@ - + Test for a deep list of characters.

Returns true if Term is a, possibly deep, @@ -156,8 +156,8 @@ - - + + Write formatted output.

Returns a character list that represents Data @@ -277,7 +277,7 @@ - + Test for a list of ISO Latin-1 characters.

Returns true if Term is a flat list of @@ -315,7 +315,7 @@ - + Test for a list of printable ISO Latin-1 characters.

Returns true if Term is a flat list of @@ -338,7 +338,7 @@ - + Test for a list of printable Unicode characters.

Returns true if Term is a flat list of @@ -347,7 +347,7 @@ - + Parse all control sequences in the format string.

Returns a list corresponding to the specified format string, @@ -373,7 +373,7 @@ - + Revert a preparsed format list to a plain character list and a list of arguments. @@ -420,7 +420,7 @@ - + Write an atom.

Returns the list of characters needed to print atom @@ -439,7 +439,7 @@ - + Write a character.

Returns the list of characters needed to print a character @@ -449,7 +449,7 @@ - + Write an ISO Latin-1 character.

Returns the list of characters needed to print a character @@ -458,7 +458,7 @@ - + Write an ISO Latin-1 string.

Returns the list of characters needed to print @@ -476,7 +476,7 @@ - + Write a string.

Returns the list of characters needed to print diff --git a/lib/stdlib/doc/src/lists.xml b/lib/stdlib/doc/src/lists.xml index e4215a5336..f126326b09 100644 --- a/lib/stdlib/doc/src/lists.xml +++ b/lib/stdlib/doc/src/lists.xml @@ -137,7 +137,7 @@ - + Drop the last element of a list.

Drops the last element of a List. The list is to @@ -182,7 +182,7 @@ - + Filter and map elements that satisfy a function.

Calls Fun(Elem) on successive @@ -297,7 +297,7 @@ flatmap(Fun, List1) -> - + Insert an element between elements in a list

Inserts Sep between each element in List1. Has no @@ -771,7 +771,7 @@ length(lists:seq(From, To, Incr)) =:= (To - From + Incr) div Incr - + Find the first element that satisfies a predicate.

If there is a Value in List diff --git a/lib/stdlib/doc/src/maps.xml b/lib/stdlib/doc/src/maps.xml index a225dea3b5..acc4850bd9 100644 --- a/lib/stdlib/doc/src/maps.xml +++ b/lib/stdlib/doc/src/maps.xml @@ -27,7 +27,7 @@ 2014-02-28 A - maps + maps Maps processing functions.

This module contains functions for maps processing.

@@ -49,7 +49,7 @@ - + Select pairs that satisfy a predicate.

Returns a map Map for which predicate @@ -68,7 +68,7 @@ - +

Returns a tuple {ok, Value}, where Value @@ -87,7 +87,7 @@ - +

Calls F(K, V, AccIn) for every K to value @@ -111,7 +111,7 @@ - +

Takes a list of key-value tuples elements and builds a map. The @@ -128,7 +128,7 @@ - +

Returns value Value associated with @@ -147,7 +147,7 @@ - +

Returns value Value associated with @@ -168,7 +168,7 @@ val1 - +

Returns true if map Map contains @@ -188,7 +188,7 @@ false - + Create a map iterator.

Returns a map iterator Iterator that can @@ -214,7 +214,7 @@ none - +

Returns a complete list of keys, in any order, which resides @@ -230,7 +230,7 @@ none - +

Produces a new map Map by calling function @@ -253,7 +253,7 @@ none - +

Merges two maps into a single map Map3. If two @@ -271,7 +271,7 @@ none - +

Returns a new empty map.

@@ -283,7 +283,7 @@ none
- + Get the next key and value from an iterator.

Returns the next key-value association in @@ -312,7 +312,7 @@ none - +

Associates Key with value @@ -336,7 +336,7 @@ none - +

Removes the Key, if it exists, and its @@ -356,7 +356,7 @@ none - +

Returns the number of key-value associations in @@ -370,7 +370,7 @@ none - +

The function removes the Key, if it @@ -395,7 +395,7 @@ error - +

Returns a list of pairs representing the key-value associations of @@ -412,7 +412,7 @@ error - +

If Key exists in Map1, the @@ -432,7 +432,7 @@ error - +

Update a value in a Map1 associated @@ -451,7 +451,7 @@ error - +

Update a value in a Map1 associated @@ -471,7 +471,7 @@ error - +

Returns a complete list of values, in arbitrary order, contained in @@ -487,7 +487,7 @@ error - +

Returns a new map Map2 with the keys K1 @@ -504,7 +504,7 @@ error - +

Returns a new map Map2 without keys K1 diff --git a/lib/stdlib/doc/src/math.xml b/lib/stdlib/doc/src/math.xml index b4f096217a..0672da88b9 100644 --- a/lib/stdlib/doc/src/math.xml +++ b/lib/stdlib/doc/src/math.xml @@ -57,15 +57,15 @@ - + - - + + - + diff --git a/lib/stdlib/doc/src/orddict.xml b/lib/stdlib/doc/src/orddict.xml index 26bbf499c6..e4dae4104d 100644 --- a/lib/stdlib/doc/src/orddict.xml +++ b/lib/stdlib/doc/src/orddict.xml @@ -113,7 +113,7 @@ - + Return value and new dictionary without element with this value.

This function returns value from dictionary and new dictionary without this value. @@ -166,7 +166,7 @@ - + Return true if the dictionary is empty.

Returns true if Orddict has no elements, diff --git a/lib/stdlib/doc/src/ordsets.xml b/lib/stdlib/doc/src/ordsets.xml index 11f98c8fb7..d1e24facef 100644 --- a/lib/stdlib/doc/src/ordsets.xml +++ b/lib/stdlib/doc/src/ordsets.xml @@ -142,7 +142,7 @@ - + Test for empty set.

Returns true if Ordset is an empty set, diff --git a/lib/stdlib/doc/src/proc_lib.xml b/lib/stdlib/doc/src/proc_lib.xml index b85fab67d5..8e7308ca74 100644 --- a/lib/stdlib/doc/src/proc_lib.xml +++ b/lib/stdlib/doc/src/proc_lib.xml @@ -111,7 +111,7 @@ - + Format a crash report. @@ -138,7 +138,7 @@ - + Format a crash report. @@ -341,7 +341,7 @@ init(Parent) -> - + Terminate a process synchronously. @@ -351,7 +351,7 @@ init(Parent) -> - + Terminate a process synchronously. diff --git a/lib/stdlib/doc/src/rand.xml b/lib/stdlib/doc/src/rand.xml index 21f680a0ee..27d2d99f3c 100644 --- a/lib/stdlib/doc/src/rand.xml +++ b/lib/stdlib/doc/src/rand.xml @@ -32,7 +32,7 @@ A rand.xml - rand + rand Pseudo random number generation.

@@ -273,7 +273,7 @@ tests. We suggest to use a sign test to extract a random Boolean value. - + Export the random number generation state.

Returns the random number state in an external format. @@ -282,7 +282,7 @@ tests. We suggest to use a sign test to extract a random Boolean value. - + Export the random number generation state.

Returns the random number generator state in an external format. @@ -291,7 +291,7 @@ tests. We suggest to use a sign test to extract a random Boolean value. - + Return the seed after performing jump calculation to the state in the process dictionary. @@ -306,7 +306,7 @@ tests. We suggest to use a sign test to extract a random Boolean value. - + Return the seed after performing jump calculation.

Returns the state after performing jump calculation @@ -318,7 +318,7 @@ tests. We suggest to use a sign test to extract a random Boolean value. - + Return a standard normal distributed random float.

Returns a standard normal deviate float (that is, the mean @@ -328,7 +328,7 @@ tests. We suggest to use a sign test to extract a random Boolean value. - + Return a normal distributed random float.

Returns a normal N(Mean, Variance) deviate float @@ -337,7 +337,7 @@ tests. We suggest to use a sign test to extract a random Boolean value. - + Return a standard normal distributed random float.

Returns, for a specified state, a standard normal @@ -347,7 +347,7 @@ tests. We suggest to use a sign test to extract a random Boolean value. - + Return a normal distributed random float.

Returns, for a specified state, a normal N(Mean, Variance) @@ -356,7 +356,7 @@ tests. We suggest to use a sign test to extract a random Boolean value. - + Seed random number generator. @@ -372,7 +372,7 @@ tests. We suggest to use a sign test to extract a random Boolean value. - + Seed the random number generation.

Seeds random number generation with the specified algorithm and @@ -381,7 +381,7 @@ tests. We suggest to use a sign test to extract a random Boolean value. - + Seed random number generator.

@@ -396,7 +396,7 @@ tests. We suggest to use a sign test to extract a random Boolean value. - + Seed the random number generation.

Seeds random number generation with the specified algorithm and @@ -405,7 +405,7 @@ tests. We suggest to use a sign test to extract a random Boolean value. - + Return a random float.

@@ -441,7 +441,7 @@ end. - + Return a random float.

@@ -477,7 +477,7 @@ end. - + Return a random integer.

Returns, for a specified integer N >= 1, @@ -488,7 +488,7 @@ end. - + Return a random float.

@@ -524,7 +524,7 @@ end. - + Return a random float.

@@ -586,7 +586,7 @@ end. - + Return a random integer.

Returns, for a specified integer N >= 1 diff --git a/lib/stdlib/doc/src/re.xml b/lib/stdlib/doc/src/re.xml index 078ca0e38c..71f49cb640 100644 --- a/lib/stdlib/doc/src/re.xml +++ b/lib/stdlib/doc/src/re.xml @@ -79,7 +79,7 @@ - + Gives the PCRE version of the system in a string format

The return of this function is a string with the PCRE version of the system that was used in the Erlang/OTP compilation.

@@ -304,7 +304,7 @@
- + Inspects a compiled regular expression.

Takes a compiled regular expression and an item, and returns the diff --git a/lib/stdlib/doc/src/sets.xml b/lib/stdlib/doc/src/sets.xml index 8db3e1e623..e076b9a5ec 100644 --- a/lib/stdlib/doc/src/sets.xml +++ b/lib/stdlib/doc/src/sets.xml @@ -140,7 +140,7 @@ - + Test for empty set.

Returns true if Set is an empty set, diff --git a/lib/stdlib/doc/src/shell.xml b/lib/stdlib/doc/src/shell.xml index 2593d3690b..892bb64daf 100644 --- a/lib/stdlib/doc/src/shell.xml +++ b/lib/stdlib/doc/src/shell.xml @@ -902,7 +902,7 @@ q - quit erlang - + Set the shell prompt.

Sets the shell prompt function to PromptFunc. @@ -945,7 +945,7 @@ q - quit erlang - + Set the shell's string recognition flag.

Sets pretty printing of lists to Strings. diff --git a/lib/stdlib/doc/src/string.xml b/lib/stdlib/doc/src/string.xml index 3348464eba..d3b0175d69 100644 --- a/lib/stdlib/doc/src/string.xml +++ b/lib/stdlib/doc/src/string.xml @@ -130,7 +130,7 @@ - + Convert a string to a comparable string.

@@ -147,7 +147,7 @@ - + Remove trailing end of line control characters.

@@ -165,8 +165,8 @@ - - + + Test string equality.

@@ -201,8 +201,8 @@ true - - + + Find start of substring.

@@ -230,7 +230,7 @@ nomatch - + Check if the string is empty.

Returns true if String is the @@ -245,7 +245,7 @@ true - + Calculate length of the string.

@@ -261,7 +261,7 @@ true - + Split string into lexemes.

@@ -287,7 +287,7 @@ true - + Convert a string to lowercase

@@ -306,7 +306,7 @@ true - + Pick the first codepoint.

@@ -323,7 +323,7 @@ true - + Pick the first grapheme cluster.

@@ -340,7 +340,7 @@ true - + Pick the nth lexeme.

Returns lexeme number N in @@ -355,9 +355,9 @@ true - - - + + + Pad a string to given length.

@@ -381,7 +381,7 @@ true - + Remove prefix from string.

@@ -400,8 +400,8 @@ nomatch - - + + Replace a pattern in string.

@@ -423,7 +423,7 @@ nomatch - + Reverses a string

@@ -439,8 +439,8 @@ ÖÄÅ - - + + Extract a part of string

Returns a substring of String of @@ -459,8 +459,8 @@ ÖÄÅ - - + + Split a string into substrings.

@@ -482,9 +482,9 @@ ÖÄÅ - - - + + + Take leading or trailing parts.

Takes characters from String as long as @@ -508,7 +508,7 @@ ÖÄÅ - + Convert a string to titlecase.

@@ -566,7 +566,7 @@ ÖÄÅ - + Convert a string to a list of grapheme clusters.

@@ -582,9 +582,9 @@ ÖÄÅ - - - + + + Trim leading or trailing, or both, characters.

@@ -616,7 +616,7 @@ ÖÄÅ - + Convert a string to uppercase.

diff --git a/lib/stdlib/doc/src/supervisor.xml b/lib/stdlib/doc/src/supervisor.xml index 5fd5760499..eb6168c002 100644 --- a/lib/stdlib/doc/src/supervisor.xml +++ b/lib/stdlib/doc/src/supervisor.xml @@ -329,7 +329,7 @@ child_spec() = #{id => child_id(), % mandatory - + Return counts for the number of child specifications, active children, supervisors, and workers. @@ -387,7 +387,7 @@ child_spec() = #{id => child_id(), % mandatory - + Return the child specification map for the specified child. diff --git a/lib/stdlib/doc/src/sys.xml b/lib/stdlib/doc/src/sys.xml index 9fe816e33a..040f6587ec 100644 --- a/lib/stdlib/doc/src/sys.xml +++ b/lib/stdlib/doc/src/sys.xml @@ -143,8 +143,8 @@ - - + + Get the state of the process.

Gets the state of the process.

@@ -338,8 +338,8 @@
- - + + Replace the state of the process.

Replaces the state of the process, and returns the new state.

@@ -482,8 +482,8 @@
- - + + Terminate the process.

Orders the process to terminate with the @@ -644,7 +644,7 @@ - Module:system_get_state(Misc) -> {ok, State} + Module:system_get_state(Misc) -> {ok, State} Called when the process is to return its current state. @@ -661,7 +661,7 @@ - Module:system_replace_state(StateFun, Misc) -> + Module:system_replace_state(StateFun, Misc) -> {ok, NState, NMisc} Called when the process is to replace its current state. diff --git a/lib/stdlib/doc/src/timer.xml b/lib/stdlib/doc/src/timer.xml index e913e33589..885bb89b1a 100644 --- a/lib/stdlib/doc/src/timer.xml +++ b/lib/stdlib/doc/src/timer.xml @@ -258,8 +258,8 @@ - - + + Measure the real time it takes to evaluate apply(Module, Function, Arguments) or apply(Fun, Arguments). diff --git a/lib/stdlib/doc/src/unicode.xml b/lib/stdlib/doc/src/unicode.xml index d822aca89c..2451006564 100644 --- a/lib/stdlib/doc/src/unicode.xml +++ b/lib/stdlib/doc/src/unicode.xml @@ -367,7 +367,7 @@ decode_data(Data) -> - + Normalize characters to a list of canonical equivalent composed Unicode characters. @@ -386,7 +386,7 @@ decode_data(Data) -> - + Normalize characters to a utf8 binary of canonical equivalent composed Unicode characters. @@ -404,7 +404,7 @@ decode_data(Data) -> - + Normalize characters to a list of canonical equivalent decomposed Unicode characters. @@ -423,7 +423,7 @@ decode_data(Data) -> - + Normalize characters to a utf8 binary of canonical equivalent decomposed Unicode characters. @@ -441,7 +441,7 @@ decode_data(Data) -> - + Normalize characters to a list of canonical equivalent composed Unicode characters. @@ -460,7 +460,7 @@ decode_data(Data) -> - + Normalize characters to a utf8 binary of compatibly equivalent composed Unicode characters. @@ -478,7 +478,7 @@ decode_data(Data) -> - + Normalize characters to a list of compatibly equivalent decomposed Unicode characters. @@ -497,7 +497,7 @@ decode_data(Data) -> - + Normalize characters to a utf8 binary of compatibly equivalent decomposed Unicode characters. diff --git a/lib/stdlib/doc/src/uri_string.xml b/lib/stdlib/doc/src/uri_string.xml index 88d4600611..ad443486c5 100644 --- a/lib/stdlib/doc/src/uri_string.xml +++ b/lib/stdlib/doc/src/uri_string.xml @@ -27,7 +27,7 @@ 2018-02-07 A - uri_string + uri_string URI processing functions.

This module contains functions for parsing and handling URIs @@ -150,7 +150,7 @@ - + Compose urlencoded query string.

Composes a form-urlencoded QueryString based on a @@ -176,7 +176,7 @@ - + Compose urlencoded query string.

Same as compose_query/1 but with an additional @@ -210,7 +210,7 @@ - + Dissect query string.

Dissects an urlencoded QueryString and returns a @@ -236,7 +236,7 @@ - + Syntax-based normalization.

Transforms an URI into a normalized form @@ -261,7 +261,7 @@ - + Syntax-based normalization.

Same as normalize/1 but with an additional @@ -285,7 +285,7 @@ - + Parse URI into a map.

Parses an RFC 3986 @@ -309,7 +309,7 @@ - + Recompose URI.

Creates an RFC 3986 compliant @@ -332,7 +332,7 @@ - + Transcode URI.

Transcodes an RFC 3986 diff --git a/lib/stdlib/doc/src/zip.xml b/lib/stdlib/doc/src/zip.xml index 0b5eac1e16..aaa25952c2 100644 --- a/lib/stdlib/doc/src/zip.xml +++ b/lib/stdlib/doc/src/zip.xml @@ -180,7 +180,7 @@ - + Fold a function over all files in a zip archive.

Calls Fun(FileInArchive, GetInfo diff --git a/lib/tftp/doc/src/tftp.xml b/lib/tftp/doc/src/tftp.xml index 4ed54bc462..e72a4ec985 100644 --- a/lib/tftp/doc/src/tftp.xml +++ b/lib/tftp/doc/src/tftp.xml @@ -389,7 +389,7 @@ - Module:abort(Code, Text, State) -> ok + Module:abort(Code, Text, State) -> ok Aborts the file transfer. Code = undef | enoent | eacces | enospc @@ -413,7 +413,7 @@ - Module:open(Peer, Access, Filename, Mode, SuggestedOptions, State) -> {ok, AcceptedOptions, NewState} | {error, {Code, Text}} + Module:open(Peer, Access, Filename, Mode, SuggestedOptions, State) -> {ok, AcceptedOptions, NewState} | {error, {Code, Text}} Opens a file for read or write access. Peer = {PeerType, PeerHost, PeerPort} @@ -448,7 +448,7 @@ - Module:prepare(Peer, Access, Filename, Mode, SuggestedOptions, InitialState) -> {ok, AcceptedOptions, NewState} | {error, {Code, Text}} + Module:prepare(Peer, Access, Filename, Mode, SuggestedOptions, InitialState) -> {ok, AcceptedOptions, NewState} | {error, {Code, Text}} Prepares to open a file on the client side. Peer = {PeerType, PeerHost, PeerPort} @@ -483,7 +483,7 @@ - Module:read(State) -> {more, Bin, NewState} | {last, Bin, FileSize} | {error, {Code, Text}} + Module:read(State) -> {more, Bin, NewState} | {last, Bin, FileSize} | {error, {Code, Text}} Reads a chunk from the file. State = NewState = term() @@ -510,7 +510,7 @@ - Module:write(Bin, State) -> {more, NewState} | {last, FileSize} | {error, {Code, Text}} + Module:write(Bin, State) -> {more, NewState} | {last, FileSize} | {error, {Code, Text}} Writes a chunk to the file. Bin = binary() @@ -549,7 +549,7 @@ - Logger:error_msg(Format, Data) -> ok | exit(Reason) + Logger:error_msg(Format, Data) -> ok | exit(Reason) Logs an error message. Format = string() @@ -565,7 +565,7 @@ - Logger:info_msg(Format, Data) -> ok | exit(Reason) + Logger:info_msg(Format, Data) -> ok | exit(Reason) Logs an info message. Format = string() @@ -579,7 +579,7 @@ - Logger:warning_msg(Format, Data) -> ok | exit(Reason) + Logger:warning_msg(Format, Data) -> ok | exit(Reason) Logs a warning message. Format = string() 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 From 8084754341acd6363ff975b6dd758f1eb6514332 Mon Sep 17 00:00:00 2001 From: Sverker Eriksson Date: Tue, 11 Dec 2018 19:49:51 +0100 Subject: Add since attribute to dtd --- lib/erl_docgen/priv/dtd/cref.dtd | 2 ++ lib/erl_docgen/priv/dtd/erlref.dtd | 2 ++ 2 files changed, 4 insertions(+) (limited to 'lib') diff --git a/lib/erl_docgen/priv/dtd/cref.dtd b/lib/erl_docgen/priv/dtd/cref.dtd index 5ccd98ed89..d392081807 100644 --- a/lib/erl_docgen/priv/dtd/cref.dtd +++ b/lib/erl_docgen/priv/dtd/cref.dtd @@ -30,6 +30,8 @@ + + diff --git a/lib/erl_docgen/priv/dtd/erlref.dtd b/lib/erl_docgen/priv/dtd/erlref.dtd index 78d6771f52..8202ea5a4d 100644 --- a/lib/erl_docgen/priv/dtd/erlref.dtd +++ b/lib/erl_docgen/priv/dtd/erlref.dtd @@ -25,6 +25,7 @@ + - handle_trans_request(ConnHandle, ProtocolVersion, ActionRequests) -> pending() | reply() | ignore_trans_request - handle_trans_request(ConnHandle, ProtocolVersion, ActionRequests, Extra) -> pending() | reply() | ignore_trans_request + handle_trans_request(ConnHandle, ProtocolVersion, ActionRequests) -> pending() | reply() | ignore_trans_request + handle_trans_request(ConnHandle, ProtocolVersion, ActionRequests, Extra) -> pending() | reply() | ignore_trans_request Invoked for each transaction request ConnHandle = conn_handle() @@ -420,8 +420,8 @@ protocol_version() = integer() ]]> - handle_trans_long_request(ConnHandle, ProtocolVersion, ReqData) -> reply() - handle_trans_long_request(ConnHandle, ProtocolVersion, ReqData, Extra) -> reply() + handle_trans_long_request(ConnHandle, ProtocolVersion, ReqData) -> reply() + handle_trans_long_request(ConnHandle, ProtocolVersion, ReqData, Extra) -> reply() Optionally invoked for a time consuming transaction request ConnHandle = conn_handle() @@ -460,8 +460,8 @@ protocol_version() = integer() ]]> - handle_trans_reply(ConnHandle, ProtocolVersion, UserReply, ReplyData) -> ok - handle_trans_reply(ConnHandle, ProtocolVersion, UserReply, ReplyData, Extra) -> ok + handle_trans_reply(ConnHandle, ProtocolVersion, UserReply, ReplyData) -> ok + handle_trans_reply(ConnHandle, ProtocolVersion, UserReply, ReplyData, Extra) -> ok Optionally invoked for a transaction reply ConnHandle = conn_handle() @@ -593,8 +593,8 @@ protocol_version() = integer() ]]> - handle_trans_ack(ConnHandle, ProtocolVersion, AckStatus, AckData) -> ok - handle_trans_ack(ConnHandle, ProtocolVersion, AckStatus, AckData, Extra) -> ok + handle_trans_ack(ConnHandle, ProtocolVersion, AckStatus, AckData) -> ok + handle_trans_ack(ConnHandle, ProtocolVersion, AckStatus, AckData, Extra) -> ok Optionally invoked for a transaction acknowledgement ConnHandle = conn_handle() @@ -658,8 +658,8 @@ protocol_version() = integer() ]]> - handle_unexpected_trans(ConnHandle, ProtocolVersion, Trans) -> ok - handle_unexpected_trans(ConnHandle, ProtocolVersion, Trans, Extra) -> ok + handle_unexpected_trans(ConnHandle, ProtocolVersion, Trans) -> ok + handle_unexpected_trans(ConnHandle, ProtocolVersion, Trans, Extra) -> ok Invoked when an unexpected message is received ConnHandle = conn_handle() @@ -685,8 +685,8 @@ protocol_version() = integer() ]]> - handle_trans_request_abort(ConnHandle, ProtocolVersion, TransNo, Pid) -> ok - handle_trans_request_abort(ConnHandle, ProtocolVersion, TransNo, Pid, Extra) -> ok + handle_trans_request_abort(ConnHandle, ProtocolVersion, TransNo, Pid) -> ok + handle_trans_request_abort(ConnHandle, ProtocolVersion, TransNo, Pid, Extra) -> ok Invoked when an transaction request has been aborted ConnHandle = conn_handle() @@ -710,8 +710,8 @@ protocol_version() = integer() ]]> - handle_segment_reply(ConnHandle, ProtocolVersion, TransNo, SegNo, SegCompl) -> ok - handle_segment_reply(ConnHandle, ProtocolVersion, TransNo, SegNo, SegCompl, Extra) -> ok + handle_segment_reply(ConnHandle, ProtocolVersion, TransNo, SegNo, SegCompl) -> ok + handle_segment_reply(ConnHandle, ProtocolVersion, TransNo, SegNo, SegCompl, Extra) -> ok Segment Reply Indication ConnHandle = conn_handle() diff --git a/lib/mnesia/doc/src/mnesia.xml b/lib/mnesia/doc/src/mnesia.xml index 5f11b55ab9..921721d4b7 100644 --- a/lib/mnesia/doc/src/mnesia.xml +++ b/lib/mnesia/doc/src/mnesia.xml @@ -32,7 +32,7 @@ - mnesia + mnesia A distributed telecommunications DBMS @@ -183,7 +183,7 @@ - abort(Reason) -> transaction abort + abort(Reason) -> transaction abort Terminates the current transaction.

Makes the transaction silently @@ -195,7 +195,7 @@ - activate_checkpoint(Args) -> {ok,Name,Nodes} | {error,Reason} + activate_checkpoint(Args) -> {ok,Name,Nodes} | {error,Reason} Activates a checkpoint. @@ -259,7 +259,7 @@ - activity(AccessContext, Fun [, Args]) -> ResultOfFun | exit(Reason) + activity(AccessContext, Fun [, Args]) -> ResultOfFun | exit(Reason) Executes Fun in AccessContext. @@ -271,7 +271,7 @@ - activity(AccessContext, Fun, Args, AccessMod) -> ResultOfFun | exit(Reason) + activity(AccessContext, Fun, Args, AccessMod) -> ResultOfFun | exit(Reason) Executes Fun in AccessContext. @@ -403,7 +403,7 @@ - add_table_copy(Tab, Node, Type) -> {aborted, R} | {atomic, ok} + add_table_copy(Tab, Node, Type) -> {aborted, R} | {atomic, ok} Copies a table to a remote node. @@ -420,7 +420,7 @@ mnesia:add_table_copy(person, Node, disc_copies) - add_table_index(Tab, AttrName) -> {aborted, R} | {atomic, ok} + add_table_index(Tab, AttrName) -> {aborted, R} | {atomic, ok} Creates an index for a table. @@ -441,7 +441,7 @@ mnesia:add_table_index(person, age) - all_keys(Tab) -> KeyList | transaction abort + all_keys(Tab) -> KeyList | transaction abort Returns all keys in a table. @@ -453,7 +453,7 @@ mnesia:add_table_index(person, age) - async_dirty(Fun, [, Args]) -> ResultOfFun | exit(Reason) + async_dirty(Fun, [, Args]) -> ResultOfFun | exit(Reason) Calls the Fun in a context that is not protected by a transaction. @@ -493,7 +493,7 @@ mnesia:add_table_index(person, age) - backup(Opaque [, BackupMod]) -> ok | {error,Reason} + backup(Opaque [, BackupMod]) -> ok | {error,Reason} Backs up all tables in the database. @@ -505,7 +505,7 @@ mnesia:add_table_index(person, age) - backup_checkpoint(Name, Opaque [, BackupMod]) -> ok | {error,Reason} + backup_checkpoint(Name, Opaque [, BackupMod]) -> ok | {error,Reason} Backs up all tables in a checkpoint. @@ -520,7 +520,7 @@ mnesia:add_table_index(person, age) - change_config(Config, Value) -> {error, Reason} | {ok, ReturnValue} + change_config(Config, Value) -> {error, Reason} | {ok, ReturnValue} Changes a configuration parameter. @@ -554,7 +554,7 @@ mnesia:add_table_index(person, age) - change_table_access_mode(Tab, AccessMode) -> {aborted, R} | {atomic, ok} + change_table_access_mode(Tab, AccessMode) -> {aborted, R} | {atomic, ok} Changes the access mode for the table. @@ -568,7 +568,7 @@ mnesia:add_table_index(person, age) - change_table_copy_type(Tab, Node, To) -> {aborted, R} | {atomic, ok} + change_table_copy_type(Tab, Node, To) -> {aborted, R} | {atomic, ok} Changes the storage type of a table. @@ -585,7 +585,7 @@ mnesia:change_table_copy_type(person, node(), disc_copies) - change_table_load_order(Tab, LoadOrder) -> {aborted, R} | {atomic, ok} + change_table_load_order(Tab, LoadOrder) -> {aborted, R} | {atomic, ok} Changes the load order priority for the table. @@ -607,7 +607,7 @@ mnesia:change_table_copy_type(person, node(), disc_copies) - clear_table(Tab) -> {aborted, R} | {atomic, ok} + clear_table(Tab) -> {aborted, R} | {atomic, ok} Deletes all entries in a table. @@ -615,7 +615,7 @@ mnesia:change_table_copy_type(person, node(), disc_copies) - create_schema(DiscNodes) -> ok | {error,Reason} + create_schema(DiscNodes) -> ok | {error,Reason} Creates a new schema on the specified nodes. @@ -637,7 +637,7 @@ mnesia:change_table_copy_type(person, node(), disc_copies) - create_table(Name, TabDef) -> {atomic, ok} | {aborted, Reason} + create_table(Name, TabDef) -> {atomic, ok} | {aborted, Reason} Creates a Mnesia table called Namewith properties as described by argument TabDef. @@ -799,7 +799,7 @@ mnesia:create_table(person, - deactivate_checkpoint(Name) -> ok | {error, Reason} + deactivate_checkpoint(Name) -> ok | {error, Reason} Deactivates a checkpoint. @@ -811,7 +811,7 @@ mnesia:create_table(person, - del_table_copy(Tab, Node) -> {aborted, R} | {atomic, ok} + del_table_copy(Tab, Node) -> {aborted, R} | {atomic, ok} Deletes the replica of table Tab at node Node. @@ -825,7 +825,7 @@ mnesia:create_table(person, - del_table_index(Tab, AttrName) -> {aborted, R} | {atomic, ok} + del_table_index(Tab, AttrName) -> {aborted, R} | {atomic, ok} Deletes an index in a table. @@ -834,7 +834,7 @@ mnesia:create_table(person, - delete({Tab, Key}) -> transaction abort | ok + delete({Tab, Key}) -> transaction abort | ok Deletes all records in table Tab with the key Key. @@ -842,7 +842,7 @@ mnesia:create_table(person, - delete(Tab, Key, LockKind) -> transaction abort | ok + delete(Tab, Key, LockKind) -> transaction abort | ok Deletes all records in table Tabwith the key Key. @@ -857,7 +857,7 @@ mnesia:create_table(person, - delete_object(Record) -> transaction abort | ok + delete_object(Record) -> transaction abort | ok Delete a record. @@ -866,7 +866,7 @@ mnesia:create_table(person, - delete_object(Tab, Record, LockKind) -> transaction abort | ok + delete_object(Tab, Record, LockKind) -> transaction abort | ok Deletes a record. @@ -883,7 +883,7 @@ mnesia:create_table(person, - delete_schema(DiscNodes) -> ok | {error,Reason} + delete_schema(DiscNodes) -> ok | {error,Reason} Deletes the schema on the given nodes. @@ -904,7 +904,7 @@ mnesia:create_table(person, - delete_table(Tab) -> {aborted, Reason} | {atomic, ok} + delete_table(Tab) -> {aborted, Reason} | {atomic, ok} Deletes permanently all replicas of table Tab. @@ -912,7 +912,7 @@ mnesia:create_table(person, - dirty_all_keys(Tab) -> KeyList | exit({aborted, Reason}) + dirty_all_keys(Tab) -> KeyList | exit({aborted, Reason}) Dirty search for all record keys in table. @@ -920,7 +920,7 @@ mnesia:create_table(person, - dirty_delete({Tab, Key}) -> ok | exit({aborted, Reason}) + dirty_delete({Tab, Key}) -> ok | exit({aborted, Reason}) Dirty delete of a record. @@ -928,14 +928,14 @@ mnesia:create_table(person, - dirty_delete(Tab, Key) -> ok | exit({aborted, Reason}) + dirty_delete(Tab, Key) -> ok | exit({aborted, Reason}) Dirty delete of a record.

Dirty equivalent of the function mnesia:delete/3.

- dirty_delete_object(Record) + dirty_delete_object(Record) Dirty delete of a record. @@ -944,14 +944,14 @@ mnesia:create_table(person, - dirty_delete_object(Tab, Record) + dirty_delete_object(Tab, Record) Dirty delete of a record.

Dirty equivalent of the function mnesia:delete_object/3.

- dirty_first(Tab) -> Key | exit({aborted, Reason}) + dirty_first(Tab) -> Key | exit({aborted, Reason}) Returns the key for the first record in a table. @@ -967,7 +967,7 @@ mnesia:create_table(person, - dirty_index_match_object(Pattern, Pos) + dirty_index_match_object(Pattern, Pos) Dirty pattern match using index. @@ -977,7 +977,7 @@ mnesia:create_table(person, - dirty_index_match_object(Tab, Pattern, Pos) + dirty_index_match_object(Tab, Pattern, Pos) Dirty pattern match using index.

Dirty equivalent of the function @@ -985,7 +985,7 @@ mnesia:create_table(person, - dirty_index_read(Tab, SecondaryKey, Pos) + dirty_index_read(Tab, SecondaryKey, Pos) Dirty read using index. @@ -994,7 +994,7 @@ mnesia:create_table(person, - dirty_last(Tab) -> Key | exit({aborted, Reason}) + dirty_last(Tab) -> Key | exit({aborted, Reason}) Returns the key for the last record in a table. @@ -1006,7 +1006,7 @@ mnesia:create_table(person, - dirty_match_object(Pattern) -> RecordList | exit({aborted, Reason}) + dirty_match_object(Pattern) -> RecordList | exit({aborted, Reason}) Dirty pattern match pattern. @@ -1015,7 +1015,7 @@ mnesia:create_table(person, - dirty_match_object(Tab, Pattern) -> RecordList | exit({aborted, Reason}) + dirty_match_object(Tab, Pattern) -> RecordList | exit({aborted, Reason}) Dirty pattern match pattern.

Dirty equivalent of the function @@ -1023,7 +1023,7 @@ mnesia:create_table(person, - dirty_next(Tab, Key) -> Key | exit({aborted, Reason}) + dirty_next(Tab, Key) -> Key | exit({aborted, Reason}) Return the next key in a table. @@ -1038,7 +1038,7 @@ mnesia:create_table(person, - dirty_prev(Tab, Key) -> Key | exit({aborted, Reason}) + dirty_prev(Tab, Key) -> Key | exit({aborted, Reason}) Returns the previous key in a table. @@ -1050,7 +1050,7 @@ mnesia:create_table(person, - dirty_read({Tab, Key}) -> ValueList | exit({aborted, Reason} + dirty_read({Tab, Key}) -> ValueList | exit({aborted, Reason} Dirty read of records. @@ -1058,14 +1058,14 @@ mnesia:create_table(person, - dirty_read(Tab, Key) -> ValueList | exit({aborted, Reason} + dirty_read(Tab, Key) -> ValueList | exit({aborted, Reason} Dirty read of records.

Dirty equivalent of the function mnesia:read/3.

- dirty_select(Tab, MatchSpec) -> ValueList | exit({aborted, Reason} + dirty_select(Tab, MatchSpec) -> ValueList | exit({aborted, Reason} Dirty matches the objects in Tab against MatchSpec. @@ -1073,7 +1073,7 @@ mnesia:create_table(person, - dirty_slot(Tab, Slot) -> RecordList | exit({aborted, Reason}) + dirty_slot(Tab, Slot) -> RecordList | exit({aborted, Reason}) Returns the list of records that are associated with Slot in a table. @@ -1089,7 +1089,7 @@ mnesia:create_table(person, - dirty_update_counter({Tab, Key}, Incr) -> NewVal | exit({aborted, Reason}) + dirty_update_counter({Tab, Key}, Incr) -> NewVal | exit({aborted, Reason}) Dirty update of a counter record. @@ -1097,7 +1097,7 @@ mnesia:create_table(person, - dirty_update_counter(Tab, Key, Incr) -> NewVal | exit({aborted, Reason}) + dirty_update_counter(Tab, Key, Incr) -> NewVal | exit({aborted, Reason}) Dirty update of a counter record.

Mnesia has no special counter records. However, @@ -1126,7 +1126,7 @@ mnesia:create_table(person, - dirty_write(Record) -> ok | exit({aborted, Reason}) + dirty_write(Record) -> ok | exit({aborted, Reason}) Dirty write of a record. @@ -1135,14 +1135,14 @@ mnesia:create_table(person, - dirty_write(Tab, Record) -> ok | exit({aborted, Reason}) + dirty_write(Tab, Record) -> ok | exit({aborted, Reason}) Dirty write of a record.

Dirty equivalent of the function mnesia:write/3.

- dump_log() -> dumped + dump_log() -> dumped Performs a user-initiated dump of the local log file. @@ -1156,7 +1156,7 @@ mnesia:create_table(person, - dump_tables(TabList) -> {atomic, ok} | {aborted, Reason} + dump_tables(TabList) -> {atomic, ok} | {aborted, Reason} Dumps all RAM tables to disc. @@ -1168,7 +1168,7 @@ mnesia:create_table(person, - dump_to_textfile(Filename) + dump_to_textfile(Filename) Dumps local tables into a text file. @@ -1181,7 +1181,7 @@ mnesia:create_table(person, - error_description(Error) -> String + error_description(Error) -> String Returns a string describing a particular Mnesia error. @@ -1259,7 +1259,7 @@ mnesia:create_table(person, - ets(Fun, [, Args]) -> ResultOfFun | exit(Reason) + ets(Fun, [, Args]) -> ResultOfFun | exit(Reason) Calls the Fun in a raw context that is not protected by a transaction. @@ -1278,7 +1278,7 @@ mnesia:create_table(person, - first(Tab) -> Key | transaction abort + first(Tab) -> Key | transaction abort Returns the key for the first record in a table. @@ -1293,7 +1293,7 @@ mnesia:create_table(person, - foldl(Function, Acc, Table) -> NewAcc | transaction abort + foldl(Function, Acc, Table) -> NewAcc | transaction abort Calls Function for each record in Table. @@ -1306,7 +1306,7 @@ mnesia:create_table(person, - foldr(Function, Acc, Table) -> NewAcc | transaction abort + foldr(Function, Acc, Table) -> NewAcc | transaction abort Calls Function for each record in Table. @@ -1317,7 +1317,7 @@ mnesia:create_table(person, - force_load_table(Tab) -> yes | ErrorDescription + force_load_table(Tab) -> yes | ErrorDescription Forces a table to be loaded into the system. @@ -1335,7 +1335,7 @@ mnesia:create_table(person, - index_match_object(Pattern, Pos) -> transaction abort | ObjList + index_match_object(Pattern, Pos) -> transaction abort | ObjList Matches records and uses index information. @@ -1345,7 +1345,7 @@ mnesia:create_table(person, - index_match_object(Tab, Pattern, Pos, LockKind) -> transaction abort | ObjList + index_match_object(Tab, Pattern, Pos, LockKind) -> transaction abort | ObjList Matches records and uses index information. @@ -1377,7 +1377,7 @@ mnesia:create_table(person, - index_read(Tab, SecondaryKey, Pos) -> transaction abort | RecordList + index_read(Tab, SecondaryKey, Pos) -> transaction abort | RecordList Reads records through index table. @@ -1397,7 +1397,7 @@ mnesia:create_table(person, - info() -> ok + info() -> ok Prints system information on the terminal. @@ -1408,7 +1408,7 @@ mnesia:create_table(person, - install_fallback(Opaque) -> ok | {error,Reason} + install_fallback(Opaque) -> ok | {error,Reason} Installs a backup as fallback. @@ -1417,7 +1417,7 @@ mnesia:create_table(person, - install_fallback(Opaque), BackupMod) -> ok | {error,Reason} + install_fallback(Opaque), BackupMod) -> ok | {error,Reason} Installs a backup as fallback.

Calls mnesia:install_fallback(Opaque, Args), where @@ -1425,7 +1425,7 @@ mnesia:create_table(person, - install_fallback(Opaque, Args) -> ok | {error,Reason} + install_fallback(Opaque, Args) -> ok | {error,Reason} Installs a backup as fallback.

Installs a backup as fallback. The fallback is used to @@ -1483,7 +1483,7 @@ mnesia:create_table(person, - is_transaction() -> boolean + is_transaction() -> boolean Checks if code is running in a transaction. @@ -1492,7 +1492,7 @@ mnesia:create_table(person, - last(Tab) -> Key | transaction abort + last(Tab) -> Key | transaction abort Returns the key for the last record in a table.

Works exactly like @@ -1503,7 +1503,7 @@ mnesia:create_table(person, - load_textfile(Filename) + load_textfile(Filename) Loads tables from a text file. @@ -1516,7 +1516,7 @@ mnesia:create_table(person, - lock(LockItem, LockKind) -> Nodes | ok | transaction abort + lock(LockItem, LockKind) -> Nodes | ok | transaction abort Explicit grab lock. @@ -1605,7 +1605,7 @@ mnesia:create_table(person, - match_object(Pattern) -> transaction abort | RecList + match_object(Pattern) -> transaction abort | RecList Matches Pattern for records. @@ -1614,7 +1614,7 @@ mnesia:create_table(person, - match_object(Tab, Pattern, LockKind) -> transaction abort | RecList + match_object(Tab, Pattern, LockKind) -> transaction abort | RecList Matches Pattern for records. @@ -1639,7 +1639,7 @@ mnesia:create_table(person, - move_table_copy(Tab, From, To) -> {aborted, Reason} | {atomic, ok} + move_table_copy(Tab, From, To) -> {aborted, Reason} | {atomic, ok} Moves the copy of table Tab from node From to node To. @@ -1653,7 +1653,7 @@ mnesia:create_table(person, - next(Tab, Key) -> Key | transaction abort + next(Tab, Key) -> Key | transaction abort Returns the next key in a table. @@ -1665,7 +1665,7 @@ mnesia:create_table(person, - prev(Tab, Key) -> Key | transaction abort + prev(Tab, Key) -> Key | transaction abort Returns the previous key in a table.

Works exactly like @@ -1676,7 +1676,7 @@ mnesia:create_table(person, - read({Tab, Key}) -> transaction abort | RecordList + read({Tab, Key}) -> transaction abort | RecordList Reads records(s) with a given key. @@ -1684,14 +1684,14 @@ mnesia:create_table(person, - read(Tab, Key) -> transaction abort | RecordList + read(Tab, Key) -> transaction abort | RecordList Reads records(s) with a given key.

Calls function mnesia:read(Tab, Key, read).

- read(Tab, Key, LockKind) -> transaction abort | RecordList + read(Tab, Key, LockKind) -> transaction abort | RecordList Reads records(s) with a given key. @@ -1716,7 +1716,7 @@ mnesia:create_table(person, - read_lock_table(Tab) -> ok | transaction abort + read_lock_table(Tab) -> ok | transaction abort Sets a read lock on an entire table. @@ -1725,7 +1725,7 @@ mnesia:create_table(person, - report_event(Event) -> ok + report_event(Event) -> ok Reports a user event to the Mnesia event handler. @@ -1743,7 +1743,7 @@ mnesia:create_table(person, - restore(Opaque, Args) -> {atomic, RestoredTabs} |{aborted, Reason} + restore(Opaque, Args) -> {atomic, RestoredTabs} |{aborted, Reason} Online restore of backup. @@ -1803,7 +1803,7 @@ mnesia:create_table(person, - s_delete({Tab, Key}) -> ok | transaction abort + s_delete({Tab, Key}) -> ok | transaction abort Sets sticky lock and delete records. @@ -1812,7 +1812,7 @@ mnesia:create_table(person, - s_delete_object(Record) -> ok | transaction abort + s_delete_object(Record) -> ok | transaction abort Sets sticky lock and delete record. @@ -1822,7 +1822,7 @@ mnesia:create_table(person, - s_write(Record) -> ok | transaction abort + s_write(Record) -> ok | transaction abort Writes Record and sets sticky lock. @@ -1832,21 +1832,21 @@ mnesia:create_table(person, - schema() -> ok + schema() -> ok Prints information about all table definitions on the terminal.

Prints information about all table definitions on the terminal.

- schema(Tab) -> ok + schema(Tab) -> ok Prints information about one table definition on the terminal.

Prints information about one table definition on the terminal.

- select(Tab, MatchSpec [, Lock]) -> transaction abort | [Object] + select(Tab, MatchSpec [, Lock]) -> transaction abort | [Object] Matches the objects in Tab against MatchSpec. @@ -1884,7 +1884,7 @@ mnesia:select(Tab,[{MatchHead, [Guard], [Result]}]), - select(Tab, MatchSpec, NObjects, Lock) -> transaction abort | {[Object],Cont} | '$end_of_table' + select(Tab, MatchSpec, NObjects, Lock) -> transaction abort | {[Object],Cont} | '$end_of_table' Matches the objects in Tab against MatchSpec. @@ -1907,7 +1907,7 @@ mnesia:select(Tab,[{MatchHead, [Guard], [Result]}]), - select(Cont) -> transaction abort | {[Object],Cont} | '$end_of_table' + select(Cont) -> transaction abort | {[Object],Cont} | '$end_of_table' Continues selecting objects.

Selects more objects with the match specification initiated @@ -1919,7 +1919,7 @@ mnesia:select(Tab,[{MatchHead, [Guard], [Result]}]), - set_debug_level(Level) -> OldLevel + set_debug_level(Level) -> OldLevel Changes the internal debug level of Mnesia. @@ -1930,7 +1930,7 @@ mnesia:select(Tab,[{MatchHead, [Guard], [Result]}]), - set_master_nodes(MasterNodes) -> ok | {error, Reason} + set_master_nodes(MasterNodes) -> ok | {error, Reason} Sets the master nodes for all tables. @@ -1943,7 +1943,7 @@ mnesia:select(Tab,[{MatchHead, [Guard], [Result]}]), - set_master_nodes(Tab, MasterNodes) -> ok | {error, Reason} + set_master_nodes(Tab, MasterNodes) -> ok | {error, Reason} Sets the master nodes for a table. @@ -1968,14 +1968,14 @@ mnesia:select(Tab,[{MatchHead, [Guard], [Result]}]), - snmp_close_table(Tab) -> {aborted, R} | {atomic, ok} + snmp_close_table(Tab) -> {aborted, R} | {atomic, ok} Removes the possibility for SNMP to manipulate the table.

Removes the possibility for SNMP to manipulate the table.

- snmp_get_mnesia_key(Tab, RowIndex) -> {ok, Key} | undefined + snmp_get_mnesia_key(Tab, RowIndex) -> {ok, Key} | undefined Gets the corresponding Mnesia key from an SNMP index. Tab ::= atom() @@ -1990,7 +1990,7 @@ mnesia:select(Tab,[{MatchHead, [Guard], [Result]}]),
- snmp_get_next_index(Tab, RowIndex) -> {ok, NextIndex} | endOfTable + snmp_get_next_index(Tab, RowIndex) -> {ok, NextIndex} | endOfTable Gets the index of the next lexicographical row. Tab ::= atom() @@ -2006,7 +2006,7 @@ mnesia:select(Tab,[{MatchHead, [Guard], [Result]}]),
- snmp_get_row(Tab, RowIndex) -> {ok, Row} | undefined + snmp_get_row(Tab, RowIndex) -> {ok, Row} | undefined Retrieves a row indexed by an SNMP index. Tab ::= atom() @@ -2019,7 +2019,7 @@ mnesia:select(Tab,[{MatchHead, [Guard], [Result]}]),
- snmp_open_table(Tab, SnmpStruct) -> {aborted, R} | {atomic, ok} + snmp_open_table(Tab, SnmpStruct) -> {aborted, R} | {atomic, ok} Organizes a Mnesia table as an SNMP table. Tab ::= atom() @@ -2073,7 +2073,7 @@ mnesia:create_table(employee,
- start() -> ok | {error, Reason} + start() -> ok | {error, Reason} Starts a local Mnesia system. @@ -2108,7 +2108,7 @@ mnesia:create_table(employee, - stop() -> stopped + stop() -> stopped Stops Mnesia locally. @@ -2117,7 +2117,7 @@ mnesia:create_table(employee, - subscribe(EventCategory) -> {ok, Node} | {error, Reason} + subscribe(EventCategory) -> {ok, Node} | {error, Reason} Subscribes to events of type EventCategory. @@ -2127,7 +2127,7 @@ mnesia:create_table(employee, - sync_dirty(Fun, [, Args]) -> ResultOfFun | exit(Reason) + sync_dirty(Fun, [, Args]) -> ResultOfFun | exit(Reason) Calls the Fun in a context that is not protected by a transaction. @@ -2166,7 +2166,7 @@ mnesia:create_table(employee, - system_info(InfoKey) -> Info | exit({aborted, Reason}) + system_info(InfoKey) -> Info | exit({aborted, Reason}) Returns information about the Mnesia system. @@ -2408,7 +2408,7 @@ mnesia:create_table(employee, - table_info(Tab, InfoKey) -> Info | exit({aborted, Reason}) + table_info(Tab, InfoKey) -> Info | exit({aborted, Reason}) Returns local information about table. @@ -2628,7 +2628,7 @@ raise(Name, Amount) -> - transform_table(Tab, Fun, NewAttributeList, NewRecordName) -> {aborted, R} | {atomic, ok} + transform_table(Tab, Fun, NewAttributeList, NewRecordName) -> {aborted, R} | {atomic, ok} Changes format on all records in table Tab. @@ -2649,7 +2649,7 @@ raise(Name, Amount) -> - transform_table(Tab, Fun, NewAttributeList) -> {aborted, R} | {atomic, ok} + transform_table(Tab, Fun, NewAttributeList) -> {aborted, R} | {atomic, ok} Changes format on all records in table Tab.

Calls mnesia:transform_table(Tab, Fun, @@ -2689,7 +2689,7 @@ raise(Name, Amount) -> - uninstall_fallback() -> ok | {error,Reason} + uninstall_fallback() -> ok | {error,Reason} Uninstalls a fallback. @@ -2698,7 +2698,7 @@ raise(Name, Amount) -> - uninstall_fallback(Args) -> ok | {error,Reason} + uninstall_fallback(Args) -> ok | {error,Reason} Uninstalls a fallback.

Deinstalls a fallback before it @@ -2725,7 +2725,7 @@ raise(Name, Amount) -> - unsubscribe(EventCategory) -> {ok, Node} | {error, Reason} + unsubscribe(EventCategory) -> {ok, Node} | {error, Reason} Subscribes to events of type EventCategory. @@ -2735,7 +2735,7 @@ raise(Name, Amount) -> - wait_for_tables(TabList, Timeout) -> ok | {timeout, BadTabList} | {error, Reason} + wait_for_tables(TabList, Timeout) -> ok | {timeout, BadTabList} | {error, Reason} Waits for tables to be accessible. @@ -2746,7 +2746,7 @@ raise(Name, Amount) -> - wread({Tab, Key}) -> transaction abort | RecordList + wread({Tab, Key}) -> transaction abort | RecordList Reads records with given key. @@ -2754,7 +2754,7 @@ raise(Name, Amount) -> - write(Record) -> transaction abort | ok + write(Record) -> transaction abort | ok Writes a record into the database. @@ -2763,7 +2763,7 @@ raise(Name, Amount) -> - write(Tab, Record, LockKind) -> transaction abort | ok + write(Tab, Record, LockKind) -> transaction abort | ok Writes a record into the database. @@ -2779,7 +2779,7 @@ raise(Name, Amount) -> - write_lock_table(Tab) -> ok | transaction abort + write_lock_table(Tab) -> ok | transaction abort Sets write lock on an entire table. diff --git a/lib/mnesia/doc/src/mnesia_frag_hash.xml b/lib/mnesia/doc/src/mnesia_frag_hash.xml index c233acdb05..ccaba412d0 100644 --- a/lib/mnesia/doc/src/mnesia_frag_hash.xml +++ b/lib/mnesia/doc/src/mnesia_frag_hash.xml @@ -34,7 +34,7 @@ A mnesia_frag_hash.sgml - mnesia_frag_hash + mnesia_frag_hash Defines mnesia_frag_hash callback behavior

This module defines a callback behavior for user-defined hash @@ -50,7 +50,7 @@ - init_state(Tab, State) -> NewState | abort(Reason) + init_state(Tab, State) -> NewState | abort(Reason) Initiates the hash state for a new table. Tab = atom() @@ -72,7 +72,7 @@ - add_frag(State) -> {NewState, IterFrags, AdditionalLockFrags} | abort(Reason) + add_frag(State) -> {NewState, IterFrags, AdditionalLockFrags} | abort(Reason) Starts when a new fragment is added to a fragmented table. State = term() @@ -100,7 +100,7 @@ - del_frag(State) -> {NewState, IterFrags, AdditionalLockFrags} | abort(Reason) + del_frag(State) -> {NewState, IterFrags, AdditionalLockFrags} | abort(Reason) Starts when a fragment is deleted from a fragmented table. State = term() @@ -127,7 +127,7 @@ - key_to_frag_number(State, Key) -> FragNum | abort(Reason) + key_to_frag_number(State, Key) -> FragNum | abort(Reason) Resolves the key of a record into a fragment number. FragNum = integer() @@ -140,7 +140,7 @@ - match_spec_to_frag_numbers(State, MatchSpec) -> FragNums | abort(Reason) + match_spec_to_frag_numbers(State, MatchSpec) -> FragNums | abort(Reason) Resolves a MatchSpec into a list of fragment numbers. MatcSpec = ets_select_match_spec() diff --git a/lib/mnesia/doc/src/mnesia_registry.xml b/lib/mnesia/doc/src/mnesia_registry.xml index a76f716981..18ddc4ab9e 100644 --- a/lib/mnesia/doc/src/mnesia_registry.xml +++ b/lib/mnesia/doc/src/mnesia_registry.xml @@ -34,7 +34,7 @@ A mnesia_registry.sgml - mnesia_registry + mnesia_registry Dump support for registries in erl_interface.

This module is usually part of the erl_interface @@ -57,7 +57,7 @@ - create_table(Tab) -> ok | exit(Reason) + create_table(Tab) -> ok | exit(Reason) Creates a registry table in Mnesia.

A wrapper function for mnesia:create_table/2, @@ -73,7 +73,7 @@ - create_table(Tab, TabDef) -> ok | exit(Reason) + create_table(Tab, TabDef) -> ok | exit(Reason) Creates a customized registry table in Mnesia.

A wrapper function for mnesia:create_table/2, diff --git a/lib/observer/doc/src/crashdump.xml b/lib/observer/doc/src/crashdump.xml index 59679d794e..62c6ff1f25 100644 --- a/lib/observer/doc/src/crashdump.xml +++ b/lib/observer/doc/src/crashdump.xml @@ -34,7 +34,7 @@ PA1 crashdump.xml - crashdump_viewer + crashdump_viewer A WxWidgets based tool for browsing Erlang crashdumps. @@ -46,7 +46,7 @@ - start() -> ok + start() -> ok start(File) -> ok Start the Crashdump Viewer. @@ -62,7 +62,7 @@ - stop() -> ok + stop() -> ok Terminate the Crashdump Viewer.

Terminates the Crashdump Viewer and closes diff --git a/lib/observer/doc/src/etop.xml b/lib/observer/doc/src/etop.xml index dcf3fe252a..f0acc7b5d8 100644 --- a/lib/observer/doc/src/etop.xml +++ b/lib/observer/doc/src/etop.xml @@ -34,7 +34,7 @@ - etop + etop Erlang Top is a tool for presenting information about Erlang processes similar to the information presented by "top" in UNIX. @@ -128,7 +128,7 @@ - config(Key,Value) -> Result + config(Key,Value) -> Result Change the configuration of the tool. Result = ok | {error,Reason} @@ -142,7 +142,7 @@ - dump(File) -> Result + dump(File) -> Result Dump the current display to a file. Result = ok | {error,Reason} @@ -153,7 +153,7 @@ - stop() -> stop + stop() -> stop Terminate etop.

Terminates etop.

diff --git a/lib/observer/doc/src/ttb.xml b/lib/observer/doc/src/ttb.xml index 2aa2b0c8a5..c42bb9c60c 100644 --- a/lib/observer/doc/src/ttb.xml +++ b/lib/observer/doc/src/ttb.xml @@ -33,7 +33,7 @@ PA1 ttb.xml - ttb + ttb A base for building trace tools for distributed systems.

The Trace Tool Builder, ttb, is a base for building trace @@ -76,7 +76,7 @@ ttb:p(all, call). - tracer() -> Result + tracer() -> Result Equivalent to tracer(node()).

Equivalent to tracer(node()).

@@ -84,7 +84,7 @@ ttb:p(all, call).
- tracer(Shortcut) -> Result + tracer(Shortcut) -> Result Handy shortcuts for common tracing settings. Shortcut = shell | dbg @@ -97,7 +97,7 @@ ttb:p(all, call). - tracer(Nodes) -> Result + tracer(Nodes) -> Result Equivalent to tracer(Nodes,[]).

Equivalent to tracer(Nodes,[]).

@@ -105,7 +105,7 @@ ttb:p(all, call).
- tracer(Nodes,Opts) -> Result + tracer(Nodes,Opts) -> Result Start a trace port on each specified node. Result = {ok, ActivatedNodes} | {error,Reason} @@ -243,7 +243,7 @@ ttb:p(all, call). - p(Item,Flags) -> Return + p(Item,Flags) -> Return Set the specified trace flags on the specified processes or ports. Return = {ok,[{Item,MatchDesc}]} @@ -338,7 +338,7 @@ ttb:p(all, call). - list_history() -> History + list_history() -> History Return all calls stored in history. History = [{N,Func,Args}] @@ -352,7 +352,7 @@ ttb:p(all, call). - run_history(N) -> ok | {error, Reason} + run_history(N) -> ok | {error, Reason} Execute one entry of the history. N = integer() | [integer()] @@ -364,7 +364,7 @@ ttb:p(all, call). - write_config(ConfigFile,Config) + write_config(ConfigFile,Config) Equivalent to write_config(ConfigFile,Config,[]).

Equivalent to write_config(ConfigFile,Config,[]).

@@ -372,7 +372,7 @@ ttb:p(all, call).
- write_config(ConfigFile,Config,Opts) -> ok | {error,Reason} + write_config(ConfigFile,Config,Opts) -> ok | {error,Reason} Create a configuration file. ConfigFile = string() @@ -405,7 +405,7 @@ ttb:p(all, call). - run_config(ConfigFile) -> ok | {error,Reason} + run_config(ConfigFile) -> ok | {error,Reason} Execute all entries in a configuration file. ConfigFile = string() @@ -418,7 +418,7 @@ ttb:p(all, call). - run_config(ConfigFile,NumList) -> ok | {error,Reason} + run_config(ConfigFile,NumList) -> ok | {error,Reason} Execute selected entries from a configuration file. ConfigFile = string() @@ -437,7 +437,7 @@ ttb:p(all, call). - list_config(ConfigFile) -> Config | {error,Reason} + list_config(ConfigFile) -> Config | {error,Reason} List all entries in a configuration file. ConfigFile = string() @@ -449,7 +449,7 @@ ttb:p(all, call). - write_trace_info(Key,Info) -> ok + write_trace_info(Key,Info) -> ok Write any information to file .ti. Key = term() @@ -465,7 +465,7 @@ ttb:p(all, call). - seq_trigger_ms() -> MatchSpec + seq_trigger_ms() -> MatchSpec Equivalent to seq_trigger_ms(all).

Equivalent to seq_trigger_ms(all).

@@ -473,7 +473,7 @@ ttb:p(all, call).
- seq_trigger_ms(Flags) -> MatchSpec + seq_trigger_ms(Flags) -> MatchSpec Return a match_spec() which starts sequential tracing. MatchSpec = match_spec() @@ -521,7 +521,7 @@ ttb:p(all, call). - stop() + stop() Equivalent to stop([]).

Equivalent to stop([]).

@@ -529,7 +529,7 @@ ttb:p(all, call).
- stop(Opts) -> stopped | {stopped, Dir} + stop(Opts) -> stopped | {stopped, Dir} Stop tracing and fetch/format logs from all nodes. Opts = Opt | [Opt] @@ -583,7 +583,7 @@ ttb:p(all, call). - format(File) + format(File) Equivalent to format(File,[]).

Equivalent to format(File,[]).

@@ -591,7 +591,7 @@ ttb:p(all, call).
- format(File,Options) -> ok | {error, Reason} + format(File,Options) -> ok | {error, Reason} Format a binary trace log. File = string() | [string()] diff --git a/lib/odbc/doc/src/odbc.xml b/lib/odbc/doc/src/odbc.xml index 4bb1f035f9..4d941b3b36 100644 --- a/lib/odbc/doc/src/odbc.xml +++ b/lib/odbc/doc/src/odbc.xml @@ -29,7 +29,7 @@ - odbc + odbc Erlang ODBC application

This application provides an Erlang interface to communicate @@ -130,8 +130,8 @@ - commit(Ref, CommitMode) -> - commit(Ref, CommitMode, TimeOut) -> ok | {error, Reason} + commit(Ref, CommitMode) -> + commit(Ref, CommitMode, TimeOut) -> ok | {error, Reason} Commits or rollbacks a transaction. Ref = connection_reference() @@ -145,7 +145,7 @@ - connect(ConnectStr, Options) -> {ok, Ref} | {error, Reason} + connect(ConnectStr, Options) -> {ok, Ref} | {error, Reason} Opens a connection to the database. ConnectStr = string() @@ -236,7 +236,7 @@ - disconnect(Ref) -> ok | {error, Reason} + disconnect(Ref) -> ok | {error, Reason} Closes a connection to a database. Ref = connection_reference() @@ -255,8 +255,8 @@ - describe_table(Ref, Table) -> - describe_table(Ref, Table, Timeout) -> {ok, Description} | {error, Reason} + describe_table(Ref, Table) -> + describe_table(Ref, Table, Timeout) -> {ok, Description} | {error, Reason} Queries the database to find out the data types of the columns of the table Table. Ref = connection_reference() @@ -271,8 +271,8 @@ - first(Ref) -> - first(Ref, Timeout) -> {selected, ColNames, Rows} | {error, Reason} + first(Ref) -> + first(Ref, Timeout) -> {selected, ColNames, Rows} | {error, Reason} Returns the first row of the result set and positions a cursor at this row. Ref = connection_reference() @@ -287,8 +287,8 @@ - last(Ref) -> - last(Ref, TimeOut) -> {selected, ColNames, Rows} | {error, Reason} + last(Ref) -> + last(Ref, TimeOut) -> {selected, ColNames, Rows} | {error, Reason} Returns the last row of the result set and positions a cursor at this row. Ref = connection_reference() @@ -303,8 +303,8 @@ - next(Ref) -> - next(Ref, TimeOut) -> {selected, ColNames, Rows} | {error, Reason} + next(Ref) -> + next(Ref, TimeOut) -> {selected, ColNames, Rows} | {error, Reason} Returns the next row of the result set relative the current cursor position and positions the cursor at this row. Ref = connection_reference() @@ -325,8 +325,8 @@ - param_query(Ref, SQLQuery, Params) -> - param_query(Ref, SQLQuery, Params, TimeOut) -> ResultTuple | {error, Reason} + param_query(Ref, SQLQuery, Params) -> + param_query(Ref, SQLQuery, Params, TimeOut) -> ResultTuple | {error, Reason} Executes a parameterized SQL query. Ref = connection_reference() @@ -353,8 +353,8 @@ - prev(Ref) -> - prev(ConnectionReference, TimeOut) -> {selected, ColNames, Rows} | {error, Reason} + prev(Ref) -> + prev(ConnectionReference, TimeOut) -> {selected, ColNames, Rows} | {error, Reason} Returns the previous row of the result set relative the current cursor position and positions the cursor at this row. Ref = connection_reference() @@ -371,8 +371,8 @@ - start() -> - start(Type) -> ok | {error, Reason} + start() -> + start(Type) -> ok | {error, Reason} Starts the odb application. @@ -389,7 +389,7 @@ - stop() -> ok + stop() -> ok Stops the odbc application. @@ -400,8 +400,8 @@ - sql_query(Ref, SQLQuery) -> - sql_query(Ref, SQLQuery, TimeOut) -> ResultTuple | [ResultTuple] |{error, Reason} + sql_query(Ref, SQLQuery) -> + sql_query(Ref, SQLQuery, TimeOut) -> ResultTuple | [ResultTuple] |{error, Reason} Executes a SQL query or a batch of SQL queries. If it is a SELECT query the result set is returned, on the format{selected, ColNames, Rows}. For other query types the tuple {updated, NRows}is returned, and for batched queries, if the driver supports them, this function can also return a list of result tuples. Ref = connection_reference() @@ -429,8 +429,8 @@ - select_count(Ref, SelectQuery) -> - select_count(Ref, SelectQuery, TimeOut) -> {ok, NrRows} | {error, Reason} + select_count(Ref, SelectQuery) -> + select_count(Ref, SelectQuery, TimeOut) -> {ok, NrRows} | {error, Reason} Executes a SQL SELECT query and associates the result set with the connection. A cursor is positioned before the first row in the result set and the tuple {ok, NrRows}is returned. Ref = connection_reference() @@ -453,8 +453,8 @@ - select(Ref, Position, N) -> - select(Ref, Position, N, TimeOut) -> {selected, ColNames, Rows} | {error, Reason} + select(Ref, Position, N) -> + select(Ref, Position, N, TimeOut) -> {selected, ColNames, Rows} | {error, Reason} Selects Nconsecutive rows of the result set. Ref = connection_reference() diff --git a/lib/os_mon/doc/src/cpu_sup.xml b/lib/os_mon/doc/src/cpu_sup.xml index bada165a06..b7adb2bcd2 100644 --- a/lib/os_mon/doc/src/cpu_sup.xml +++ b/lib/os_mon/doc/src/cpu_sup.xml @@ -28,7 +28,7 @@ - cpu_sup + cpu_sup A CPU Load and CPU Utilization Supervisor Process

cpu_sup is a process which supervises the CPU load @@ -76,7 +76,7 @@ - nprocs() -> UnixProcesses | {error, Reason} + nprocs() -> UnixProcesses | {error, Reason} Get the number of UNIX processes running on this host UnixProcesses = int() @@ -90,7 +90,7 @@ - avg1() -> SystemLoad | {error, Reason} + avg1() -> SystemLoad | {error, Reason} Get the system load average for the last minute SystemLoad = int() @@ -104,7 +104,7 @@ - avg5() -> SystemLoad | {error, Reason} + avg5() -> SystemLoad | {error, Reason} Get the system load average for the last five minutes SystemLoad = int() @@ -118,7 +118,7 @@ - avg15() -> SystemLoad | {error, Reason} + avg15() -> SystemLoad | {error, Reason} Get the system load average for the last fifteen minutes SystemLoad = int() @@ -132,7 +132,7 @@ - util() -> CpuUtil | {error, Reason} + util() -> CpuUtil | {error, Reason} Get the CPU utilization CpuUtil = float() @@ -156,7 +156,7 @@ - util(Opts) -> UtilSpec | {error, Reason} + util(Opts) -> UtilSpec | {error, Reason} Get the CPU utilization Opts = [detailed | per_cpu] diff --git a/lib/os_mon/doc/src/disksup.xml b/lib/os_mon/doc/src/disksup.xml index 610ef2c907..116a6dfd19 100644 --- a/lib/os_mon/doc/src/disksup.xml +++ b/lib/os_mon/doc/src/disksup.xml @@ -28,7 +28,7 @@ - disksup + disksup A Disk Supervisor Process

disksup is a process which supervises the available disk @@ -92,7 +92,7 @@ - get_disk_data() -> [DiskData] + get_disk_data() -> [DiskData] Get data for the disks in the system DiskData = {Id, KByte, Capacity} @@ -112,7 +112,7 @@ - get_check_interval() -> MS + get_check_interval() -> MS Get time interval, in milliseconds, for the periodic disk space check MS = int() @@ -123,7 +123,7 @@ - set_check_interval(Minutes) -> ok + set_check_interval(Minutes) -> ok Set time interval, in minutes, for the periodic disk space check Minutes = int()>=1 @@ -138,7 +138,7 @@ - get_almost_full_threshold() -> Percent + get_almost_full_threshold() -> Percent Get threshold, in percent, for disk space utilization Percent = int() @@ -148,7 +148,7 @@ - set_almost_full_threshold(Float) -> ok + set_almost_full_threshold(Float) -> ok Set threshold, as percentage represented by a float, for disk space utilization Float = float(), 0=<Float=<1 diff --git a/lib/os_mon/doc/src/memsup.xml b/lib/os_mon/doc/src/memsup.xml index c669e4670a..51c78b07c2 100644 --- a/lib/os_mon/doc/src/memsup.xml +++ b/lib/os_mon/doc/src/memsup.xml @@ -28,7 +28,7 @@ - memsup + memsup A Memory Supervisor Process

memsup is a process which supervises the memory usage for @@ -127,7 +127,7 @@ - get_memory_data() -> {Total,Allocated,Worst} + get_memory_data() -> {Total,Allocated,Worst} Get data for the memory in the system Total = Allocated = int() @@ -155,7 +155,7 @@ - get_system_memory_data() -> MemDataList + get_system_memory_data() -> MemDataList Get system dependent memory data MemDataList = [{Tag, Size}] @@ -216,7 +216,7 @@ - get_os_wordsize() -> Wordsize + get_os_wordsize() -> Wordsize Get the wordsize of running os. Wordsize = 32 | 64 | unsupported_os @@ -226,7 +226,7 @@ - get_check_interval() -> MS + get_check_interval() -> MS Get time interval, in milliseconds, for the periodic memory check MS = int() @@ -237,7 +237,7 @@ - set_check_interval(Minutes) -> ok + set_check_interval(Minutes) -> ok Set time interval, in minutes, for the periodic memory check Minutes = int()>0 @@ -252,7 +252,7 @@ - get_procmem_high_watermark() -> int() + get_procmem_high_watermark() -> int() Get threshold, in percent, for process memory allocation

Returns the threshold, in percent, for process memory @@ -260,7 +260,7 @@ - set_procmem_high_watermark(Float) -> ok + set_procmem_high_watermark(Float) -> ok Set threshold, as percentage represented by a float, for process memory allocation

Changes the threshold, given as a float, for process memory @@ -273,7 +273,7 @@ - get_sysmem_high_watermark() -> int() + get_sysmem_high_watermark() -> int() Get threshold, in percent, for system memory allocation

Returns the threshold, in percent, for system memory @@ -281,7 +281,7 @@ - set_sysmem_high_watermark(Float) -> ok + set_sysmem_high_watermark(Float) -> ok Set threshold, given as a float, for system memory allocation

Changes the threshold, given as a float, for system memory @@ -294,7 +294,7 @@ - get_helper_timeout() -> Seconds + get_helper_timeout() -> Seconds Get the timeout value, in seconds, for memory checks Seconds = int() @@ -304,7 +304,7 @@ - set_helper_timeout(Seconds) -> ok + set_helper_timeout(Seconds) -> ok Set the timeout value, in seconds, for memory checks Seconds = int() (>= 1) diff --git a/lib/os_mon/doc/src/nteventlog.xml b/lib/os_mon/doc/src/nteventlog.xml index d32427227c..08cf165a24 100644 --- a/lib/os_mon/doc/src/nteventlog.xml +++ b/lib/os_mon/doc/src/nteventlog.xml @@ -28,7 +28,7 @@ - nteventlog + nteventlog Interface to Windows Event Log

nteventlog provides a generic interface to the Windows @@ -61,8 +61,8 @@ - start(Identifier, MFA) -> Result - start_link(Identifier, MFA) -> Result + start(Identifier, MFA) -> Result + start_link(Identifier, MFA) -> Result Start the NT eventlog server Identifier = string() | atom() @@ -82,7 +82,7 @@ - stop() -> stopped + stop() -> stopped Stop the NT eventlog server Result = stopped diff --git a/lib/os_mon/doc/src/os_mon_mib.xml b/lib/os_mon/doc/src/os_mon_mib.xml index e995bf3de1..f6d0b20094 100644 --- a/lib/os_mon/doc/src/os_mon_mib.xml +++ b/lib/os_mon/doc/src/os_mon_mib.xml @@ -29,7 +29,7 @@ - os_mon_mib + os_mon_mib Loading and Unloading of OTP-OS-MON-MIB

Functions for loading and unloading the OTP-OS-MON-MIB into/from @@ -42,7 +42,7 @@ - load(Agent) -> ok | {error, Reason} + load(Agent) -> ok | {error, Reason} Load the OTP-OS-MON-MIB Agent = pid() | atom() @@ -53,7 +53,7 @@ - unload(Agent) -> ok | {error, Reason} + unload(Agent) -> ok | {error, Reason} Unload the OTP-OS-MON-MIB Agent = pid() | atom() diff --git a/lib/os_mon/doc/src/os_sup.xml b/lib/os_mon/doc/src/os_sup.xml index d517f387b4..4a84165a6c 100644 --- a/lib/os_mon/doc/src/os_sup.xml +++ b/lib/os_mon/doc/src/os_sup.xml @@ -28,7 +28,7 @@ - os_sup + os_sup Interface to OS System Messages

os_sup is a process providing a message passing service @@ -159,8 +159,8 @@ - enable() -> ok | {error, Res} - enable(Dir, Conf) -> ok | {error, Error} + enable() -> ok | {error, Res} + enable(Dir, Conf) -> ok | {error, Error} Enable the service (Solaris only) Dir = Conf = Res = string() @@ -194,8 +194,8 @@ - disable() -> ok | {error, Res} - disable(Dir, Conf) -> ok | {error, Error} + disable() -> ok | {error, Res} + disable(Dir, Conf) -> ok | {error, Error} Disable the service (Solaris only) Dir = Conf = Res = string() diff --git a/lib/otp_mibs/doc/src/otp_mib.xml b/lib/otp_mibs/doc/src/otp_mib.xml index 530c529c69..e7d338c165 100644 --- a/lib/otp_mibs/doc/src/otp_mib.xml +++ b/lib/otp_mibs/doc/src/otp_mib.xml @@ -28,7 +28,7 @@ - otp_mib + otp_mib Handles the OTP-MIB

The SNMP application should be used to start an SNMP agent. Then @@ -41,7 +41,7 @@ - load(Agent) -> ok | {error, Reason} + load(Agent) -> ok | {error, Reason} Load the OTP-MIB Agent = pid() | atom() @@ -52,7 +52,7 @@ - unload(Agent) -> ok | {error, Reason} + unload(Agent) -> ok | {error, Reason} Unload the OTP-MIB Agent = pid() | atom() diff --git a/lib/parsetools/doc/src/leex.xml b/lib/parsetools/doc/src/leex.xml index 1227625287..2ba1044882 100644 --- a/lib/parsetools/doc/src/leex.xml +++ b/lib/parsetools/doc/src/leex.xml @@ -21,7 +21,7 @@ A leex.xml - leex + leex Lexical analyzer generator for Erlang

A regular expression based lexical analyzer generator for @@ -124,7 +124,7 @@ Token = tuple() - format_error(ErrorInfo) -> Chars + format_error(ErrorInfo) -> Chars Return an English description of a an error tuple. Chars = [char() | Chars] @@ -145,8 +145,8 @@ Token = tuple() - string(String) -> StringRet - string(String, StartLine) -> StringRet + string(String) -> StringRet + string(String, StartLine) -> StringRet Generated by Leex String = string() @@ -163,9 +163,9 @@ Token = tuple() - token(Cont, Chars) -> {more,Cont1} | {done,TokenRet,RestChars} + token(Cont, Chars) -> {more,Cont1} | {done,TokenRet,RestChars} - token(Cont, Chars, StartLine) -> {more,Cont1} + token(Cont, Chars, StartLine) -> {more,Cont1} | {done,TokenRet,RestChars} Generated by Leex @@ -198,9 +198,9 @@ io:request(InFile, {get_until,Prompt,Module,token,[Line]}) - tokens(Cont, Chars) -> {more,Cont1} | {done,TokensRet,RestChars} + tokens(Cont, Chars) -> {more,Cont1} | {done,TokensRet,RestChars} - tokens(Cont, Chars, StartLine) -> + tokens(Cont, Chars, StartLine) -> {more,Cont1} | {done,TokensRet,RestChars} Generated by Leex diff --git a/lib/parsetools/doc/src/yecc.xml b/lib/parsetools/doc/src/yecc.xml index 5f95b5c150..67a2c95c25 100644 --- a/lib/parsetools/doc/src/yecc.xml +++ b/lib/parsetools/doc/src/yecc.xml @@ -32,7 +32,7 @@ B yecc.sgml - yecc + yecc LALR-1 Parser Generator

An LALR-1 parser generator for Erlang, similar to yacc. @@ -46,7 +46,7 @@ - file(Grammarfile [, Options]) -> YeccRet + file(Grammarfile [, Options]) -> YeccRet Give information about resolved and unresolved parse action conflicts. Grammarfile = filename() @@ -137,7 +137,7 @@ - format_error(Reason) -> Chars + format_error(Reason) -> Chars Return an English description of a an error tuple. Reason = - as returned by yecc:file/1,2 - diff --git a/lib/public_key/doc/src/public_key.xml b/lib/public_key/doc/src/public_key.xml index 5259cb9dd3..76dbe008ef 100644 --- a/lib/public_key/doc/src/public_key.xml +++ b/lib/public_key/doc/src/public_key.xml @@ -31,7 +31,7 @@ - public_key + public_key API module for public-key infrastructure.

Provides functions to handle public-key infrastructure, @@ -326,7 +326,7 @@ - + Decodes an ASN.1 DER-encoded PKIX x509 certificate.

Decodes an ASN.1 DER-encoded PKIX certificate. Option otp @@ -889,7 +889,7 @@ end - + Creates a digital signature. diff --git a/lib/reltool/doc/src/reltool.xml b/lib/reltool/doc/src/reltool.xml index 8a269365c9..5afbad0ba8 100644 --- a/lib/reltool/doc/src/reltool.xml +++ b/lib/reltool/doc/src/reltool.xml @@ -33,7 +33,7 @@ %VSN% - reltool + reltool Main API of the Reltool application

This is an interface module for the Reltool application.

@@ -591,7 +591,7 @@ target_spec() = [target_spec()] - create_target(Server, TargetDir) -> ok | {error, Reason} + create_target(Server, TargetDir) -> ok | {error, Reason} Create a target system Server = server() @@ -604,7 +604,7 @@ target_spec() = [target_spec()] - eval_target_spec(TargetSpec, RootDir, TargetDir) -> ok | {error, Reason} + eval_target_spec(TargetSpec, RootDir, TargetDir) -> ok | {error, Reason} Create a target system TargetSpec = target_spec() @@ -655,7 +655,7 @@ target_spec() = [target_spec()] - get_config(Server) -> {ok, Config} | {error, Reason} + get_config(Server) -> {ok, Config} | {error, Reason} Get reltool configuration Server = server() @@ -667,7 +667,7 @@ target_spec() = [target_spec()] - get_config(Server, InclDefaults, InclDerived) -> {ok, Config} | {error, Reason} + get_config(Server, InclDefaults, InclDerived) -> {ok, Config} | {error, Reason} Get reltool configuration Server = server() @@ -685,7 +685,7 @@ target_spec() = [target_spec()] - get_rel(Server, Relname) -> {ok, RelFile} | {error, Reason} + get_rel(Server, Relname) -> {ok, RelFile} | {error, Reason} Get contents of a release file Server = server() @@ -698,7 +698,7 @@ target_spec() = [target_spec()] - get_script(Server, Relname) -> {ok, ScriptFile | {error, Reason} + get_script(Server, Relname) -> {ok, ScriptFile | {error, Reason} Get contents of a boot script file Server = server() @@ -722,7 +722,7 @@ target_spec() = [target_spec()] - get_server(WindowPid) -> {ok, ServerPid} | {error, Reason} + get_server(WindowPid) -> {ok, ServerPid} | {error, Reason} Start server process with options WindowPid = window_pid() @@ -733,7 +733,7 @@ target_spec() = [target_spec()] - get_target_spec(Server) -> {ok, TargetSpec} | {error, Reason} + get_target_spec(Server) -> {ok, TargetSpec} | {error, Reason} Return a specification of the target system Server = server() @@ -747,7 +747,7 @@ target_spec() = [target_spec()] - install(RelName, TargetDir) -> ok | {error, Reason} + install(RelName, TargetDir) -> ok | {error, Reason} Install a target system RelName = rel_name() @@ -758,7 +758,7 @@ target_spec() = [target_spec()] - start() -> {ok, WindowPid} | {error, Reason} + start() -> {ok, WindowPid} | {error, Reason} Start main window process WindowPid = window_pid() @@ -768,7 +768,7 @@ target_spec() = [target_spec()] - start(Options) -> {ok, WindowPid} | {error, Reason} + start(Options) -> {ok, WindowPid} | {error, Reason} Start main window process with options Options = options() @@ -779,7 +779,7 @@ target_spec() = [target_spec()] - start_link(Options) -> {ok, WindowPid} | {error, Reason} + start_link(Options) -> {ok, WindowPid} | {error, Reason} Start main window process with options Options = options() @@ -790,7 +790,7 @@ target_spec() = [target_spec()] - start_server(Options) -> {ok, ServerPid} | {error, Reason} + start_server(Options) -> {ok, ServerPid} | {error, Reason} Start server process with options Options = options() @@ -803,7 +803,7 @@ target_spec() = [target_spec()] - stop(Pid) -> ok | {error, Reason} + stop(Pid) -> ok | {error, Reason} Stop a server or window process Pid = server_pid() | window_pid() 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() diff --git a/lib/sasl/doc/src/alarm_handler.xml b/lib/sasl/doc/src/alarm_handler.xml index 4160757164..6e74f833cd 100644 --- a/lib/sasl/doc/src/alarm_handler.xml +++ b/lib/sasl/doc/src/alarm_handler.xml @@ -34,7 +34,7 @@ A alarm_handler.sgml.t1 - alarm_handler + alarm_handler An Alarm Handling Process

The alarm handler process is a @@ -81,7 +81,7 @@ - clear_alarm(AlarmId) -> void() + clear_alarm(AlarmId) -> void() Clears the specified alarms. AlarmId = term() @@ -94,7 +94,7 @@ - get_alarms() -> [alarm()] + get_alarms() -> [alarm()] Gets all active alarms.

Returns a list of all active alarms. This function can only @@ -103,7 +103,7 @@ - set_alarm(alarm()) + set_alarm(alarm()) Sets an alarm with an id. alarm() = {AlarmId, AlarmDescription} diff --git a/lib/sasl/doc/src/rb.xml b/lib/sasl/doc/src/rb.xml index 6e118e177b..0ed7e91c11 100644 --- a/lib/sasl/doc/src/rb.xml +++ b/lib/sasl/doc/src/rb.xml @@ -32,7 +32,7 @@ A rb.sgml - rb + rb The Report Browser Tool

The Report Browser (RB) tool is used to browse and @@ -86,7 +86,7 @@ - grep(RegExp) + grep(RegExp) Searches the reports for a regular expression. RegExp = string() | {string(), Options} | re:mp() | {re:mp(), Options} @@ -109,8 +109,8 @@ - h() - help() + h() + help() Displays help information.

Displays online help information.

@@ -118,8 +118,8 @@
- list() - list(Type) + list() + list(Type) Lists all reports. Type = type() @@ -157,8 +157,8 @@ - rescan() - rescan(Options) + rescan() + rescan(Options) Rescans the report directory. Options = [opt()] @@ -171,8 +171,8 @@ - show() - show(Report) + show() + show(Report) Displays reports. Report = integer() | type() @@ -186,8 +186,8 @@ - start() - start(Options) + start() + start(Options) Starts the rb_server. Options = [opt()] @@ -256,7 +256,7 @@ - start_log(FileName) + start_log(FileName) Redirects all output to FileName. FileName = string() | atom() | pid() @@ -268,7 +268,7 @@ - stop() + stop() Stops the rb_server.

Stops rb_server.

@@ -276,7 +276,7 @@
- stop_log() + stop_log() Stops logging to file.

Closes the log file. The output from the RB tool is diff --git a/lib/sasl/doc/src/release_handler.xml b/lib/sasl/doc/src/release_handler.xml index a77dace675..f8ee0306d8 100644 --- a/lib/sasl/doc/src/release_handler.xml +++ b/lib/sasl/doc/src/release_handler.xml @@ -28,7 +28,7 @@ - release_handler + release_handler Unpacking and Installation of Release Packages

The release handler process belongs to the SASL @@ -168,7 +168,7 @@ - check_install_release(Vsn) -> {ok, OtherVsn, Descr} | {error, Reason} + check_install_release(Vsn) -> {ok, OtherVsn, Descr} | {error, Reason} check_install_release(Vsn,Opts) -> {ok, OtherVsn, Descr} | {error, Reason} Checks installation of a release in the system. @@ -202,7 +202,7 @@ - create_RELEASES(Root, RelDir, RelFile, AppDirs) -> ok | {error, Reason} + create_RELEASES(Root, RelDir, RelFile, AppDirs) -> ok | {error, Reason} Creates an initial RELEASES file. Root = RelDir = RelFile = string() @@ -233,7 +233,7 @@ - install_file(Vsn, File) -> ok | {error, Reason} + install_file(Vsn, File) -> ok | {error, Reason} Installs a release file in the release structure. Vsn = File = string() @@ -252,8 +252,8 @@ - install_release(Vsn) -> {ok, OtherVsn, Descr} | {error, Reason} - install_release(Vsn, [Opt]) -> {ok, OtherVsn, Descr} | {continue_after_restart, OtherVsn, Descr} | {error, Reason} + install_release(Vsn) -> {ok, OtherVsn, Descr} | {error, Reason} + install_release(Vsn, [Opt]) -> {ok, OtherVsn, Descr} | {continue_after_restart, OtherVsn, Descr} | {error, Reason} Installs a release in the system. Vsn = OtherVsn = string() @@ -383,7 +383,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]). - make_permanent(Vsn) -> ok | {error, Reason} + make_permanent(Vsn) -> ok | {error, Reason} Makes the specified release version permanent. Vsn = string() @@ -396,7 +396,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]). - remove_release(Vsn) -> ok | {error, Reason} + remove_release(Vsn) -> ok | {error, Reason} Removes a release from the system. Vsn = string() @@ -410,7 +410,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]). - reboot_old_release(Vsn) -> ok | {error, Reason} + reboot_old_release(Vsn) -> ok | {error, Reason} Reboots the system from an old release. Vsn = string() @@ -425,7 +425,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]). - set_removed(Vsn) -> ok | {error, Reason} + set_removed(Vsn) -> ok | {error, Reason} Marks a release as removed. Vsn = string() @@ -440,7 +440,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]). - set_unpacked(RelFile, AppDirs) -> {ok, Vsn} | {error, Reason} + set_unpacked(RelFile, AppDirs) -> {ok, Vsn} | {error, Reason} Marks a release as unpacked. RelFile = string() @@ -466,7 +466,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]). - unpack_release(Name) -> {ok, Vsn} | {error, Reason} + unpack_release(Name) -> {ok, Vsn} | {error, Reason} Unpacks a release package. Name = Vsn = string() @@ -482,7 +482,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]). - which_releases() -> [{Name, Vsn, Apps, Status}] + which_releases() -> [{Name, Vsn, Apps, Status}] Returns all known releases. Name = Vsn = string() @@ -537,7 +537,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]). - upgrade_app(App, Dir) -> {ok, Unpurged} | restart_emulator | {error, Reason} + upgrade_app(App, Dir) -> {ok, Unpurged} | restart_emulator | {error, Reason} Upgrades to a new application version. App = atom() @@ -586,8 +586,8 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]). - downgrade_app(App, Dir) -> - downgrade_app(App, OldVsn, Dir) -> {ok, Unpurged} | restart_emulator | {error, Reason} + downgrade_app(App, Dir) -> + downgrade_app(App, OldVsn, Dir) -> {ok, Unpurged} | restart_emulator | {error, Reason} Downgrades to a previous application version. App = atom() @@ -633,7 +633,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]). - upgrade_script(App, Dir) -> {ok, NewVsn, Script} + upgrade_script(App, Dir) -> {ok, NewVsn, Script} Finds an application upgrade script. App = atom() @@ -671,7 +671,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]). - downgrade_script(App, OldVsn, Dir) -> {ok, Script} + downgrade_script(App, OldVsn, Dir) -> {ok, Script} Finds an application downgrade script. App = atom() @@ -710,7 +710,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]). - eval_appup_script(App, ToVsn, ToDir, Script) -> {ok, Unpurged} | restart_emulator | {error, Reason} + eval_appup_script(App, ToVsn, ToDir, Script) -> {ok, Unpurged} | restart_emulator | {error, Reason} Evaluates an application upgrade or downgrade script. App = atom() diff --git a/lib/sasl/doc/src/systools.xml b/lib/sasl/doc/src/systools.xml index 4842c732b1..6facb8ddae 100644 --- a/lib/sasl/doc/src/systools.xml +++ b/lib/sasl/doc/src/systools.xml @@ -30,7 +30,7 @@ - systools + systools A Set of Release Handling Tools

This module contains functions to generate boot scripts @@ -40,8 +40,8 @@ - make_relup(Name, UpFrom, DownTo) -> Result - make_relup(Name, UpFrom, DownTo, [Opt]) -> Result + make_relup(Name, UpFrom, DownTo) -> Result + make_relup(Name, UpFrom, DownTo, [Opt]) -> Result Generates a release upgrade file relup. Name = string() @@ -136,8 +136,8 @@ - make_script(Name) -> Result - make_script(Name, [Opt]) -> Result + make_script(Name) -> Result + make_script(Name, [Opt]) -> Result Generates a boot script .script/.boot. Name = string() @@ -263,8 +263,8 @@ - make_tar(Name) -> Result - make_tar(Name, [Opt]) -> Result + make_tar(Name) -> Result + make_tar(Name, [Opt]) -> Result Creates a release package. Name = string() @@ -369,7 +369,7 @@ myapp-1/ebin/myapp.app - script2boot(File) -> ok | error + script2boot(File) -> ok | error Generates a binary version of a boot script. File = string() diff --git a/lib/snmp/doc/src/snmp.xml b/lib/snmp/doc/src/snmp.xml index bd671bb40e..d20f1a8d06 100644 --- a/lib/snmp/doc/src/snmp.xml +++ b/lib/snmp/doc/src/snmp.xml @@ -32,7 +32,7 @@ snmp.xml - snmp + snmp Interface functions to the SNMP toolkit

The module snmp contains interface functions to the @@ -56,7 +56,7 @@ - config() -> ok | {error, Reason} + config() -> ok | {error, Reason} Configure with a simple interactive tool

A simple interactive configuration tool. Simple @@ -78,8 +78,8 @@ - start() -> ok | {error, Reason} - start(Type) -> ok | {error, Reason} + start() -> ok | {error, Reason} + start(Type) -> ok | {error, Reason} Start the SNMP application Type = start_type() @@ -93,8 +93,8 @@ - start_agent() -> ok | {error, Reason} - start_agent(Type) -> ok | {error, Reason} + start_agent() -> ok | {error, Reason} + start_agent(Type) -> ok | {error, Reason} Start the agent part of the SNMP application Type = start_type() @@ -117,8 +117,8 @@ - start_manager() -> ok | {error, Reason} - start_manager(Type) -> ok | {error, Reason} + start_manager() -> ok | {error, Reason} + start_manager(Type) -> ok | {error, Reason} Start the manager part of the SNMP application Type = start_type() @@ -141,7 +141,7 @@ - date_and_time() -> DateAndTime + date_and_time() -> DateAndTime Return the current date and time as an OCTET STRING DateAndTime = [int()] @@ -155,7 +155,7 @@ - date_and_time_to_universal_time_dst(DateAndTime) -> [utc()] + date_and_time_to_universal_time_dst(DateAndTime) -> [utc()] Convert a DateAndTime value to a list of possible utc() DateAndTime = [int()] @@ -171,8 +171,8 @@ - date_and_time_to_string(DateAndTime) -> string() - date_and_time_to_string(DateAndTime, Validate) -> string() + date_and_time_to_string(DateAndTime) -> string() + date_and_time_to_string(DateAndTime, Validate) -> string() Convert a DateAndTime value to a string DateAndTime = [int()] @@ -194,7 +194,7 @@ - date_and_time_to_string2(DateAndTime) -> string() + date_and_time_to_string2(DateAndTime) -> string() Convert a DateAndTime value to a string DateAndTime = [int()] @@ -210,7 +210,7 @@ - local_time_to_date_and_time_dst(Local) -> [DateAndTime] + local_time_to_date_and_time_dst(Local) -> [DateAndTime] Convert a Local time value to a list of possible DateAndTime(s) Local = {{Y,Mo,D},{H,M,S}} @@ -226,7 +226,7 @@ - universal_time_to_date_and_time(UTC) -> DateAndTime + universal_time_to_date_and_time(UTC) -> DateAndTime Convert a UTC value to DateAndTime UTC = {{Y,Mo,D},{H,M,S}} @@ -241,8 +241,8 @@ - validate_date_and_time(DateAndTime) -> bool() - validate_date_and_time(DateAndTime, Validate) -> bool() + validate_date_and_time(DateAndTime) -> bool() + validate_date_and_time(DateAndTime, Validate) -> bool() Check if a DateAndTime value is correct DateAndTime = term() @@ -279,7 +279,7 @@ - passwd2localized_key(Alg, Passwd, EngineID) -> Key + passwd2localized_key(Alg, Passwd, EngineID) -> Key Generates an localized key Alg = algorithm() @@ -298,7 +298,7 @@ - octet_string_to_bits(S) -> Val + octet_string_to_bits(S) -> Val Convert an OCTET-STRING to BITS Val = bits() @@ -312,7 +312,7 @@ - bits_to_octet_string(B) -> Val + bits_to_octet_string(B) -> Val Convert an OCTET-STRING to BITS Val = octet_string() @@ -326,7 +326,7 @@ - read_mib(FileName) -> {ok, mib()} | {error, Reason} + read_mib(FileName) -> {ok, mib()} | {error, Reason} FileName = string() @@ -341,9 +341,9 @@ - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile) -> ok | {ok, Cnt} | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block | Start) -> ok | {ok, Cnt} | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start, Block | Stop) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block | Start) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start, Block | Stop) -> ok | {ok, Cnt} | {error, Reason} log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start, Stop, Block) -> ok | {ok, Cnt} | {error, Reason} Convert an Audit Trail Log to text format @@ -440,7 +440,7 @@ - change_log_size(LogName, NewSize) -> ok | {error, Reason} + change_log_size(LogName, NewSize) -> ok | {error, Reason} Change the size of the Audit Trail Log LogName = string() @@ -463,8 +463,8 @@ - print_version_info() -> void() - print_version_info(Prefix) -> void() + print_version_info() -> void() + print_version_info(Prefix) -> void() Formatted print of result of the versions functions Prefix = string() | integer() @@ -484,8 +484,8 @@ - versions1() -> {ok, Info} | {error, Reason} - versions2() -> {ok, Info} | {error, Reason} + versions1() -> {ok, Info} | {error, Reason} + versions2() -> {ok, Info} | {error, Reason} Retrieve various system and application info Info = [info()] @@ -504,8 +504,8 @@ - print_versions(VersionInfo) -> void() - print_versions(Prefix, VersionInfo) -> void() + print_versions(VersionInfo) -> void() + print_versions(Prefix, VersionInfo) -> void() Formatted print of result of the versions functions VersionInfo = [version_info()] @@ -527,7 +527,7 @@ - enable_trace() -> void() + enable_trace() -> void() Starts a tracer - backup(BackupDir) -> ok | {error, Reason} - backup(Agent, BackupDir) -> ok | {error, Reason} + backup(BackupDir) -> ok | {error, Reason} + backup(Agent, BackupDir) -> ok | {error, Reason} Backup agent data BackupDir = string() @@ -216,8 +216,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - info() -> [{Key, Value}] - info(Agent) -> [{Key, Value}] + info() -> [{Key, Value}] + info(Agent) -> [{Key, Value}] Return information about the agent Agent = pid() | atom() @@ -236,7 +236,7 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - old_info_format(NewInfo) -> OldInfo + old_info_format(NewInfo) -> OldInfo Return information about the agent OldInfo = NewInfo = [{Key, Value}] @@ -273,9 +273,9 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - load_mibs(Mibs) -> ok | {error, Reason} - load_mibs(Mibs, Force) -> ok | {error, Reason} - load_mibs(Agent, Mibs) -> ok | {error, Reason} + load_mibs(Mibs) -> ok | {error, Reason} + load_mibs(Mibs, Force) -> ok | {error, Reason} + load_mibs(Agent, Mibs) -> ok | {error, Reason} load_mibs(Agent, Mibs, Force) -> ok | {error, Reason} Load MIBs into the agent @@ -321,9 +321,9 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - unload_mibs(Mibs) -> ok | {error, Reason} - unload_mibs(Mibs, Force) -> ok | {error, Reason} - unload_mibs(Agent, Mibs) -> ok | {error, Reason} + unload_mibs(Mibs) -> ok | {error, Reason} + unload_mibs(Mibs, Force) -> ok | {error, Reason} + unload_mibs(Agent, Mibs) -> ok | {error, Reason} unload_mibs(Agent, Mibs, Force) -> ok | {error, Reason} Unload MIBs from the agent @@ -347,8 +347,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - which_mibs() -> Mibs - which_mibs(Agent) -> Mibs + which_mibs() -> Mibs + which_mibs(Agent) -> Mibs Get a list of all the loaded mibs Agent = pid() | atom() @@ -365,8 +365,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - whereis_mib(MibName) -> {ok, MibFile} | {error, Reason} - whereis_mib(Agent, MibName) -> {ok, MibFile} | {error, Reason} + whereis_mib(MibName) -> {ok, MibFile} | {error, Reason} + whereis_mib(Agent, MibName) -> {ok, MibFile} | {error, Reason} Get the path to the mib file Agent = pid() | atom() @@ -385,10 +385,10 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - current_request_id() -> {value, RequestId} | false - current_context() -> {value, Context} | false - current_community() -> {value, Community} | false - current_address() -> {value, Address} | false + current_request_id() -> {value, RequestId} | false + current_context() -> {value, Context} | false + current_community() -> {value, Community} | false + current_address() -> {value, Address} | false Get the request-id, context, community and address of the current request RequestId = integer() @@ -409,8 +409,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - enum_to_int(Name, Enum) -> {value, Int} | false - enum_to_int(Db, Name, Enum) -> {value, Int} | false + enum_to_int(Name, Enum) -> {value, Int} | false + enum_to_int(Db, Name, Enum) -> {value, Int} | false Convert an enum value to an integer Db = term() @@ -435,8 +435,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - int_to_enum(Name, Int) -> {value, Enum} | false - int_to_enum(Db, Name, Int) -> {value, Enum} | false + int_to_enum(Name, Int) -> {value, Enum} | false + int_to_enum(Db, Name, Int) -> {value, Enum} | false Convert an integer to an enum value Db = term() @@ -461,8 +461,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - name_to_oid(Name) -> {value, oid()} | false - name_to_oid(Db, Name) -> {value, oid()} | false + name_to_oid(Name) -> {value, oid()} | false + name_to_oid(Db, Name) -> {value, oid()} | false Convert a symbolic name to an OID Db = term() @@ -482,8 +482,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - oid_to_name(OID) -> {value, Name} | false - oid_to_name(Db, OID) -> {value, Name} | false + oid_to_name(OID) -> {value, Name} | false + oid_to_name(Db, OID) -> {value, Name} | false Convert an OID to a symbolic name Db = term() @@ -503,7 +503,7 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - which_aliasnames() -> Result + which_aliasnames() -> Result Get all alias-names known to the agent Result = [atom()] @@ -515,7 +515,7 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - which_tables() -> Result + which_tables() -> Result Get all tables known to the agent Result = [atom()] @@ -528,7 +528,7 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - which_variables() -> Result + which_variables() -> Result Get all variables known to the agent Result = [atom()] @@ -541,7 +541,7 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - which_notifications() -> Result + which_notifications() -> Result Get all notifications known to the agent Result = [{Name, MibName, Info}] @@ -558,13 +558,13 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} log_to_txt(LogDir) - log_to_txt(LogDir, Block | Mibs) - log_to_txt(LogDir, Mibs, Block | OutFile) -> ok | {ok, Cnt} | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, Block | LogName) -> ok | {ok, Cnt} | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, Block | LogFile) -> ok | {ok, Cnt} | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block | Start) -> ok | {ok, Cnt} | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block, Start) -> ok | {ok, Cnt} | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start, Stop) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Block | Mibs) + log_to_txt(LogDir, Mibs, Block | OutFile) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, Block | LogName) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, LogName, Block | LogFile) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block | Start) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block, Start) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start, Stop) -> ok | {ok, Cnt} | {error, Reason} log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block, Start, Stop) -> ok | {ok, Cnt} | {error, Reason} Convert an Audit Trail Log to text format @@ -641,7 +641,7 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - change_log_size(NewSize) -> ok | {error, Reason} + change_log_size(NewSize) -> ok | {error, Reason} Change the size of the Audit Trail Log NewSize = {MaxBytes, MaxFiles} @@ -662,8 +662,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - set_log_type(NewType) -> {ok, OldType} | {error, Reason} - set_log_type(Agent, NewType) -> {ok, OldType} | {error, Reason} + set_log_type(NewType) -> {ok, OldType} | {error, Reason} + set_log_type(Agent, NewType) -> {ok, OldType} | {error, Reason} Change the type of the Audit Trail Log NewType = OldType = atl_type() @@ -684,8 +684,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - mib_of(Oid) -> {ok, MibName} | {error, Reason} - mib_of(Agent, Oid) -> {ok, MibName} | {error, Reason} + mib_of(Oid) -> {ok, MibName} | {error, Reason} + mib_of(Agent, Oid) -> {ok, MibName} | {error, Reason} Which mib an Oid belongs to Agent = pid() | atom() @@ -704,8 +704,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - me_of(Oid) -> {ok, Me} | {error, Reason} - me_of(Agent, Oid) -> {ok, Me} | {error, Reason} + me_of(Oid) -> {ok, Me} | {error, Reason} + me_of(Agent, Oid) -> {ok, Me} | {error, Reason} Retrieve the mib-entry of an Oid Agent = pid() | atom() @@ -724,8 +724,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - invalidate_mibs_cache() -> void() - invalidate_mibs_cache(Agent) -> void() + invalidate_mibs_cache() -> void() + invalidate_mibs_cache(Agent) -> void() Invalidate the mib server cache Agent = pid() | atom() @@ -739,8 +739,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - enable_mibs_cache() -> void() - enable_mibs_cache(Agent) -> void() + enable_mibs_cache() -> void() + enable_mibs_cache(Agent) -> void() Enable the mib server cache Agent = pid() | atom() @@ -753,8 +753,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - disable_mibs_cache() -> void() - disable_mibs_cache(Agent) -> void() + disable_mibs_cache() -> void() + disable_mibs_cache(Agent) -> void() Disable the mib server cache Agent = pid() | atom() @@ -781,12 +781,12 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - gc_mibs_cache() -> {ok, NumElementsGCed} | {error, Reason} - gc_mibs_cache(Agent) -> {ok, NumElementsGCed} | {error, Reason} - gc_mibs_cache(Age) -> {ok, NumElementsGCed} | {error, Reason} - gc_mibs_cache(Agent, Age) -> {ok, NumElementsGCed} | {error, Reason} - gc_mibs_cache(Age, GcLimit) -> {ok, NumElementsGCed} | {error, Reason} - gc_mibs_cache(Agent, Age, GcLimit) -> {ok, NumElementsGCed} | {error, Reason} + gc_mibs_cache() -> {ok, NumElementsGCed} | {error, Reason} + gc_mibs_cache(Agent) -> {ok, NumElementsGCed} | {error, Reason} + gc_mibs_cache(Age) -> {ok, NumElementsGCed} | {error, Reason} + gc_mibs_cache(Agent, Age) -> {ok, NumElementsGCed} | {error, Reason} + gc_mibs_cache(Age, GcLimit) -> {ok, NumElementsGCed} | {error, Reason} + gc_mibs_cache(Agent, Age, GcLimit) -> {ok, NumElementsGCed} | {error, Reason} Perform mib server cache gc Agent = pid() | atom() @@ -808,8 +808,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - enable_mibs_cache_autogc() -> void() - enable_mibs_cache_autogc(Agent) -> void() + enable_mibs_cache_autogc() -> void() + enable_mibs_cache_autogc(Agent) -> void() Enable automatic gc of the mib server cache Agent = pid() | atom() @@ -822,8 +822,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - disable_mibs_cache_autogc() -> void() - disable_mibs_cache_autogc(Agent) -> void() + disable_mibs_cache_autogc() -> void() + disable_mibs_cache_autogc(Agent) -> void() Disable automatic gc of the mib server cache Agent = pid() | atom() @@ -836,8 +836,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - update_mibs_cache_age(NewAge) -> ok | {error, Reason} - update_mibs_cache_age(Agent, NewAge) -> ok | {error, Reason} + update_mibs_cache_age(NewAge) -> ok | {error, Reason} + update_mibs_cache_age(Agent, NewAge) -> ok | {error, Reason} Change the mib server cache age property Agent = pid() | atom() @@ -852,8 +852,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - update_mibs_cache_gclimit(NewGcLimit) -> ok | {error, Reason} - update_mibs_cache_gclimit(Agent, NewGCLimit) -> ok | {error, Reason} + update_mibs_cache_gclimit(NewGcLimit) -> ok | {error, Reason} + update_mibs_cache_gclimit(Agent, NewGCLimit) -> ok | {error, Reason} Change the mib server cache gclimit property Agent = pid() | atom() @@ -869,10 +869,10 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - register_notification_filter(Id, Mod, Data) -> ok | {error, Reason} - register_notification_filter(Agent, Id, Mod, Data) -> ok | {error, Reason} - register_notification_filter(Id, Mod, Data, Where) -> ok | {error, Reason} - register_notification_filter(Agent, Id, Mod, Data, Where) -> ok | {error, Reason} + register_notification_filter(Id, Mod, Data) -> ok | {error, Reason} + register_notification_filter(Agent, Id, Mod, Data) -> ok | {error, Reason} + register_notification_filter(Id, Mod, Data, Where) -> ok | {error, Reason} + register_notification_filter(Agent, Id, Mod, Data, Where) -> ok | {error, Reason} Register a notification filter Agent = pid() | atom() @@ -897,8 +897,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - unregister_notification_filter(Id) -> ok | {error, Reason} - unregister_notification_filter(Agent, Id) -> ok | {error, Reason} + unregister_notification_filter(Id) -> ok | {error, Reason} + unregister_notification_filter(Agent, Id) -> ok | {error, Reason} Unregister a notification filter Agent = pid() | atom() @@ -913,8 +913,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - which_notification_filter() -> Filters - which_notification_filter(Agent) -> Filters + which_notification_filter() -> Filters + which_notification_filter(Agent) -> Filters Which notification filter Agent = pid() | atom() @@ -929,8 +929,8 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - set_request_limit(NewLimit) -> {ok, OldLimit} | {error, Reason} - set_request_limit(Agent, NewLimit) -> {ok, OldLimit} | {error, Reason} + set_request_limit(NewLimit) -> {ok, OldLimit} | {error, Reason} + set_request_limit(Agent, NewLimit) -> {ok, OldLimit} | {error, Reason} Change the request limit NewLimit = OldLimit = infinity | integer() >= 0 @@ -950,7 +950,7 @@ notification_delivery_info() = #snmpa_notification_delivery_info{} - register_subagent(Agent, SubTreeOid, Subagent) -> ok | {error, Reason} + register_subagent(Agent, SubTreeOid, Subagent) -> ok | {error, Reason} Register a sub-agent under a sub-tree Agent = pid() | atom() @@ -975,7 +975,7 @@ snmp_agent:register_subagent(SA1,[1,2,3], SA2). - unregister_subagent(Agent, SubagentOidOrPid) -> ok | {ok, SubAgentPid} | {error, Reason} + unregister_subagent(Agent, SubagentOidOrPid) -> ok | {ok, SubAgentPid} | {error, Reason} Unregister a sub-agent Agent = pid() | atom() @@ -1119,10 +1119,10 @@ snmp_agent:register_subagent(SA1,[1,2,3], SA2). - send_notification(Agent, Notification, Receiver) - send_notification(Agent, Notification, Receiver, Varbinds) - send_notification(Agent, Notification, Receiver, NotifyName, Varbinds) - send_notification(Agent, Notification, Receiver, NotifyName, ContextName, Varbinds) -> void() + send_notification(Agent, Notification, Receiver) + send_notification(Agent, Notification, Receiver, Varbinds) + send_notification(Agent, Notification, Receiver, NotifyName, Varbinds) + send_notification(Agent, Notification, Receiver, NotifyName, ContextName, Varbinds) -> void() send_notification(Agent, Notification, Receiver, NotifyName, ContextName, Varbinds, LocalEngineID) -> void() Send a notification @@ -1324,13 +1324,13 @@ snmp_agent:register_subagent(SA1,[1,2,3], SA2). - discovery(TargetName, Notification) -> {ok, ManagerEngineID} | {error, Reason} - discovery(TargetName, Notification, Varbinds) -> {ok, ManagerEngineID} | {error, Reason} - discovery(TargetName, Notification, DiscoHandler) -> {ok, ManagerEngineID} | {error, Reason} - discovery(TargetName, Notification, ContextName, Varbinds) -> {ok, ManagerEngineID} | {error, Reason} - discovery(TargetName, Notification, Varbinds, DiscoHandler) -> {ok, ManagerEngineID} | {error, Reason} - discovery(TargetName, Notification, ContextName, Varbinds, DiscoHandler) -> {ok, ManagerEngineID} | {error, Reason} - discovery(TargetName, Notification, ContextName, Varbinds, DiscoHandler, ExtraInfo) -> {ok, ManagerEngineID} | {error, Reason} + discovery(TargetName, Notification) -> {ok, ManagerEngineID} | {error, Reason} + discovery(TargetName, Notification, Varbinds) -> {ok, ManagerEngineID} | {error, Reason} + discovery(TargetName, Notification, DiscoHandler) -> {ok, ManagerEngineID} | {error, Reason} + discovery(TargetName, Notification, ContextName, Varbinds) -> {ok, ManagerEngineID} | {error, Reason} + discovery(TargetName, Notification, Varbinds, DiscoHandler) -> {ok, ManagerEngineID} | {error, Reason} + discovery(TargetName, Notification, ContextName, Varbinds, DiscoHandler) -> {ok, ManagerEngineID} | {error, Reason} + discovery(TargetName, Notification, ContextName, Varbinds, DiscoHandler, ExtraInfo) -> {ok, ManagerEngineID} | {error, Reason} Initiate the discovery process with a manager TargetName = string() @@ -1379,7 +1379,7 @@ snmp_agent:register_subagent(SA1,[1,2,3], SA2). - convert_config(OldConfig) -> AgentConfig + convert_config(OldConfig) -> AgentConfig Convert old snmp config to new agent config OldConfig = list() @@ -1403,8 +1403,8 @@ snmp_agent:register_subagent(SA1,[1,2,3], SA2). - restart_worker() -> void() - restart_worker(Agent) -> void() + restart_worker() -> void() + restart_worker(Agent) -> void() Restart the worker process of a multi-threaded agent Agent = pid() | atom() @@ -1419,8 +1419,8 @@ snmp_agent:register_subagent(SA1,[1,2,3], SA2). - restart_set_worker() -> void() - restart_set_worker(Agent) -> void() + restart_set_worker() -> void() + restart_set_worker(Agent) -> void() Restart the set worker process of a multi-threaded agent Agent = pid() | atom() @@ -1468,7 +1468,7 @@ snmp_agent:register_subagent(SA1,[1,2,3], SA2). - verbosity(Ref,Verbosity) -> void() + verbosity(Ref,Verbosity) -> void() Assign a new verbosity for the process Ref = pid() | sub_agents | master_agent | net_if | mib_server | symbolic_store | note_store | local_db diff --git a/lib/snmp/doc/src/snmpa_conf.xml b/lib/snmp/doc/src/snmpa_conf.xml index 01c52c3c8a..4134a81c0c 100644 --- a/lib/snmp/doc/src/snmpa_conf.xml +++ b/lib/snmp/doc/src/snmpa_conf.xml @@ -32,7 +32,7 @@ snmpa_conf.xml - snmpa_conf + snmpa_conf Utility functions for handling the agent config files.

The module snmpa_conf contains various utility functions to @@ -92,7 +92,7 @@ word() = 0..65535 - agent_entry(Tag, Val) -> agent_entry() + agent_entry(Tag, Val) -> agent_entry() Create an agent entry Tag = intAgentTransports | intAgentUDPPort | intAgentMaxPacketSize | snmpEngineMaxMessageSize | snmpEngineID @@ -111,8 +111,8 @@ word() = 0..65535 - write_agent_config(Dir, Conf) -> ok - write_agent_config(Dir, Hdr, Conf) -> ok + write_agent_config(Dir, Conf) -> ok + write_agent_config(Dir, Hdr, Conf) -> ok Write the agent config to the config file Dir = string() @@ -134,7 +134,7 @@ word() = 0..65535 - append_agent_config(Dir, Conf) -> ok + append_agent_config(Dir, Conf) -> ok Append the agent config to the config file Dir = string() @@ -153,7 +153,7 @@ word() = 0..65535 - read_agent_config(Dir) -> Conf + read_agent_config(Dir) -> Conf Read the agent config from the config file Dir = string() @@ -172,7 +172,7 @@ word() = 0..65535 - standard_entry(Tag, Val) -> standard_entry() + standard_entry(Tag, Val) -> standard_entry() Create an standard entry Tag = sysDescr | sysObjectID | sysContact | sysName | sysLocation | sysServices | snmpEnableAuthenTraps @@ -192,8 +192,8 @@ word() = 0..65535 - write_standard_config(Dir, Conf) -> ok - write_standard_config(Dir, Hdr, Conf) -> ok + write_standard_config(Dir, Conf) -> ok + write_standard_config(Dir, Hdr, Conf) -> ok Write the agent standard config to the config file Dir = string() @@ -216,7 +216,7 @@ word() = 0..65535 - append_standard_config(Dir, Conf) -> ok + append_standard_config(Dir, Conf) -> ok Append the agent standard config to the config file Dir = string() @@ -236,7 +236,7 @@ word() = 0..65535 - read_standard_config(Dir) -> Conf + read_standard_config(Dir) -> Conf Read the agent standard config from the config file Dir = string() @@ -255,7 +255,7 @@ word() = 0..65535 - context_entry(Context) -> context_entry() + context_entry(Context) -> context_entry() Create an context entry Context = string() @@ -273,8 +273,8 @@ word() = 0..65535 - write_context_config(Dir, Conf) -> ok - write_context_config(Dir, Hdr, Conf) -> ok + write_context_config(Dir, Conf) -> ok + write_context_config(Dir, Hdr, Conf) -> ok Write the agent context(s) to the config file Dir = string() @@ -297,7 +297,7 @@ word() = 0..65535 - append_context_config(Dir, Conf) -> ok + append_context_config(Dir, Conf) -> ok Append the agent context(s) to the config file Dir = string() @@ -317,7 +317,7 @@ word() = 0..65535 - read_context_config(Dir) -> Conf + read_context_config(Dir) -> Conf Read the agent context config from the config file Dir = string() @@ -336,8 +336,8 @@ word() = 0..65535 - community_entry(CommunityIndex) -> community_entry() - community_entry(CommunityIndex, CommunityName, SecName, ContextName, TransportTag) -> community_entry() + community_entry(CommunityIndex) -> community_entry() + community_entry(CommunityIndex, CommunityName, SecName, ContextName, TransportTag) -> community_entry() Create an community entry CommunityIndex = string() @@ -364,8 +364,8 @@ word() = 0..65535 - write_community_config(Dir, Conf) -> ok - write_community_config(Dir, Hdr, Conf) -> ok + write_community_config(Dir, Conf) -> ok + write_community_config(Dir, Hdr, Conf) -> ok Write the agent community config to the config file Dir = string() @@ -388,7 +388,7 @@ word() = 0..65535 - append_community_config(Dir, Conf) -> ok + append_community_config(Dir, Conf) -> ok Append the agent community config to the config file Dir = string() @@ -408,7 +408,7 @@ word() = 0..65535 - read_community_config(Dir) -> Conf + read_community_config(Dir) -> Conf Read the agent community config from the config file Dir = string() @@ -427,10 +427,10 @@ word() = 0..65535 - target_addr_entry(Name, Domain, Addr, TagList, ParamsName, EngineId) -> target_addr_entry() + target_addr_entry(Name, Domain, Addr, TagList, ParamsName, EngineId) -> target_addr_entry() target_addr_entry(Name, Domain, Addr, TagList, ParamsName, EngineId, TMask) -> target_addr_entry() - target_addr_entry(Name, Domain, Addr, TagList, ParamsName, EngineId, TMask, MaxMessageSize) -> target_addr_entry() - target_addr_entry(Name, Domain, Addr, Timeout, RetryCount, TagList, ParamsName, EngineId, TMask, MaxMessageSize) -> target_addr_entry() + target_addr_entry(Name, Domain, Addr, TagList, ParamsName, EngineId, TMask, MaxMessageSize) -> target_addr_entry() + target_addr_entry(Name, Domain, Addr, Timeout, RetryCount, TagList, ParamsName, EngineId, TMask, MaxMessageSize) -> target_addr_entry() Create an target_addr entry Name = string() @@ -464,8 +464,8 @@ word() = 0..65535 - write_target_addr_config(Dir, Conf) -> ok - write_target_addr_config(Dir, Hdr, Conf) -> ok + write_target_addr_config(Dir, Conf) -> ok + write_target_addr_config(Dir, Hdr, Conf) -> ok Write the agent target_addr config to the config file Dir = string() @@ -488,7 +488,7 @@ word() = 0..65535 - append_target_addr_config(Dir, Conf) -> ok + append_target_addr_config(Dir, Conf) -> ok Append the agent target_addr config to the config file Dir = string() @@ -508,7 +508,7 @@ word() = 0..65535 - read_target_addr_config(Dir) -> Conf + read_target_addr_config(Dir) -> Conf Read the agent target_addr config from the config file Dir = string() @@ -527,9 +527,9 @@ word() = 0..65535 - target_params_entry(Name, Vsn) -> target_params_entry() - target_params_entry(Name, Vsn, SecName, SecLevel) -> target_params_entry() - target_params_entry(Name, MPModel, SecModel, SecName, SecLevel) -> target_params_entry() + target_params_entry(Name, Vsn) -> target_params_entry() + target_params_entry(Name, Vsn, SecName, SecLevel) -> target_params_entry() + target_params_entry(Name, MPModel, SecModel, SecName, SecLevel) -> target_params_entry() Create an target_params entry Name = string() @@ -564,8 +564,8 @@ word() = 0..65535 - write_target_params_config(Dir, Conf) -> ok - write_target_params_config(Dir, Hdr, Conf) -> ok + write_target_params_config(Dir, Conf) -> ok + write_target_params_config(Dir, Hdr, Conf) -> ok Write the agent target_params config to the config file Dir = string() @@ -588,7 +588,7 @@ word() = 0..65535 - append_target_params_config(Dir, Conf) -> ok + append_target_params_config(Dir, Conf) -> ok Append the agent target_params config to the config file Dir = string() @@ -608,7 +608,7 @@ word() = 0..65535 - read_target_params_config(Dir) -> Conf + read_target_params_config(Dir) -> Conf Read the agent target_params config from the config file Dir = string() @@ -627,10 +627,10 @@ word() = 0..65535 - vacm_s2g_entry(SecModel, SecName, GroupName) -> vacm_s2g_entry() - vacm_acc_entry(GroupName, Prefix, SecModel, SecLevel, Match, ReadView, WriteView, NotifyView) -> vacm_acc_entry() - vacm_vtf_entry(ViewIndex, ViewSubtree) -> vacm_vtf_entry() - vacm_vtf_entry(ViewIndex, ViewSubtree, ViewStatus, ViewMask) -> vacm_vtf_entry() + vacm_s2g_entry(SecModel, SecName, GroupName) -> vacm_s2g_entry() + vacm_acc_entry(GroupName, Prefix, SecModel, SecLevel, Match, ReadView, WriteView, NotifyView) -> vacm_acc_entry() + vacm_vtf_entry(ViewIndex, ViewSubtree) -> vacm_vtf_entry() + vacm_vtf_entry(ViewIndex, ViewSubtree, ViewStatus, ViewMask) -> vacm_vtf_entry() Create an vacm entry SecModel = v1 | v2c | usm @@ -665,8 +665,8 @@ word() = 0..65535 - write_vacm_config(Dir, Conf) -> ok - write_vacm_config(Dir, Hdr, Conf) -> ok + write_vacm_config(Dir, Conf) -> ok + write_vacm_config(Dir, Hdr, Conf) -> ok Write the agent vacm config to the config file Dir = string() @@ -690,7 +690,7 @@ word() = 0..65535 - append_vacm_config(Dir, Conf) -> ok + append_vacm_config(Dir, Conf) -> ok Append the agent vacm config to the config file Dir = string() @@ -710,7 +710,7 @@ word() = 0..65535 - read_vacm_config(Dir) -> Conf + read_vacm_config(Dir) -> Conf Read the agent vacm config from the config file Dir = string() @@ -729,8 +729,8 @@ word() = 0..65535 - usm_entry(EngineId) -> usm_entry() - usm_entry(EngineID, UserName, SecName, Clone, AuthP, AuthKeyC, OwnAuthKeyC, PrivP, PrivKeyC, OwnPrivKeyC, Public, AuthKey, PrivKey) -> usm_entry() + usm_entry(EngineId) -> usm_entry() + usm_entry(EngineID, UserName, SecName, Clone, AuthP, AuthKeyC, OwnAuthKeyC, PrivP, PrivKeyC, OwnPrivKeyC, Public, AuthKey, PrivKey) -> usm_entry() Create an usm entry EngineId = string() @@ -762,8 +762,8 @@ word() = 0..65535 - write_usm_config(Dir, Conf) -> ok - write_usm_config(Dir, Hdr, Conf) -> ok + write_usm_config(Dir, Conf) -> ok + write_usm_config(Dir, Hdr, Conf) -> ok Write the agent usm config to the config file Dir = string() @@ -786,7 +786,7 @@ word() = 0..65535 - append_usm_config(Dir, Conf) -> ok + append_usm_config(Dir, Conf) -> ok Append the agent usm config to the config file Dir = string() @@ -805,7 +805,7 @@ word() = 0..65535 - read_usm_config(Dir) -> Conf + read_usm_config(Dir) -> Conf Read the agent usm config from the config file Dir = string() @@ -824,7 +824,7 @@ word() = 0..65535 - notify_entry(Name, Tag, Type) -> notify_entry() + notify_entry(Name, Tag, Type) -> notify_entry() Create an notify entry Name = string() @@ -845,8 +845,8 @@ word() = 0..65535 - write_notify_config(Dir, Conf) -> ok - write_notify_config(Dir, Hdr, Conf) -> ok + write_notify_config(Dir, Conf) -> ok + write_notify_config(Dir, Hdr, Conf) -> ok Write the agent notify config to the config file Dir = string() @@ -869,7 +869,7 @@ word() = 0..65535 - append_notify_config(Dir, Conf) -> ok + append_notify_config(Dir, Conf) -> ok Append the agent notify config to the config file Dir = string() @@ -889,7 +889,7 @@ word() = 0..65535 - read_notify_config(Dir) -> Conf + read_notify_config(Dir) -> Conf Read the agent notify config from the config file Dir = string() diff --git a/lib/snmp/doc/src/snmpa_discovery_handler.xml b/lib/snmp/doc/src/snmpa_discovery_handler.xml index 0ea72a880c..21b8746c11 100644 --- a/lib/snmp/doc/src/snmpa_discovery_handler.xml +++ b/lib/snmp/doc/src/snmpa_discovery_handler.xml @@ -32,7 +32,7 @@ snmpa_discovery_handler.xml - snmpa_discovery_handler + snmpa_discovery_handler Behaviour module for the SNMP agent discovery handler.

This module defines the behaviour of the agent discovery @@ -51,7 +51,7 @@ - stage1_finish(TargetName, ManagerEngineID, ExtraInfo) -> ignore | {ok, usm_entry() | [usm_entry()]} | {ok, usm_entry() | [usm_entry()], NewExtraInfo} + stage1_finish(TargetName, ManagerEngineID, ExtraInfo) -> ignore | {ok, usm_entry() | [usm_entry()]} | {ok, usm_entry() | [usm_entry()], NewExtraInfo} Discovery stage 1 finish TargetName = string() diff --git a/lib/snmp/doc/src/snmpa_error.xml b/lib/snmp/doc/src/snmpa_error.xml index 7cc4a3513d..6e6761b7a5 100644 --- a/lib/snmp/doc/src/snmpa_error.xml +++ b/lib/snmp/doc/src/snmpa_error.xml @@ -32,7 +32,7 @@ snmpa_error.xml - snmpa_error + snmpa_error Functions for Reporting SNMP Errors @@ -57,7 +57,7 @@ - config_err(Format, Args) -> void() + config_err(Format, Args) -> void() Called if a configuration error occurs Format = string() @@ -76,7 +76,7 @@ - user_err(Format, Args) -> void() + user_err(Format, Args) -> void() Called if a user related error occurs Format = string() diff --git a/lib/snmp/doc/src/snmpa_error_io.xml b/lib/snmp/doc/src/snmpa_error_io.xml index bcb2688646..d78e09ff13 100644 --- a/lib/snmp/doc/src/snmpa_error_io.xml +++ b/lib/snmp/doc/src/snmpa_error_io.xml @@ -32,7 +32,7 @@ snmpa_error_io.xml - snmpa_error_io + snmpa_error_io Functions for Reporting SNMP Errors on stdio

The module snmpa_error_io implements the @@ -52,7 +52,7 @@ - config_err(Format, Args) -> void() + config_err(Format, Args) -> void() Called if a configuration error occurs Format = string() @@ -68,7 +68,7 @@ - user_err(Format, Args) -> void() + user_err(Format, Args) -> void() Called if a user related error occurs Format = string() diff --git a/lib/snmp/doc/src/snmpa_error_logger.xml b/lib/snmp/doc/src/snmpa_error_logger.xml index 4feb2e7f32..b0565a6839 100644 --- a/lib/snmp/doc/src/snmpa_error_logger.xml +++ b/lib/snmp/doc/src/snmpa_error_logger.xml @@ -32,7 +32,7 @@ snmpa_error_logger.xml - snmpa_error_logger + snmpa_error_logger Functions for Reporting SNMP Errors through the error_logger

The module snmpa_error_logger implements the @@ -54,7 +54,7 @@ - config_err(Format, Args) -> void() + config_err(Format, Args) -> void() Called if a configuration error occurs Format = string() @@ -70,7 +70,7 @@ - user_err(Format, Args) -> void() + user_err(Format, Args) -> void() Called if a user related error occurs Format = string() diff --git a/lib/snmp/doc/src/snmpa_error_report.xml b/lib/snmp/doc/src/snmpa_error_report.xml index 282d9b4e59..f08dc1df23 100644 --- a/lib/snmp/doc/src/snmpa_error_report.xml +++ b/lib/snmp/doc/src/snmpa_error_report.xml @@ -32,7 +32,7 @@ snmpa_error_report.xml - snmpa_error_report + snmpa_error_report Behaviour module for reporting SNMP agent errors @@ -52,7 +52,7 @@ - config_err(Format, Args) -> void() + config_err(Format, Args) -> void() Called if a configuration error occurs Format = string() @@ -68,7 +68,7 @@ - user_err(Format, Args) -> void() + user_err(Format, Args) -> void() Called if a user related error occurs Format = string() diff --git a/lib/snmp/doc/src/snmpa_local_db.xml b/lib/snmp/doc/src/snmpa_local_db.xml index ac8d466ab3..229f22ab70 100644 --- a/lib/snmp/doc/src/snmpa_local_db.xml +++ b/lib/snmp/doc/src/snmpa_local_db.xml @@ -32,7 +32,7 @@ snmpa_local_db.xml - snmpa_local_db + snmpa_local_db The SNMP built-in database

The module snmpa_local_db contains functions for @@ -86,7 +86,7 @@ - dump() -> ok | {error, Reason} + dump() -> ok | {error, Reason} Dump the database to disk Reason = term() @@ -97,7 +97,7 @@ - match(NameDb, Pattern) + match(NameDb, Pattern) Perform a match on the table

Performs an ets/dets matching on the table. @@ -106,9 +106,9 @@ - print() - print(TableName) - print(TableName, Db) + print() + print(TableName) + print(TableName, Db) Print the database to screen TableName = atom() @@ -124,7 +124,7 @@ - table_create(NameDb) -> bool() + table_create(NameDb) -> bool() Create a table

Creates a table. If the table already exist, the old copy @@ -135,7 +135,7 @@ - table_create_row(NameDb, RowIndex, Row) -> bool() + table_create_row(NameDb, RowIndex, Row) -> bool() Create a row in a table Row = {Val1, Val2, ..., ValN} @@ -147,28 +147,28 @@ - table_delete(NameDb) -> void() + table_delete(NameDb) -> void() Delete a table

Deletes a table.

- table_delete_row(NameDb, RowIndex) -> bool() + table_delete_row(NameDb, RowIndex) -> bool() Delete the row in the table

Deletes the row in the table.

- table_exists(NameDb) -> bool() + table_exists(NameDb) -> bool() Check if a table exists

Checks if a table exists.

- table_get_row(NameDb, RowIndex) -> Row | undefined + table_get_row(NameDb, RowIndex) -> Row | undefined Get a row from the table Row = {Val1, Val2, ..., ValN} diff --git a/lib/snmp/doc/src/snmpa_mpd.xml b/lib/snmp/doc/src/snmpa_mpd.xml index 4a0c5b61d5..d76a9c4a94 100644 --- a/lib/snmp/doc/src/snmpa_mpd.xml +++ b/lib/snmp/doc/src/snmpa_mpd.xml @@ -32,7 +32,7 @@ snmpa_mpd.xml - snmpa_mpd + snmpa_mpd Message Processing and Dispatch module for the SNMP agent

The module snmpa_mpd implements the version independent @@ -52,7 +52,7 @@ - init(Vsns) -> mpd_state() + init(Vsns) -> mpd_state() Initialize the MPD module Vsns = [Vsn] @@ -211,7 +211,7 @@ - discarded_pdu(Variable) -> void() + discarded_pdu(Variable) -> void() Increment the variable associated with a discarded pdu Variable = atom() diff --git a/lib/snmp/doc/src/snmpa_network_interface.xml b/lib/snmp/doc/src/snmpa_network_interface.xml index d4d4989e90..3e79df11b1 100644 --- a/lib/snmp/doc/src/snmpa_network_interface.xml +++ b/lib/snmp/doc/src/snmpa_network_interface.xml @@ -32,7 +32,7 @@ snmpa_network_interface.xml - snmpa_network_interface + snmpa_network_interface Behaviour module for the SNMP agent network interface.

This module defines the behaviour of the agent network @@ -68,7 +68,7 @@ - start_link(Prio, NoteStore, MasterAgent, Opts) -> {ok, Pid} | {error, Reason} + start_link(Prio, NoteStore, MasterAgent, Opts) -> {ok, Pid} | {error, Reason} Start-link the network interface process Prio = priority() @@ -93,7 +93,7 @@ - info(Pid) -> [{Key, Value}] + info(Pid) -> [{Key, Value}] Return information about the running network interface process Pid = pid() @@ -112,7 +112,7 @@ - verbosity(Pid, Verbosity) -> void() + verbosity(Pid, Verbosity) -> void() Change the verbosity of a running network interface process Pid = pid() @@ -126,7 +126,7 @@ - get_log_type(Pid) -> {ok, LogType} | {error, Reason} + get_log_type(Pid) -> {ok, LogType} | {error, Reason} Get the Audit Trail Log type Pid = pid() @@ -147,7 +147,7 @@ - set_log_type(Pid, NewType) -> {ok, OldType} | {error, Reason} + set_log_type(Pid, NewType) -> {ok, OldType} | {error, Reason} Change the Audit Trail Log type Pid = pid() diff --git a/lib/snmp/doc/src/snmpa_network_interface_filter.xml b/lib/snmp/doc/src/snmpa_network_interface_filter.xml index 7cd08f8935..02c7d291dd 100644 --- a/lib/snmp/doc/src/snmpa_network_interface_filter.xml +++ b/lib/snmp/doc/src/snmpa_network_interface_filter.xml @@ -32,7 +32,7 @@ snmpa_network_interface_filter.xml - snmpa_network_interface_filter + snmpa_network_interface_filter Behaviour module for the SNMP agent network-interface filter.

This module defines the behaviour of the agent network interface @@ -101,7 +101,7 @@ pdu_type() = 'get-request' | 'get-next-request' | 'get-response' | - accept_recv(Domain, Addr) -> boolean() + accept_recv(Domain, Addr) -> boolean() Shall the received message be accepted Domain = transportDomain() @@ -116,7 +116,7 @@ pdu_type() = 'get-request' | 'get-next-request' | 'get-response' | - accept_send(Domain, Addr) -> boolean() + accept_send(Domain, Addr) -> boolean() Shall the message be sent Domain = transportDomain() @@ -131,7 +131,7 @@ pdu_type() = 'get-request' | 'get-next-request' | 'get-response' | - accept_recv_pdu(Domain, Addr, PduType) -> boolean() + accept_recv_pdu(Domain, Addr, PduType) -> boolean() Shall the received pdu be accepted Domain = transportDomain() @@ -148,7 +148,7 @@ pdu_type() = 'get-request' | 'get-next-request' | 'get-response' | - accept_send_pdu(Targets, PduType) -> Reply + accept_send_pdu(Targets, PduType) -> Reply Shall the pdu be sent Targets = targets() diff --git a/lib/snmp/doc/src/snmpa_notification_delivery_info_receiver.xml b/lib/snmp/doc/src/snmpa_notification_delivery_info_receiver.xml index cbae158544..5dad372710 100644 --- a/lib/snmp/doc/src/snmpa_notification_delivery_info_receiver.xml +++ b/lib/snmp/doc/src/snmpa_notification_delivery_info_receiver.xml @@ -34,7 +34,7 @@ snmpa_notification_delivery_info_receiver.xml - snmpa_notification_delivery_info_receiver + snmpa_notification_delivery_info_receiver Behaviour module for the SNMP agent notification delivery information receiver. @@ -76,7 +76,7 @@ - delivery_targets(Tag, Targets, Extra) -> void() + delivery_targets(Tag, Targets, Extra) -> void() Inform about target addresses Tag = term() @@ -97,7 +97,7 @@ - delivery_info(Tag, Target, DeliveryResult, Extra) -> void() + delivery_info(Tag, Target, DeliveryResult, Extra) -> void() Inform about delivery result Tag = term() diff --git a/lib/snmp/doc/src/snmpa_notification_filter.xml b/lib/snmp/doc/src/snmpa_notification_filter.xml index 0f16ba4440..902412ccc5 100644 --- a/lib/snmp/doc/src/snmpa_notification_filter.xml +++ b/lib/snmp/doc/src/snmpa_notification_filter.xml @@ -32,7 +32,7 @@ snmpa_notification_filter.xml - snmpa_notification_filter + snmpa_notification_filter Behaviour module for the SNMP agent notification filters.

This module defines the behaviour of the agent notification @@ -51,7 +51,7 @@ - handle_notification(Notif, Data) -> Reply + handle_notification(Notif, Data) -> Reply Handle a notification Reply = send | {send, NewNotif} | dont_send diff --git a/lib/snmp/doc/src/snmpa_supervisor.xml b/lib/snmp/doc/src/snmpa_supervisor.xml index 86c6fbc350..e11cde390f 100644 --- a/lib/snmp/doc/src/snmpa_supervisor.xml +++ b/lib/snmp/doc/src/snmpa_supervisor.xml @@ -32,7 +32,7 @@ snmpa_supervisor.xml - snmpa_supervisor + snmpa_supervisor A supervisor for the SNMP agent Processes

This is the top supervisor for the agent part of the SNMP @@ -42,7 +42,7 @@ - start_sub_sup(Opts) -> {ok, pid()} | {error, {already_started, pid()}} | {error, Reason} + start_sub_sup(Opts) -> {ok, pid()} | {error, {already_started, pid()}} | {error, Reason} Start the SNMP supervisor for sub-agents only Opts = [opt()] @@ -60,7 +60,7 @@ - start_master_sup(Opts) -> {ok, pid()} | {error, {already_started, pid()}} | {error, Reason} + start_master_sup(Opts) -> {ok, pid()} | {error, {already_started, pid()}} | {error, Reason} Start the SNMP supervisor for all agents Opts = [opt()] @@ -82,7 +82,7 @@ - start_sub_agent(ParentAgent,Subtree,Mibs) -> {ok, pid()} | {error, Reason} + start_sub_agent(ParentAgent,Subtree,Mibs) -> {ok, pid()} | {error, Reason} Start a sub-agent ParentAgent = pid() @@ -99,7 +99,7 @@ - stop_sub_agent(SubAgent) -> ok | no_such_child + stop_sub_agent(SubAgent) -> ok | no_such_child Stop a sub-agent SubAgent = pid() diff --git a/lib/snmp/doc/src/snmpc.xml b/lib/snmp/doc/src/snmpc.xml index aba51bb500..b22b32a133 100644 --- a/lib/snmp/doc/src/snmpc.xml +++ b/lib/snmp/doc/src/snmpc.xml @@ -32,7 +32,7 @@ snmpc.xml - snmpc + snmpc Interface Functions to the SNMP toolkit MIB compiler

The module snmpc contains interface functions to the @@ -43,8 +43,8 @@ - compile(File) - compile(File, Options) -> {ok, BinFileName} | {error, Reason} + compile(File) + compile(File, Options) -> {ok, BinFileName} | {error, Reason} Compile the specified MIB File = string() @@ -236,7 +236,7 @@ - is_consistent(Mibs) -> ok | {error, Reason} + is_consistent(Mibs) -> ok | {error, Reason} Check for OID conflicts between MIBs Mibs = [MibName] @@ -252,7 +252,7 @@ - mib_to_hrl(MibName) -> ok | {error, Reason} + mib_to_hrl(MibName) -> ok | {error, Reason} Generate constants for the objects in the MIB MibName = string() diff --git a/lib/snmp/doc/src/snmpm.xml b/lib/snmp/doc/src/snmpm.xml index 9b8029330e..c45df98ee0 100644 --- a/lib/snmp/doc/src/snmpm.xml +++ b/lib/snmp/doc/src/snmpm.xml @@ -32,7 +32,7 @@ snmpm.xml - snmpm + snmpm Interface functions to the SNMP toolkit manager

The module snmpm contains interface functions to the @@ -77,7 +77,7 @@ sec_level() = noAuthNoPriv | authNoPriv | authPriv - monitor() -> Ref + monitor() -> Ref Monitor the snmp manager Ref = reference() @@ -92,7 +92,7 @@ sec_level() = noAuthNoPriv | authNoPriv | authPriv - demonitor(Ref) -> void() + demonitor(Ref) -> void() Turn off monitoring of the snmp manager Ref = reference() @@ -105,7 +105,7 @@ sec_level() = noAuthNoPriv | authNoPriv | authPriv - notify_started(Timeout) -> Pid + notify_started(Timeout) -> Pid Request to be notified when manager started Timeout = integer() @@ -148,7 +148,7 @@ sec_level() = noAuthNoPriv | authNoPriv | authPriv - cancel_notify_started(Pid) -> void() + cancel_notify_started(Pid) -> void() Cancel request to be notified when manager started Pid = pid() @@ -161,8 +161,8 @@ sec_level() = noAuthNoPriv | authNoPriv | authPriv - register_user(Id, Module, Data) -> ok | {error, Reason} - register_user(Id, Module, Data, DefaultAgentConfig) -> ok | {error, Reason} + register_user(Id, Module, Data) -> ok | {error, Reason} + register_user(Id, Module, Data, DefaultAgentConfig) -> ok | {error, Reason} Register a user of the manager Id = term() @@ -204,8 +204,8 @@ sec_level = noAuthNoPriv | authNoPriv | authPriv - register_user_monitor(Id, Module, Data) -> ok | {error, Reason} - register_user_monitor(Id, Module, Data, DefaultAgentConfig) -> ok | {error, Reason} + register_user_monitor(Id, Module, Data) -> ok | {error, Reason} + register_user_monitor(Id, Module, Data, DefaultAgentConfig) -> ok | {error, Reason} Register a monitored user of the manager Id = term() @@ -252,7 +252,7 @@ sec_level = noAuthNoPriv | authNoPriv | authPriv - unregister_user(Id) -> ok | {error, Reason} + unregister_user(Id) -> ok | {error, Reason} Unregister the user Id = term() @@ -265,7 +265,7 @@ sec_level = noAuthNoPriv | authNoPriv | authPriv - which_users() -> Users + which_users() -> Users Get a list of all users Users = [UserId] @@ -279,7 +279,7 @@ sec_level = noAuthNoPriv | authNoPriv | authPriv - register_agent(UserId, TargetName, Config) -> ok | {error, Reason} + register_agent(UserId, TargetName, Config) -> ok | {error, Reason} Register this agent UserId = term() @@ -325,7 +325,7 @@ sec_level = noAuthNoPriv | authNoPriv | authPriv - unregister_agent(UserId, TargetName) -> ok | {error, Reason} + unregister_agent(UserId, TargetName) -> ok | {error, Reason} Unregister the user UserId = term() @@ -339,7 +339,7 @@ sec_level = noAuthNoPriv | authNoPriv | authPriv - agent_info(TargetName, Item) -> {ok, Val} | {error, Reason} + agent_info(TargetName, Item) -> {ok, Val} | {error, Reason} Retrieve agent config TargetName = target_name() @@ -355,7 +355,7 @@ sec_level = noAuthNoPriv | authNoPriv | authPriv update_agent_info(UserId, TargetName, Info) -> ok | {error, Reason} - update_agent_info(UserId, TargetName, Item, Val) -> ok | {error, Reason} + update_agent_info(UserId, TargetName, Item, Val) -> ok | {error, Reason} Update agent config UserId = term() @@ -379,8 +379,8 @@ sec_level = noAuthNoPriv | authNoPriv | authPriv - which_agents() -> Agents - which_agents(UserId) -> Agents + which_agents() -> Agents + which_agents(UserId) -> Agents List the registered agents UserId = term() @@ -396,7 +396,7 @@ sec_level = noAuthNoPriv | authNoPriv | authPriv - register_usm_user(EngineID, UserName, Conf) -> ok | {error, Reason} + register_usm_user(EngineID, UserName, Conf) -> ok | {error, Reason} Register this USM user EngineID = string() @@ -427,7 +427,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - unregister_usm_user(EngineID, UserName) -> ok | {error, Reason} + unregister_usm_user(EngineID, UserName) -> ok | {error, Reason} Unregister this USM user EngineID = string() @@ -442,7 +442,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - usm_user_info(EngineID, UserName, Item) -> {ok, Val} | {error, Reason} + usm_user_info(EngineID, UserName, Item) -> {ok, Val} | {error, Reason} Retrieve usm user config EngineID = string() @@ -458,7 +458,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - update_usm_user_info(EngineID, UserName, Item, Val) -> ok | {error, Reason} + update_usm_user_info(EngineID, UserName, Item, Val) -> ok | {error, Reason} Update agent config EngineID = string() @@ -475,7 +475,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - which_usm_users() -> UsmUsers + which_usm_users() -> UsmUsers List all the registered usm users UsmUsers = [{EngineID,UserName}] @@ -490,7 +490,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - which_usm_users(EngineID) -> UsmUsers + which_usm_users(EngineID) -> UsmUsers List the registered usm users UsmUsers = [UserName] @@ -559,11 +559,11 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - sync_get(UserId, TargetName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_get(UserId, TargetName, ContextName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_get(UserId, TargetName, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_get(UserId, TargetName, ContextName, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_get(UserId, TargetName, ContextName, Oids, Timeout, ExtraInfo) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get(UserId, TargetName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get(UserId, TargetName, ContextName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get(UserId, TargetName, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get(UserId, TargetName, ContextName, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get(UserId, TargetName, ContextName, Oids, Timeout, ExtraInfo) -> {ok, SnmpReply, Remaining} | {error, Reason} Synchronous get-request UserId = term() @@ -647,11 +647,11 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - async_get(UserId, TargetName, Oids) -> {ok, ReqId} | {error, Reason} - async_get(UserId, TargetName, ContextName, Oids) -> {ok, ReqId} | {error, Reason} - async_get(UserId, TargetName, Oids, Expire) -> {ok, ReqId} | {error, Reason} - async_get(UserId, TargetName, ContextName, Oids, Expire) -> {ok, ReqId} | {error, Reason} - async_get(UserId, TargetName, ContextName, Oids, Expire, ExtraInfo) -> {ok, ReqId} | {error, Reason} + async_get(UserId, TargetName, Oids) -> {ok, ReqId} | {error, Reason} + async_get(UserId, TargetName, ContextName, Oids) -> {ok, ReqId} | {error, Reason} + async_get(UserId, TargetName, Oids, Expire) -> {ok, ReqId} | {error, Reason} + async_get(UserId, TargetName, ContextName, Oids, Expire) -> {ok, ReqId} | {error, Reason} + async_get(UserId, TargetName, ContextName, Oids, Expire, ExtraInfo) -> {ok, ReqId} | {error, Reason} Asynchronous get-request UserId = term() @@ -737,11 +737,11 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - sync_get_next(UserId, TargetName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_get_next(UserId, TargetName, ContextName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_get_next(UserId, TargetName, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_get_next(UserId, TargetName, ContextName, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_get_next(UserId, TargetName, ContextName, Oids, Timeout, ExtraInfo) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get_next(UserId, TargetName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get_next(UserId, TargetName, ContextName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get_next(UserId, TargetName, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get_next(UserId, TargetName, ContextName, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get_next(UserId, TargetName, ContextName, Oids, Timeout, ExtraInfo) -> {ok, SnmpReply, Remaining} | {error, Reason} Synchronous get-next-request UserId = term() @@ -814,11 +814,11 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - async_get_next(UserId, TargetName, Oids) -> {ok, ReqId} | {error, Reason} - async_get_next(UserId, TargetName, ContextName, Oids) -> {ok, ReqId} | {error, Reason} - async_get_next(UserId, TargetName, Oids, Expire) -> {ok, ReqId} | {error, Reason} - async_get_next(UserId, TargetName, ContextName, Oids, Expire) -> {ok, ReqId} | {error, Reason} - async_get_next(UserId, TargetName, ContextName, Oids, Expire, ExtraInfo) -> {ok, ReqId} | {error, Reason} + async_get_next(UserId, TargetName, Oids) -> {ok, ReqId} | {error, Reason} + async_get_next(UserId, TargetName, ContextName, Oids) -> {ok, ReqId} | {error, Reason} + async_get_next(UserId, TargetName, Oids, Expire) -> {ok, ReqId} | {error, Reason} + async_get_next(UserId, TargetName, ContextName, Oids, Expire) -> {ok, ReqId} | {error, Reason} + async_get_next(UserId, TargetName, ContextName, Oids, Expire, ExtraInfo) -> {ok, ReqId} | {error, Reason} Asynchronous get-next-request UserId = term() @@ -906,11 +906,11 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - sync_set(UserId, TargetName, VarsAndVals) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_set(UserId, TargetName, ContextName, VarsAndVals) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_set(UserId, TargetName, VarsAndVals, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_set(UserId, TargetName, ContextName, VarsAndVals, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_set(UserId, TargetName, ContextName, VarsAndVals, Timeout, ExtraInfo) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_set(UserId, TargetName, VarsAndVals) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_set(UserId, TargetName, ContextName, VarsAndVals) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_set(UserId, TargetName, VarsAndVals, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_set(UserId, TargetName, ContextName, VarsAndVals, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_set(UserId, TargetName, ContextName, VarsAndVals, Timeout, ExtraInfo) -> {ok, SnmpReply, Remaining} | {error, Reason} Synchronous set-request UserId = term() @@ -990,11 +990,11 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - async_set(UserId, TargetName, VarsAndVals) -> {ok, ReqId} | {error, Reason} - async_set(UserId, TargetName, ContextName, VarsAndVals) -> {ok, ReqId} | {error, Reason} - async_set(UserId, TargetName, VarsAndVals, Expire) -> {ok, ReqId} | {error, Reason} - async_set(UserId, TargetName, ContextName, VarsAndVals, Expire) -> {ok, ReqId} | {error, Reason} - async_set(UserId, TargetName, ContextName, VarsAndVals, Expire, ExtraInfo) -> {ok, ReqId} | {error, Reason} + async_set(UserId, TargetName, VarsAndVals) -> {ok, ReqId} | {error, Reason} + async_set(UserId, TargetName, ContextName, VarsAndVals) -> {ok, ReqId} | {error, Reason} + async_set(UserId, TargetName, VarsAndVals, Expire) -> {ok, ReqId} | {error, Reason} + async_set(UserId, TargetName, ContextName, VarsAndVals, Expire) -> {ok, ReqId} | {error, Reason} + async_set(UserId, TargetName, ContextName, VarsAndVals, Expire, ExtraInfo) -> {ok, ReqId} | {error, Reason} Asynchronous set-request UserId = term() @@ -1082,11 +1082,11 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - sync_get_bulk(UserId, TragetName, NonRep, MaxRep, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_get_bulk(UserId, TragetName, NonRep, MaxRep, ContextName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_get_bulk(UserId, TragetName, NonRep, MaxRep, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_get_bulk(UserId, TragetName, NonRep, MaxRep, ContextName, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} - sync_get_bulk(UserId, TragetName, NonRep, MaxRep, ContextName, Oids, Timeout, ExtraInfo) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get_bulk(UserId, TragetName, NonRep, MaxRep, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get_bulk(UserId, TragetName, NonRep, MaxRep, ContextName, Oids) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get_bulk(UserId, TragetName, NonRep, MaxRep, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get_bulk(UserId, TragetName, NonRep, MaxRep, ContextName, Oids, Timeout) -> {ok, SnmpReply, Remaining} | {error, Reason} + sync_get_bulk(UserId, TragetName, NonRep, MaxRep, ContextName, Oids, Timeout, ExtraInfo) -> {ok, SnmpReply, Remaining} | {error, Reason} Synchronous get-bulk-request UserId = term() @@ -1162,11 +1162,11 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - async_get_bulk(UserId, TargetName, NonRep, MaxRep, Oids) -> {ok, ReqId} | {error, Reason} - async_get_bulk(UserId, TargetName, NonRep, MaxRep, ContextName, Oids) -> {ok, ReqId} | {error, Reason} - async_get_bulk(UserId, TargetName, NonRep, MaxRep, Oids, Expire) -> {ok, ReqId} | {error, Reason} - async_get_bulk(UserId, TargetName, NonRep, MaxRep, ContextName, Oids, Expire) -> {ok, ReqId} | {error, Reason} - async_get_bulk(UserId, TargetName, NonRep, MaxRep, ContextName, Oids, Expire, ExtraInfo) -> {ok, ReqId} | {error, Reason} + async_get_bulk(UserId, TargetName, NonRep, MaxRep, Oids) -> {ok, ReqId} | {error, Reason} + async_get_bulk(UserId, TargetName, NonRep, MaxRep, ContextName, Oids) -> {ok, ReqId} | {error, Reason} + async_get_bulk(UserId, TargetName, NonRep, MaxRep, Oids, Expire) -> {ok, ReqId} | {error, Reason} + async_get_bulk(UserId, TargetName, NonRep, MaxRep, ContextName, Oids, Expire) -> {ok, ReqId} | {error, Reason} + async_get_bulk(UserId, TargetName, NonRep, MaxRep, ContextName, Oids, Expire, ExtraInfo) -> {ok, ReqId} | {error, Reason} Asynchronous get-bulk-request UserId = term() @@ -1199,7 +1199,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - cancel_async_request(UserId, ReqId) -> ok | {error, Reason} + cancel_async_request(UserId, ReqId) -> ok | {error, Reason} Cancel a asynchronous request UserId = term() @@ -1215,13 +1215,13 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 log_to_txt(LogDir) - log_to_txt(LogDir, Block | Mibs) - log_to_txt(LogDir, Mibs, Block | OutFile) -> ok | {ok, Cnt} | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, Block | LogName) -> ok | {ok, Cnt} | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, Block | LogFile) -> ok | {ok, Cnt} | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block | Start) -> ok | {ok, Cnt} | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block, Start) -> ok | {ok, Cnt} | {error, Reason} - log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start, Stop) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Block | Mibs) + log_to_txt(LogDir, Mibs, Block | OutFile) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, Block | LogName) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, LogName, Block | LogFile) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block | Start) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block, Start) -> ok | {ok, Cnt} | {error, Reason} + log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start, Stop) -> ok | {ok, Cnt} | {error, Reason} log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Block, Start, Stop) -> ok | {ok, Cnt} | {error, Reason} Convert an Audit Trail Log to text format @@ -1299,7 +1299,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - change_log_size(NewSize) -> ok | {error, Reason} + change_log_size(NewSize) -> ok | {error, Reason} Change the size of the Audit Trail Log NewSize = {MaxBytes, MaxFiles} @@ -1321,7 +1321,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - set_log_type(NewType) -> {ok, OldType} | {error, Reason} + set_log_type(NewType) -> {ok, OldType} | {error, Reason} Change the Audit Trail Log type NewType = OldType = atl_type() @@ -1340,7 +1340,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - load_mib(Mib) -> ok | {error, Reason} + load_mib(Mib) -> ok | {error, Reason} Load a MIB into the manager Mib = MibName @@ -1361,7 +1361,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - unload_mib(Mib) -> ok | {error, Reason} + unload_mib(Mib) -> ok | {error, Reason} Unload a MIB from the manager Mib = MibName @@ -1382,7 +1382,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - which_mibs() -> Mibs + which_mibs() -> Mibs Which mibs are loaded into the manager Mibs = [{MibName, MibFile}] @@ -1397,7 +1397,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - name_to_oid(Name) -> {ok, Oids} | {error, Reason} + name_to_oid(Name) -> {ok, Oids} | {error, Reason} Get all the possible oid's for an alias-name Name = atom() @@ -1414,7 +1414,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - oid_to_name(Oid) -> {ok, Name} | {error, Reason} + oid_to_name(Oid) -> {ok, Name} | {error, Reason} Get the alias-name of the oid Oid = oid() @@ -1429,7 +1429,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - oid_to_type(Oid) -> {ok, Type} | {error, Reason} + oid_to_type(Oid) -> {ok, Type} | {error, Reason} Get the type of the the oid Oid = oid() @@ -1444,7 +1444,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - backup(BackupDir) -> ok | {error, Reason} + backup(BackupDir) -> ok | {error, Reason} Backup manager data BackupDir = string() @@ -1458,7 +1458,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - info() -> [{Key, Value}] + info() -> [{Key, Value}] Return information about the manager Key = atom() @@ -1475,7 +1475,7 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - verbosity(Ref, Verbosity) -> void() + verbosity(Ref, Verbosity) -> void() Assign a new verbosity for the process Ref = server | config | net_if | note_store | all @@ -1492,8 +1492,8 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1 - format_reason(Reason) -> string() - format_reason(Prefix, Reason) -> string() + format_reason(Reason) -> string() + format_reason(Prefix, Reason) -> string() Assign a new verbosity for the process Reason = term() diff --git a/lib/snmp/doc/src/snmpm_conf.xml b/lib/snmp/doc/src/snmpm_conf.xml index a3097e5f7e..17ecf2df7c 100644 --- a/lib/snmp/doc/src/snmpm_conf.xml +++ b/lib/snmp/doc/src/snmpm_conf.xml @@ -32,7 +32,7 @@ snmpm_conf.xml - snmpm_conf + snmpm_conf Utility functions for handling the manager config files.

The module snmpm_conf contains various utility functions to @@ -42,7 +42,7 @@ - manager_entry(Tag, Val) -> manager_entry() + manager_entry(Tag, Val) -> manager_entry() Create an manager entry Tag = address | port | engine_id | max_message_size @@ -60,8 +60,8 @@ - write_manager_config(Dir, Conf) -> ok - write_manager_config(Dir, Hdr, Conf) -> ok + write_manager_config(Dir, Conf) -> ok + write_manager_config(Dir, Hdr, Conf) -> ok Write the manager config to the config file Dir = string() @@ -81,7 +81,7 @@ - append_manager_config(Dir, Conf) -> ok + append_manager_config(Dir, Conf) -> ok Append the manager config to the config file Dir = string() @@ -98,7 +98,7 @@ - read_manager_config(Dir) -> Conf + read_manager_config(Dir) -> Conf Read the manager config from the config file Dir = string() @@ -115,9 +115,9 @@ - users_entry(UserId) -> users_entry() - users_entry(UserId, UserMod) -> users_entry() - users_entry(UserId, UserMod, UserData) -> users_entry() + users_entry(UserId) -> users_entry() + users_entry(UserId, UserMod) -> users_entry() + users_entry(UserId, UserMod, UserData) -> users_entry() Create an users entry UserId = term() @@ -139,8 +139,8 @@ - write_users_config(Dir, Conf) -> ok - write_users_config(Dir, Hdr, Conf) -> ok + write_users_config(Dir, Conf) -> ok + write_users_config(Dir, Hdr, Conf) -> ok Write the manager users config to the config file Dir = string() @@ -161,7 +161,7 @@ - append_users_config(Dir, Conf) -> ok + append_users_config(Dir, Conf) -> ok Append the manager users config to the config file Dir = string() @@ -179,7 +179,7 @@ - read_users_config(Dir) -> Conf + read_users_config(Dir) -> Conf Read the manager users config from the config file Dir = string() @@ -196,7 +196,7 @@ - agents_entry(UserId, TargetName, Comm, Domain, Addr, EngineID, Timeout, MaxMessageSize, Version, SecModel, SecName, SecLevel) -> agents_entry() + agents_entry(UserId, TargetName, Comm, Domain, Addr, EngineID, Timeout, MaxMessageSize, Version, SecModel, SecName, SecLevel) -> agents_entry() Create an agents entry UserId = term() @@ -223,8 +223,8 @@ - write_agents_config(Dir, Conf) -> ok - write_agents_config(Dir, Hdr, Conf) -> ok + write_agents_config(Dir, Conf) -> ok + write_agents_config(Dir, Hdr, Conf) -> ok Write the manager agents to the config file Dir = string() @@ -245,7 +245,7 @@ - append_agents_config(Dir, Conf) -> ok + append_agents_config(Dir, Conf) -> ok Append the manager agents to the config file Dir = string() @@ -263,7 +263,7 @@ - read_agents_config(Dir) -> Conf + read_agents_config(Dir) -> Conf Read the manager agents config from the config file Dir = string() @@ -280,8 +280,8 @@ - usm_entry(EngineID, UserName, AuthP, AuthKey, PrivP, PrivKey) -> usm_entry() - usm_entry(EngineID, UserName, SecName, AuthP, AuthKey, PrivP, PrivKey) -> usm_entry() + usm_entry(EngineID, UserName, AuthP, AuthKey, PrivP, PrivKey) -> usm_entry() + usm_entry(EngineID, UserName, SecName, AuthP, AuthKey, PrivP, PrivKey) -> usm_entry() Create an usm entry EngineID = string() @@ -303,8 +303,8 @@ - write_usm_config(Dir, Conf) -> ok - write_usm_config(Dir, Hdr, Conf) -> ok + write_usm_config(Dir, Conf) -> ok + write_usm_config(Dir, Hdr, Conf) -> ok Write the manager usm config to the config file Dir = string() @@ -325,7 +325,7 @@ - append_usm_config(Dir, Conf) -> ok + append_usm_config(Dir, Conf) -> ok Append the manager usm config to the config file Dir = string() @@ -343,7 +343,7 @@ - read_usm_config(Dir) -> Conf + read_usm_config(Dir) -> Conf Read the manager usm config from the config file Dir = string() diff --git a/lib/snmp/doc/src/snmpm_mpd.xml b/lib/snmp/doc/src/snmpm_mpd.xml index c8b2797ea7..b024f8d294 100644 --- a/lib/snmp/doc/src/snmpm_mpd.xml +++ b/lib/snmp/doc/src/snmpm_mpd.xml @@ -32,7 +32,7 @@ snmpm_mpd.xml - snmpm_mpd + snmpm_mpd Message Processing and Dispatch module for the SNMP manager

The module snmpm_mpd implements the version independent @@ -48,7 +48,7 @@ - init_mpd(Vsns) -> mpd_state() + init_mpd(Vsns) -> mpd_state() Initialize the MPD module Vsns = [Vsn] @@ -92,7 +92,7 @@ - generate_msg(Vsn, NoteStore, Pdu, MsgData, Logger) -> {ok, Packet} | {discarded, Reason} + generate_msg(Vsn, NoteStore, Pdu, MsgData, Logger) -> {ok, Packet} | {discarded, Reason} Generate a request message to be sent to the network Vsn = 'version-1' | 'version-2' | 'version-3' @@ -117,7 +117,7 @@ - generate_response_msg(Vsn, Pdu, MsgData, Logger) -> {ok, Packet} | {discarded, Reason} + generate_response_msg(Vsn, Pdu, MsgData, Logger) -> {ok, Packet} | {discarded, Reason} Generate a response packet to be sent to the network Vsn = 'version-1' | 'version-2' | 'version-3' diff --git a/lib/snmp/doc/src/snmpm_network_interface.xml b/lib/snmp/doc/src/snmpm_network_interface.xml index 73892aa2e8..e4a66ceef2 100644 --- a/lib/snmp/doc/src/snmpm_network_interface.xml +++ b/lib/snmp/doc/src/snmpm_network_interface.xml @@ -32,7 +32,7 @@ snmpm_network_interface.xml - snmpm_network_interface + snmpm_network_interface Behaviour module for the SNMP manager network interface.

This module defines the behaviour of the manager network @@ -79,7 +79,7 @@ - start_link(Server, NoteStore) -> {ok, Pid} | {error, Reason} + start_link(Server, NoteStore) -> {ok, Pid} | {error, Reason} Start-link the network interface process Server = pid() @@ -95,7 +95,7 @@ - stop(Pid) -> void() + stop(Pid) -> void() Stop the network interface process Pid = pid() @@ -108,7 +108,7 @@ - send_pdu(Pid, Pdu, Vsn, MsgData, Domain, Addr, ExtraInfo) -> void() + send_pdu(Pid, Pdu, Vsn, MsgData, Domain, Addr, ExtraInfo) -> void() Request the network interface process to send this pdu Pid = pid() @@ -142,7 +142,7 @@ - inform_response(Pid, Ref, Addr, Port) -> void() + inform_response(Pid, Ref, Addr, Port) -> void() Send the inform-request ack Pid = pid() @@ -163,7 +163,7 @@ - note_store(Pid, NoteStore) -> void() + note_store(Pid, NoteStore) -> void() Change the verbosity of the network interface process Pid = pid() @@ -179,7 +179,7 @@ - info(Pid) -> [{Key, Value}] + info(Pid) -> [{Key, Value}] Return information about the running network interface process Pid = pid() @@ -198,7 +198,7 @@ - verbosity(Pid, Verbosity) -> void() + verbosity(Pid, Verbosity) -> void() Change the verbosity of the network interface process Pid = pid() @@ -212,7 +212,7 @@ - get_log_type(Pid) -> {ok, LogType} | {error, Reason} + get_log_type(Pid) -> {ok, LogType} | {error, Reason} Get the Audit Trail Log type Pid = pid() @@ -233,7 +233,7 @@ - set_log_type(Pid, NewType) -> {ok, OldType} | {error, Reason} + set_log_type(Pid, NewType) -> {ok, OldType} | {error, Reason} Change the Audit Trail Log type Pid = pid() diff --git a/lib/snmp/doc/src/snmpm_network_interface_filter.xml b/lib/snmp/doc/src/snmpm_network_interface_filter.xml index 742cd53fc6..a50572da51 100644 --- a/lib/snmp/doc/src/snmpm_network_interface_filter.xml +++ b/lib/snmp/doc/src/snmpm_network_interface_filter.xml @@ -32,7 +32,7 @@ snmpm_network_interface_filter.xml - snmpm_network_interface_filter + snmpm_network_interface_filter Behaviour module for the SNMP manager network-interface filter.

This module defines the behaviour of the manager network interface @@ -100,7 +100,7 @@ pdu_type() = 'get-request' | 'get-next-request' | 'get-response' | - accept_recv(Domain, Addr) -> boolean() + accept_recv(Domain, Addr) -> boolean() Shall the received message be accepted Domain = transportDomain() @@ -116,7 +116,7 @@ pdu_type() = 'get-request' | 'get-next-request' | 'get-response' | - accept_send(Domain, Addr) -> boolean() + accept_send(Domain, Addr) -> boolean() Shall the message be sent Domain = transportDomain() @@ -132,7 +132,7 @@ pdu_type() = 'get-request' | 'get-next-request' | 'get-response' | - accept_recv_pdu(Domain, Addr, PduType) -> boolean() + accept_recv_pdu(Domain, Addr, PduType) -> boolean() Shall the received pdu be accepted Domain = transportDomain() @@ -150,7 +150,7 @@ pdu_type() = 'get-request' | 'get-next-request' | 'get-response' | - accept_send_pdu(Domain, Addr, PduType) -> boolean() + accept_send_pdu(Domain, Addr, PduType) -> boolean() Shall the pdu be sent Domain = transportDomain() diff --git a/lib/snmp/doc/src/snmpm_user.xml b/lib/snmp/doc/src/snmpm_user.xml index ef35f0eaaf..9abf596c83 100644 --- a/lib/snmp/doc/src/snmpm_user.xml +++ b/lib/snmp/doc/src/snmpm_user.xml @@ -32,7 +32,7 @@ snmpm_user.xml - snmpm_user + snmpm_user Behaviour module for the SNMP manager user.

This module defines the behaviour of the manager user. @@ -93,7 +93,7 @@ snmp_v1_trap_info() :: {Enteprise :: snmp:oid(), - handle_error(ReqId, Reason, UserData) -> void() + handle_error(ReqId, Reason, UserData) -> void() Handle error ReqId = integer() @@ -122,7 +122,7 @@ snmp_v1_trap_info() :: {Enteprise :: snmp:oid(), - handle_agent(Domain, Addr, Type, SnmpInfo, UserData) -> Reply + handle_agent(Domain, Addr, Type, SnmpInfo, UserData) -> Reply Handle agent Domain = transportDomainUdpIpv4 | transportDomainUdpIpv6 @@ -181,7 +181,7 @@ snmp_v1_trap_info() :: {Enteprise :: snmp:oid(), - handle_pdu(TargetName, ReqId, SnmpPduInfo, UserData) -> void() + handle_pdu(TargetName, ReqId, SnmpPduInfo, UserData) -> void() Handle the reply to an asynchronous request TargetName = target_name() @@ -202,7 +202,7 @@ snmp_v1_trap_info() :: {Enteprise :: snmp:oid(), - handle_trap(TargetName, SnmpTrapInfo, UserData) -> Reply + handle_trap(TargetName, SnmpTrapInfo, UserData) -> Reply Handle a trap/notification message TargetName = TargetName2 = target_name() @@ -225,7 +225,7 @@ snmp_v1_trap_info() :: {Enteprise :: snmp:oid(), - handle_inform(TargetName, SnmpInformInfo, UserData) -> Reply + handle_inform(TargetName, SnmpInformInfo, UserData) -> Reply Handle a inform message TargetName = TargetName2 = target_name() @@ -253,7 +253,7 @@ snmp_v1_trap_info() :: {Enteprise :: snmp:oid(), - handle_report(TargetName, SnmpReportInfo, UserData) -> Reply + handle_report(TargetName, SnmpReportInfo, UserData) -> Reply Handle a report message TargetName = TargetName2 = target_name() diff --git a/lib/ssh/doc/src/ssh.xml b/lib/ssh/doc/src/ssh.xml index 759c66d63c..1a53a2ea98 100644 --- a/lib/ssh/doc/src/ssh.xml +++ b/lib/ssh/doc/src/ssh.xml @@ -28,7 +28,7 @@ 2007-10-06 - ssh + ssh Main API of the ssh application

This is the interface module for the SSH application. @@ -1059,17 +1059,17 @@ - + Closes an SSH connection.

Closes an SSH connection.

- connect(Host, Port, Options) -> Result - connect(Host, Port, Options, NegotiationTimeout) -> Result + connect(Host, Port, Options) -> Result + connect(Host, Port, Options, NegotiationTimeout) -> Result connect(TcpSocket, Options) -> Result - connect(TcpSocket, Options, NegotiationTimeout) -> Result + connect(TcpSocket, Options, NegotiationTimeout) -> Result Connects to an SSH server. Host = host() @@ -1098,7 +1098,7 @@ - + Retrieves information about a connection.

Retrieves information about a connection. The list Keys defines which information that @@ -1108,9 +1108,9 @@ - daemon(Port | TcpSocket) -> Result - daemon(Port | TcpSocket, Options) -> Result - daemon(HostAddress, Port, Options) -> Result + daemon(Port | TcpSocket) -> Result + daemon(Port | TcpSocket, Options) -> Result + daemon(HostAddress, Port, Options) -> Result Starts a server listening for SSH connections. Port = integer() @@ -1176,9 +1176,9 @@ - shell(Host | TcpSocket) -> Result - shell(Host | TcpSocket, Options) -> Result - shell(Host, Port, Options) -> Result + shell(Host | TcpSocket) -> Result + shell(Host | TcpSocket, Options) -> Result + shell(Host, Port, Options) -> Result Starts an interactive shell on a remote SSH server. Host = host() @@ -1203,8 +1203,8 @@ - - + + Starts the SSH application.

Utility function that starts the applications crypto, public_key, @@ -1215,7 +1215,7 @@ - + Stops the ssh application.

Stops the ssh application. @@ -1225,8 +1225,8 @@ - - + + Stops the listener and all connections started by the listener. @@ -1235,8 +1235,8 @@ - - + + Stops the listener, but leaves existing connections started by the listener operational. diff --git a/lib/ssh/doc/src/ssh_connection.xml b/lib/ssh/doc/src/ssh_connection.xml index 7933cff511..2a701929f6 100644 --- a/lib/ssh/doc/src/ssh_connection.xml +++ b/lib/ssh/doc/src/ssh_connection.xml @@ -30,7 +30,7 @@ - ssh_connection + ssh_connection This module provides API functions to send SSH Connection Protocol events to the other side of an SSH channel. @@ -201,7 +201,7 @@ - adjust_window(ConnectionRef, ChannelId, NumOfBytes) -> ok + adjust_window(ConnectionRef, ChannelId, NumOfBytes) -> ok Adjusts the SSH flow control window. ConnectionRef = connection_ref() @@ -221,7 +221,7 @@ - close(ConnectionRef, ChannelId) -> ok + close(ConnectionRef, ChannelId) -> ok Sends a close message on the channel ChannelId. ConnectionRef = connection_ref() @@ -240,7 +240,7 @@ - exec(ConnectionRef, ChannelId, Command, TimeOut) -> ssh_request_status() | + exec(ConnectionRef, ChannelId, Command, TimeOut) -> ssh_request_status() | {error, reason()} Requests that the server starts the execution of the given command. @@ -284,7 +284,7 @@ - exit_status(ConnectionRef, ChannelId, Status) -> ok + exit_status(ConnectionRef, ChannelId, Status) -> ok Sends the exit status of a command to the client. ConnectionRef = connection_ref() @@ -339,7 +339,7 @@ - reply_request(ConnectionRef, WantReply, Status, ChannelId) -> ok + reply_request(ConnectionRef, WantReply, Status, ChannelId) -> ok Sends status replies to requests that want such replies. ConnectionRef = connection_ref() @@ -357,10 +357,10 @@ - send(ConnectionRef, ChannelId, Data) -> - send(ConnectionRef, ChannelId, Data, Timeout) -> - send(ConnectionRef, ChannelId, Type, Data) -> - send(ConnectionRef, ChannelId, Type, Data, TimeOut) -> + send(ConnectionRef, ChannelId, Data) -> + send(ConnectionRef, ChannelId, Data, Timeout) -> + send(ConnectionRef, ChannelId, Type, Data) -> + send(ConnectionRef, ChannelId, Type, Data, TimeOut) -> ok | {error, timeout} | {error, closed} Sends channel data. @@ -380,7 +380,7 @@ - send_eof(ConnectionRef, ChannelId) -> ok | {error, closed} + send_eof(ConnectionRef, ChannelId) -> ok | {error, closed} Sends EOF on channel ChannelId. ConnectionRef = connection_ref() @@ -392,8 +392,8 @@ - session_channel(ConnectionRef, Timeout) -> - session_channel(ConnectionRef, InitialWindowSize, + session_channel(ConnectionRef, Timeout) -> + session_channel(ConnectionRef, InitialWindowSize, MaxPacketSize, Timeout) -> {ok, channel_id()} | {error, reason()} Opens a channel for an SSH session. @@ -410,7 +410,7 @@ - setenv(ConnectionRef, ChannelId, Var, Value, TimeOut) -> ssh_request_status() | + setenv(ConnectionRef, ChannelId, Var, Value, TimeOut) -> ssh_request_status() | {error, reason()} Environment variables can be passed to the shell/command to be started later. @@ -428,7 +428,7 @@ - shell(ConnectionRef, ChannelId) -> ok | failure | {error, closed} + shell(ConnectionRef, ChannelId) -> ok | failure | {error, closed} Requests that the user default shell (typically defined in /etc/passwd in Unix systems) is to be executed at the server end. @@ -448,7 +448,7 @@ - subsystem(ConnectionRef, ChannelId, Subsystem, Timeout) -> ssh_request_status() | + subsystem(ConnectionRef, ChannelId, Subsystem, Timeout) -> ssh_request_status() | {error, reason()} Requests to execute a predefined subsystem on the server. diff --git a/lib/ssh/doc/src/ssh_sftp.xml b/lib/ssh/doc/src/ssh_sftp.xml index 780e132ae2..c89092798d 100644 --- a/lib/ssh/doc/src/ssh_sftp.xml +++ b/lib/ssh/doc/src/ssh_sftp.xml @@ -29,7 +29,7 @@ ssh_sftp.sgml - ssh_sftp + ssh_sftp SFTP client.

This module implements an SSH FTP (SFTP) client. SFTP is a @@ -82,7 +82,7 @@ - apread(ChannelPid, Handle, Position, Len) -> {async, N} | {error, reason()} + apread(ChannelPid, Handle, Position, Len) -> {async, N} | {error, reason()} Reads asynchronously from an open file. ChannelPid = pid() @@ -98,7 +98,7 @@ - apwrite(ChannelPid, Handle, Position, Data) -> {async, N} | {error, reason()} + apwrite(ChannelPid, Handle, Position, Data) -> {async, N} | {error, reason()} Writes asynchronously to an open file. ChannelPid = pid() @@ -116,7 +116,7 @@ - aread(ChannelPid, Handle, Len) -> {async, N} | {error, reason()} + aread(ChannelPid, Handle, Len) -> {async, N} | {error, reason()} Reads asynchronously from an open file. ChannelPid = pid() @@ -137,7 +137,7 @@ - awrite(ChannelPid, Handle, Data) -> {async, N} | {error, reason()} + awrite(ChannelPid, Handle, Data) -> {async, N} | {error, reason()} Writes asynchronously to an open file. ChannelPid = pid() @@ -159,8 +159,8 @@ - close(ChannelPid, Handle) -> - close(ChannelPid, Handle, Timeout) -> ok | {error, reason()} + close(ChannelPid, Handle) -> + close(ChannelPid, Handle, Timeout) -> ok | {error, reason()} Closes an open handle. ChannelPid = pid() @@ -173,8 +173,8 @@ - delete(ChannelPid, Name) -> - delete(ChannelPid, Name, Timeout) -> ok | {error, reason()} + delete(ChannelPid, Name) -> + delete(ChannelPid, Name, Timeout) -> ok | {error, reason()} Deletes a file. ChannelPid = pid() @@ -188,8 +188,8 @@ - del_dir(ChannelPid, Name) -> - del_dir(ChannelPid, Name, Timeout) -> ok | {error, reason()} + del_dir(ChannelPid, Name) -> + del_dir(ChannelPid, Name, Timeout) -> ok | {error, reason()} Deletes an empty directory. ChannelPid = pid() @@ -204,8 +204,8 @@ - list_dir(ChannelPid, Path) -> - list_dir(ChannelPid, Path, Timeout) -> {ok, Filenames} | {error, reason()} + list_dir(ChannelPid, Path) -> + list_dir(ChannelPid, Path, Timeout) -> {ok, Filenames} | {error, reason()} Lists the directory. ChannelPid = pid() @@ -221,8 +221,8 @@ - make_dir(ChannelPid, Name) -> - make_dir(ChannelPid, Name, Timeout) -> ok | {error, reason()} + make_dir(ChannelPid, Name) -> + make_dir(ChannelPid, Name, Timeout) -> ok | {error, reason()} Creates a directory. ChannelPid = pid() @@ -237,8 +237,8 @@ - make_symlink(ChannelPid, Name, Target) -> - make_symlink(ChannelPid, Name, Target, Timeout) -> ok | {error, reason()} + make_symlink(ChannelPid, Name, Target) -> + make_symlink(ChannelPid, Name, Target, Timeout) -> ok | {error, reason()} Creates a symbolic link. ChannelPid = pid() @@ -253,8 +253,8 @@ - open(ChannelPid, File, Mode) -> - open(ChannelPid, File, Mode, Timeout) -> {ok, Handle} | {error, reason()} + open(ChannelPid, File, Mode) -> + open(ChannelPid, File, Mode, Timeout) -> {ok, Handle} | {error, reason()} Opens a file and returns a handle. ChannelPid = pid() @@ -270,8 +270,8 @@ - opendir(ChannelPid, Path) -> - opendir(ChannelPid, Path, Timeout) -> {ok, Handle} | {error, reason()} + opendir(ChannelPid, Path) -> + opendir(ChannelPid, Path, Timeout) -> {ok, Handle} | {error, reason()} Opens a directory and returns a handle. ChannelPid = pid() @@ -339,8 +339,8 @@ - position(ChannelPid, Handle, Location) -> - position(ChannelPid, Handle, Location, Timeout) -> {ok, NewPosition | {error, reason()} + position(ChannelPid, Handle, Location) -> + position(ChannelPid, Handle, Location, Timeout) -> {ok, NewPosition | {error, reason()} Sets the file position of a file. ChannelPid = pid() @@ -384,8 +384,8 @@ - pread(ChannelPid, Handle, Position, Len) -> - pread(ChannelPid, Handle, Position, Len, Timeout) -> {ok, Data} | eof | {error, reason()} + pread(ChannelPid, Handle, Position, Len) -> + pread(ChannelPid, Handle, Position, Len, Timeout) -> {ok, Data} | eof | {error, reason()} Reads from an open file. ChannelPid = pid() @@ -402,8 +402,8 @@ - pwrite(ChannelPid, Handle, Position, Data) -> ok - pwrite(ChannelPid, Handle, Position, Data, Timeout) -> ok | {error, reason()} + pwrite(ChannelPid, Handle, Position, Data) -> ok + pwrite(ChannelPid, Handle, Position, Data, Timeout) -> ok | {error, reason()} Writes to an open file. ChannelPid = pid() @@ -419,8 +419,8 @@ - read(ChannelPid, Handle, Len) -> - read(ChannelPid, Handle, Len, Timeout) -> {ok, Data} | eof | {error, reason()} + read(ChannelPid, Handle, Len) -> + read(ChannelPid, Handle, Len, Timeout) -> {ok, Data} | eof | {error, reason()} Reads from an open file. ChannelPid = pid() @@ -441,8 +441,8 @@ - read_file(ChannelPid, File) -> - read_file(ChannelPid, File, Timeout) -> {ok, Data} | {error, reason()} + read_file(ChannelPid, File) -> + read_file(ChannelPid, File, Timeout) -> {ok, Data} | {error, reason()} Reads a file. ChannelPid = pid() @@ -456,8 +456,8 @@ - read_file_info(ChannelPid, Name) -> - read_file_info(ChannelPid, Name, Timeout) -> {ok, FileInfo} | {error, reason()} + read_file_info(ChannelPid, Name) -> + read_file_info(ChannelPid, Name, Timeout) -> {ok, FileInfo} | {error, reason()} Gets information about a file. ChannelPid = pid() @@ -481,8 +481,8 @@ - read_link(ChannelPid, Name) -> - read_link(ChannelPid, Name, Timeout) -> {ok, Target} | {error, reason()} + read_link(ChannelPid, Name) -> + read_link(ChannelPid, Name, Timeout) -> {ok, Target} | {error, reason()} Reads symbolic link. ChannelPid = pid() @@ -496,8 +496,8 @@ - read_link_info(ChannelPid, Name) -> {ok, FileInfo} | {error, reason()} - read_link_info(ChannelPid, Name, Timeout) -> {ok, FileInfo} | {error, reason()} + read_link_info(ChannelPid, Name) -> {ok, FileInfo} | {error, reason()} + read_link_info(ChannelPid, Name, Timeout) -> {ok, FileInfo} | {error, reason()} Gets information about a symbolic link. ChannelPid = pid() @@ -517,8 +517,8 @@ - rename(ChannelPid, OldName, NewName) -> - rename(ChannelPid, OldName, NewName, Timeout) -> ok | {error, reason()} + rename(ChannelPid, OldName, NewName) -> + rename(ChannelPid, OldName, NewName, Timeout) -> ok | {error, reason()} Renames a file. ChannelPid = pid() @@ -534,16 +534,16 @@ - start_channel(ConnectionRef) -> - start_channel(ConnectionRef, Options) -> + start_channel(ConnectionRef) -> + start_channel(ConnectionRef, Options) -> {ok, Pid} | {error, reason()|term()} - start_channel(Host, Options) -> - start_channel(Host, Port, Options) -> + start_channel(Host, Options) -> + start_channel(Host, Port, Options) -> {ok, Pid, ConnectionRef} | {error, reason()|term()} - start_channel(TcpSocket) -> - start_channel(TcpSocket, Options) -> + start_channel(TcpSocket) -> + start_channel(TcpSocket, Options) -> {ok, Pid, ConnectionRef} | {error, reason()|term()} Starts an SFTP client. @@ -594,7 +594,7 @@ - stop_channel(ChannelPid) -> ok + stop_channel(ChannelPid) -> ok Stops the SFTP client channel. ChannelPid = pid() @@ -606,8 +606,8 @@ - write(ChannelPid, Handle, Data) -> - write(ChannelPid, Handle, Data, Timeout) -> ok | {error, reason()} + write(ChannelPid, Handle, Data) -> + write(ChannelPid, Handle, Data, Timeout) -> ok | {error, reason()} Writes to an open file. ChannelPid = pid() @@ -625,8 +625,8 @@ - write_file(ChannelPid, File, Iolist) -> - write_file(ChannelPid, File, Iolist, Timeout) -> ok | {error, reason()} + write_file(ChannelPid, File, Iolist) -> + write_file(ChannelPid, File, Iolist, Timeout) -> ok | {error, reason()} Writes a file. ChannelPid = pid() @@ -641,8 +641,8 @@ - write_file_info(ChannelPid, Name, Info) -> - write_file_info(ChannelPid, Name, Info, Timeout) -> ok | {error, reason()} + write_file_info(ChannelPid, Name, Info) -> + write_file_info(ChannelPid, Name, Info, Timeout) -> ok | {error, reason()} Writes information for a file. ChannelPid = pid() diff --git a/lib/ssh/doc/src/ssh_sftpd.xml b/lib/ssh/doc/src/ssh_sftpd.xml index 3b34150e98..ee72784add 100644 --- a/lib/ssh/doc/src/ssh_sftpd.xml +++ b/lib/ssh/doc/src/ssh_sftpd.xml @@ -29,7 +29,7 @@ ssh_sftpd.sgml - ssh_sftpd + ssh_sftpd Specifies the channel process to handle an SFTP subsystem.

Specifies a channel process to handle an SFTP subsystem.

@@ -51,7 +51,7 @@ - subsystem_spec(Options) -> subsystem_spec() + subsystem_spec(Options) -> subsystem_spec() Returns the subsystem specification that allows an SSH daemon to handle the subsystem "sftp". Options = [{Option, Value}] diff --git a/lib/ssl/doc/src/ssl.xml b/lib/ssl/doc/src/ssl.xml index e13393bf63..b4aa8746f9 100644 --- a/lib/ssl/doc/src/ssl.xml +++ b/lib/ssl/doc/src/ssl.xml @@ -28,7 +28,7 @@ ssl.xml - ssl + ssl Interface Functions for Secure Socket Layer

@@ -939,7 +939,7 @@ fun(srp, Username :: string(), UserState :: term()) -> connect(Socket, SslOptions) -> - connect(Socket, SslOptions, Timeout) -> {ok, SslSocket} | {ok, SslSocket, Ext} + connect(Socket, SslOptions, Timeout) -> {ok, SslSocket} | {ok, SslSocket, Ext} | {error, Reason} Upgrades a gen_tcp, or equivalent, connected socket to an TLS socket. @@ -975,8 +975,8 @@ fun(srp, Username :: string(), UserState :: term()) -> - connect(Host, Port, Options) -> - connect(Host, Port, Options, Timeout) -> + connect(Host, Port, Options) -> + connect(Host, Port, Options, Timeout) -> {ok, SslSocket}| {ok, SslSocket, Ext} | {error, Reason} Opens an TLS/DTLS connection to Host, Port. @@ -1018,7 +1018,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - close(SslSocket) -> ok | {error, Reason} + close(SslSocket) -> ok | {error, Reason} Closes an TLS/DTLS connection. SslSocket = sslsocket() @@ -1044,7 +1044,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - controlling_process(SslSocket, NewOwner) -> + controlling_process(SslSocket, NewOwner) -> ok | {error, Reason} Assigns a new controlling process to the TLS/DTLS socket. @@ -1118,7 +1118,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - format_error(Reason) -> string() + format_error(Reason) -> string() Returns an error string. Reason = term() @@ -1129,7 +1129,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - getopts(SslSocket, OptionNames) -> + getopts(SslSocket, OptionNames) -> {ok, [socketoption()]} | {error, Reason} Gets the values of the specified options. @@ -1240,7 +1240,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - listen(Port, Options) -> + listen(Port, Options) -> {ok, ListenSocket} | {error, Reason} Creates an SSL listen socket. @@ -1268,7 +1268,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - peercert(SslSocket) -> {ok, Cert} | {error, Reason} + peercert(SslSocket) -> {ok, Cert} | {error, Reason} Returns the peer certificate. SslSocket = sslsocket() @@ -1283,7 +1283,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - peername(SslSocket) -> {ok, {Address, Port}} | + peername(SslSocket) -> {ok, {Address, Port}} | {error, Reason} Returns the peer address and port. @@ -1333,8 +1333,8 @@ fun(srp, Username :: string(), UserState :: term()) -> - recv(SslSocket, Length) -> - recv(SslSocket, Length, Timeout) -> {ok, Data} | {error, + recv(SslSocket, Length) -> + recv(SslSocket, Length, Timeout) -> {ok, Data} | {error, Reason} Receives data on a socket. @@ -1373,7 +1373,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - send(SslSocket, Data) -> ok | {error, Reason} + send(SslSocket, Data) -> ok | {error, Reason} Writes data to a socket. SslSocket = sslsocket() @@ -1387,7 +1387,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - setopts(SslSocket, Options) -> ok | {error, Reason} + setopts(SslSocket, Options) -> ok | {error, Reason} Sets socket options. SslSocket = sslsocket() @@ -1418,8 +1418,8 @@ fun(srp, Username :: string(), UserState :: term()) -> - ssl_accept(SslSocket) -> - ssl_accept(SslSocket, Timeout) -> ok | {error, Reason} + ssl_accept(SslSocket) -> + ssl_accept(SslSocket, Timeout) -> ok | {error, Reason} Performs server-side SSL/TLS handshake. SslSocket = sslsocket() @@ -1433,7 +1433,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - ssl_accept(Socket, SslOptions) -> + ssl_accept(Socket, SslOptions) -> ssl_accept(Socket, SslOptions, Timeout) -> {ok, Socket} | ok | {error, Reason} Performs server-side SSL/TLS/DTLS handshake. @@ -1449,7 +1449,7 @@ fun(srp, Username :: string(), UserState :: term()) -> - sockname(SslSocket) -> {ok, {Address, Port}} | + sockname(SslSocket) -> {ok, {Address, Port}} | {error, Reason} Returns the local address and port. @@ -1497,8 +1497,8 @@ fun(srp, Username :: string(), UserState :: term()) -> - transport_accept(ListenSocket) -> - transport_accept(ListenSocket, Timeout) -> + transport_accept(ListenSocket) -> + transport_accept(ListenSocket, Timeout) -> {ok, SslSocket} | {error, Reason} Accepts an incoming connection and prepares for ssl_accept. diff --git a/lib/stdlib/doc/src/array.xml b/lib/stdlib/doc/src/array.xml index db0ab42372..aa1577a067 100644 --- a/lib/stdlib/doc/src/array.xml +++ b/lib/stdlib/doc/src/array.xml @@ -32,7 +32,7 @@ A array.xml - array + array Functional, extendible arrays.

Functional, extendible arrays. Arrays can have fixed size, or can grow @@ -137,7 +137,7 @@ A3 = array:fix(A2). - + Get the value used for uninitialized entries.

Gets the value used for uninitialized entries.

@@ -146,7 +146,7 @@ A3 = array:fix(A2).
- + Fix the array size.

Fixes the array size. This prevents it from growing automatically @@ -157,7 +157,7 @@ A3 = array:fix(A2). - + Fold the array elements using the specified function and initial accumulator value. @@ -172,7 +172,7 @@ A3 = array:fix(A2). - + Fold the array elements right-to-left using the specified function and initial accumulator value. @@ -186,7 +186,7 @@ A3 = array:fix(A2). - + Equivalent to from_list(List, undefined).

Equivalent to @@ -195,7 +195,7 @@ A3 = array:fix(A2). - + Convert a list to an extendible array.

Converts a list to an extendible array. Default @@ -208,7 +208,7 @@ A3 = array:fix(A2). - + Equivalent to from_orddict(Orddict, undefined). @@ -218,7 +218,7 @@ A3 = array:fix(A2). - + Convert an ordered list of pairs {Index, Value} to a corresponding extendible array. @@ -234,7 +234,7 @@ A3 = array:fix(A2). - + Get the value of entry I.

Gets the value of entry I. If @@ -249,7 +249,7 @@ A3 = array:fix(A2). - + Returns true if X is an array, otherwise false. @@ -261,7 +261,7 @@ A3 = array:fix(A2). - + Check if the array has fixed size.

Checks if the array has fixed size. Returns true if the array @@ -271,7 +271,7 @@ A3 = array:fix(A2). - + Map the specified function onto each array element.

Maps the specified function onto each array element. The elements are @@ -285,7 +285,7 @@ A3 = array:fix(A2). - + Create a new, extendible array with initial size zero. @@ -296,7 +296,7 @@ A3 = array:fix(A2). - + Create a new array according to the specified options. @@ -346,7 +346,7 @@ array:new([{size,10},{fixed,false},{default,-1}]) - + Create a new array according to the specified size and options. @@ -370,7 +370,7 @@ array:new(100, {default,0}) - + Make the array resizable.

Makes the array resizable. (Reverses the effects of @@ -380,7 +380,7 @@ array:new(100, {default,0}) - + Reset entry I to the default value for the array. @@ -399,7 +399,7 @@ array:new(100, {default,0}) - + Change the array size to that reported by sparse_size/1. @@ -413,7 +413,7 @@ array:new(100, {default,0}) - + Change the array size.

Change the array size. If Size is not a @@ -424,7 +424,7 @@ array:new(100, {default,0}) - + Set entry I of the array to Value.

Sets entry I of the array to @@ -441,7 +441,7 @@ array:new(100, {default,0}) - + Get the number of entries in the array.

Gets the number of entries in the array. Entries are numbered from @@ -454,7 +454,7 @@ array:new(100, {default,0}) - + Fold the array elements using the specified function and initial accumulator value, skipping default-valued entries. @@ -469,7 +469,7 @@ array:new(100, {default,0}) - + Fold the array elements right-to-left using the specified function and initial accumulator value, skipping default-valued entries. @@ -485,7 +485,7 @@ array:new(100, {default,0}) - + Map the specified function onto each array element, skipping default-valued entries. @@ -498,7 +498,7 @@ array:new(100, {default,0}) - + Get the number of entries in the array up until the last non-default-valued entry. @@ -512,7 +512,7 @@ array:new(100, {default,0}) - + Convert the array to a list, skipping default-valued entries. @@ -522,7 +522,7 @@ array:new(100, {default,0}) - + Convert the array to an ordered list of pairs {Index, Value}, skipping default-valued entries. @@ -534,7 +534,7 @@ array:new(100, {default,0}) - + Convert the array to a list.

Converts the array to a list.

@@ -545,7 +545,7 @@ array:new(100, {default,0})
- + Convert the array to an ordered list of pairs {Index, Value}. diff --git a/lib/stdlib/doc/src/base64.xml b/lib/stdlib/doc/src/base64.xml index cfa1ecc006..479072ba4f 100644 --- a/lib/stdlib/doc/src/base64.xml +++ b/lib/stdlib/doc/src/base64.xml @@ -29,7 +29,7 @@ base64.xml - base64 + base64 Provides base64 encode and decode, see RFC 2045. @@ -51,10 +51,10 @@ - - - - + + + + Decode a base64 encoded string to data. @@ -69,8 +69,8 @@ - - + + Encode data into base64. diff --git a/lib/stdlib/doc/src/beam_lib.xml b/lib/stdlib/doc/src/beam_lib.xml index 473170c839..8bb4cf9101 100644 --- a/lib/stdlib/doc/src/beam_lib.xml +++ b/lib/stdlib/doc/src/beam_lib.xml @@ -28,7 +28,7 @@ 1999-10-30 PA1 - beam_lib + beam_lib An interface to the BEAM file format.

This module provides an interface to files created by @@ -283,7 +283,7 @@ io:fwrite("~s~n", [erl_prettypr:format(erl_syntax:form_list(AC))]). - + Read selected chunks from a BEAM file or binary.

Reads chunk data for selected chunks references. The order of @@ -293,7 +293,7 @@ io:fwrite("~s~n", [erl_prettypr:format(erl_syntax:form_list(AC))]). - + Read selected chunks from a BEAM file or binary.

Reads chunk data for selected chunks references. The order of @@ -312,7 +312,7 @@ io:fwrite("~s~n", [erl_prettypr:format(erl_syntax:form_list(AC))]). - + Unregister the current crypto key fun.

Unregisters the crypto key fun and terminates the process @@ -327,7 +327,7 @@ io:fwrite("~s~n", [erl_prettypr:format(erl_syntax:form_list(AC))]). - + Compare two BEAM files. @@ -341,7 +341,7 @@ io:fwrite("~s~n", [erl_prettypr:format(erl_syntax:form_list(AC))]). - + Compare the BEAM files in two directories.

Compares the BEAM files in @@ -359,7 +359,7 @@ io:fwrite("~s~n", [erl_prettypr:format(erl_syntax:form_list(AC))]). - + Register a fun that provides a crypto key. @@ -398,7 +398,7 @@ CryptoKeyFun(clear) -> term() - + Compare the BEAM files in two directories.

Compares the BEAM files in two directories as @@ -409,7 +409,7 @@ CryptoKeyFun(clear) -> term() - + Return an English description of a BEAM read error reply. @@ -422,7 +422,7 @@ CryptoKeyFun(clear) -> term() - + Information about a BEAM file.

Returns a list containing some information about a BEAM file @@ -449,7 +449,7 @@ CryptoKeyFun(clear) -> term() - + Read the module version of the BEAM file.

Calculates an MD5 redundancy check for the code of the module @@ -458,7 +458,7 @@ CryptoKeyFun(clear) -> term() - + Remove chunks not needed by the loader from a BEAM file. @@ -470,7 +470,7 @@ CryptoKeyFun(clear) -> term() - + Removes chunks not needed by the loader from BEAM files. @@ -483,7 +483,7 @@ CryptoKeyFun(clear) -> term() - + Remove chunks not needed by the loader from all BEAM files of a release. @@ -497,7 +497,7 @@ CryptoKeyFun(clear) -> term() - + Read the module version of the BEAM file.

Returns the module version or versions. A version is defined by diff --git a/lib/stdlib/doc/src/c.xml b/lib/stdlib/doc/src/c.xml index 40e6d9d43e..29edc373c7 100644 --- a/lib/stdlib/doc/src/c.xml +++ b/lib/stdlib/doc/src/c.xml @@ -28,7 +28,7 @@ 1996-10-30 B - c + c Command interface module.

This module enables users to enter the short form of @@ -41,7 +41,7 @@ - + Stack backtrace for a process.

Stack backtrace for a process. Equivalent to @@ -50,8 +50,8 @@ - - + + Compile and load a file or module. @@ -80,7 +80,7 @@ - + Change working directory.

Changes working directory to Dir, which can be a @@ -103,7 +103,7 @@ - + Flush any messages sent to the shell.

Flushes any messages sent to the shell.

@@ -111,7 +111,7 @@
- + Help information.

Displays help information: all valid shell internal commands, @@ -120,8 +120,8 @@ - - + + System information.

i/0 displays system information, listing @@ -131,7 +131,7 @@ - + Information about pid <X.Y.Z>.

Displays information about a process, Equivalent to @@ -141,7 +141,7 @@ - + Load or reload a module.

Purges and loads, or reloads, a module by calling @@ -154,7 +154,7 @@ - lc(Files) -> ok + lc(Files) -> ok Compile a list of files. Files = [File] @@ -180,7 +180,7 @@ - + List files in the current directory.

Lists files in the current directory.

@@ -188,7 +188,7 @@
- + List files in a directory or a single file.

Lists files in directory Dir or, if Dir @@ -197,7 +197,7 @@ - + Which modules are loaded.

Displays information about the loaded modules, including @@ -206,7 +206,7 @@ - + Information about a module.

Displays information about Module.

@@ -223,7 +223,7 @@
- + Memory allocation information.

Memory allocation information. Equivalent to @@ -232,8 +232,8 @@ - - + + Memory allocation information.

Memory allocation information. Equivalent to @@ -242,8 +242,8 @@ - - + + Compile and load code in a file on all nodes.

Compiles and then loads the code for a file on all nodes. @@ -255,7 +255,7 @@ compile:file(File, Options ++ [report_errors, report_w - + Load module on all nodes.

Loads Module on all nodes.

@@ -263,7 +263,7 @@ compile:file(File, Options ++ [report_errors, report_w
- + Convert X,Y,Z to a pid.

Converts X, Y, @@ -273,7 +273,7 @@ compile:file(File, Options ++ [report_errors, report_w - + Print working directory.

Prints the name of the working directory.

@@ -281,7 +281,7 @@ compile:file(File, Options ++ [report_errors, report_w
- + Quit - shorthand for init:stop().

This function is shorthand for init:stop(), that is, @@ -290,8 +290,8 @@ compile:file(File, Options ++ [report_errors, report_w - - + + Information about registered processes.

regs/0 displays information about all registered @@ -310,7 +310,7 @@ compile:file(File, Options ++ [report_errors, report_w - xm(ModSpec) -> void() + xm(ModSpec) -> void() Cross-reference check a module. ModSpec = Module | Filename @@ -325,7 +325,7 @@ compile:file(File, Options ++ [report_errors, report_w - y(File) -> YeccRet + y(File) -> YeccRet Generate an LALR-1 parser. File = name() @@ -344,7 +344,7 @@ yecc:file(File) - y(File, Options) -> YeccRet + y(File, Options) -> YeccRet Generate an LALR-1 parser. File = name() diff --git a/lib/stdlib/doc/src/calendar.xml b/lib/stdlib/doc/src/calendar.xml index 0d2f3ab3d3..518a085c89 100644 --- a/lib/stdlib/doc/src/calendar.xml +++ b/lib/stdlib/doc/src/calendar.xml @@ -28,7 +28,7 @@ 1996-11-05 B - calendar + calendar Local and universal time, day of the week, date and time conversions. @@ -128,8 +128,8 @@ - - + + Compute the number of days from year 0 up to the specified date. @@ -143,7 +143,7 @@ - + Compute the number of seconds from year 0 up to the specified date and time. @@ -153,8 +153,8 @@ - - + + Compute the day of the week. @@ -169,7 +169,7 @@ - + Compute the date from the number of gregorian days.

Computes the date from the specified number of gregorian days.

@@ -177,7 +177,7 @@
- + Compute the date and time from the number of gregorian seconds. @@ -187,7 +187,7 @@ - + Check if the year is a leap year.

Checks if the specified year is a leap year.

@@ -215,7 +215,7 @@
- + Compute the number of days in a month.

Computes the number of days in a month.

@@ -223,7 +223,7 @@
- + Compute local time.

Returns the local time reported by @@ -232,7 +232,7 @@ - + Convert from local time to universal time (deprecated). @@ -253,7 +253,7 @@ - + Convert from local time to universal time(s).

Converts from local time to Universal Coordinated Time (UTC). @@ -285,7 +285,7 @@ - + Convert now to date and time.

Returns Universal Coordinated Time (UTC) @@ -296,7 +296,7 @@ - + Convert now to local date and time.

Returns local date and time converted from the return value from @@ -306,7 +306,7 @@ - + Convert now to date and time.

Returns Universal Coordinated Time (UTC) @@ -343,7 +343,7 @@ - + Compute days and time from seconds.

Converts a specified number of seconds into days, hours, minutes, @@ -354,7 +354,7 @@ - + Compute time from seconds. @@ -434,7 +434,7 @@ - + Compute the difference between two times (deprecated). @@ -449,7 +449,7 @@ - + Compute the number of seconds since midnight up to the specified time. @@ -460,7 +460,7 @@ - + Compute universal time.

Returns the Universal Coordinated Time (UTC) @@ -470,7 +470,7 @@ - + Convert from universal time to local time.

Converts from Universal Coordinated Time (UTC) to local time. @@ -480,8 +480,8 @@ - - + + Check if a date is valid diff --git a/lib/stdlib/doc/src/dets.xml b/lib/stdlib/doc/src/dets.xml index eb6e32aecf..8e4e002000 100644 --- a/lib/stdlib/doc/src/dets.xml +++ b/lib/stdlib/doc/src/dets.xml @@ -32,7 +32,7 @@ B dets.xml - dets + dets A disk-based term storage.

This module provides a term storage on file. The @@ -188,7 +188,7 @@ - + Return a list of the names of all open Dets tables on this node. @@ -197,7 +197,7 @@ - + Return a chunk of objects stored in a Dets table. @@ -227,7 +227,7 @@ - + Close a Dets table.

Closes a table. Only processes that have opened a table are @@ -239,7 +239,7 @@ - + Delete all objects with a specified key from a Dets table. @@ -249,7 +249,7 @@ - + Delete all objects from a Dets table.

Deletes all objects from a table in almost constant time. @@ -259,7 +259,7 @@ - + Delete a specified object from a Dets table.

Deletes all instances of a specified object from a table. If a @@ -270,7 +270,7 @@ - + Return the first key stored in a Dets table.

Returns the first key stored in table Name @@ -295,8 +295,8 @@ - - + + Fold a function over a Dets table.

Calls Function on successive elements of @@ -309,7 +309,7 @@ - + Replace the objects of a Dets table with the objects of an ETS table. @@ -322,7 +322,7 @@ - + Return information about a Dets table.

Returns information about table Name @@ -354,7 +354,7 @@ - + Return the information associated with a specified item for a Dets table. @@ -455,8 +455,8 @@ - - + + Replace all objects of a Dets table.

Replaces the existing objects of table Name @@ -516,7 +516,7 @@ - + Insert one or more objects into a Dets table.

Inserts one or more objects into the table Name. @@ -527,7 +527,7 @@ - + Insert one or more objects into a Dets table.

Inserts one or more objects into table Name. @@ -539,7 +539,7 @@ - + Test compatibility of chunk data of a table.

Returns true if it would be possible to initialize @@ -554,7 +554,7 @@ - + Test for a Dets table.

Returns true if file Filename @@ -563,7 +563,7 @@ - + Return all objects with a specified key stored in a Dets table. @@ -590,7 +590,7 @@ ok - + Match a chunk of objects stored in a Dets table and return a list of variable bindings. @@ -606,7 +606,7 @@ ok - + Match the objects stored in a Dets table and return a list of variable bindings. @@ -622,7 +622,7 @@ ok - + Match the first chunk of objects stored in a Dets table and return a list of variable bindings. @@ -654,7 +654,7 @@ ok - + Delete all objects that match a given pattern from a Dets table. @@ -667,7 +667,7 @@ ok - + Match a chunk of objects stored in a Dets table and return a list of objects. @@ -683,7 +683,7 @@ ok - + Match the objects stored in a Dets table and return a list of objects. @@ -702,7 +702,7 @@ ok - + Match the first chunk of objects stored in a Dets table and return a list of objects. @@ -735,7 +735,7 @@ ok - + Test for occurrence of a key in a Dets table.

Works like lookup/2, @@ -746,7 +746,7 @@ ok - + Return the next key in a Dets table.

Returns either the key following Key1 in table @@ -760,7 +760,7 @@ ok - + Open an existing Dets table.

Opens an existing table. If the table is not properly closed, @@ -770,7 +770,7 @@ ok - + Open a Dets table.

Opens a table. An empty Dets table is created if no file @@ -872,7 +872,7 @@ ok - + Return the name of the Dets table handled by a pid.

Returns the table name given the pid of a process @@ -883,7 +883,7 @@ ok - + Repair a continuation from select/1 or select/3. @@ -917,7 +917,7 @@ ok - + Fix a Dets table for safe traversal.

If Fix is true, table @@ -945,7 +945,7 @@ ok - + Apply a match specification to some objects stored in a Dets table. @@ -962,7 +962,7 @@ ok - + Apply a match specification to all objects stored in a Dets table. @@ -984,7 +984,7 @@ ok - + Apply a match specification to the first chunk of objects stored in a Dets table. @@ -1019,7 +1019,7 @@ ok - + Delete all objects that match a given pattern from a Dets table. @@ -1036,7 +1036,7 @@ ok - + Return the list of objects associated with a slot of a Dets table. @@ -1049,7 +1049,7 @@ ok - + Ensure that all updates made to a Dets table are written to disk. @@ -1064,8 +1064,8 @@ ok - - + + Return a QLC query handle.

Returns a Query List @@ -1140,7 +1140,7 @@ true - + Insert all objects of a Dets table into an ETS table. @@ -1153,7 +1153,7 @@ true - + Apply a function to all or some objects stored in a Dets table. @@ -1192,7 +1192,7 @@ fun(X) -> {continue, X} end. - + Update a counter object stored in a Dets table. diff --git a/lib/stdlib/doc/src/dict.xml b/lib/stdlib/doc/src/dict.xml index e35b64d5e2..95a98cef12 100644 --- a/lib/stdlib/doc/src/dict.xml +++ b/lib/stdlib/doc/src/dict.xml @@ -28,7 +28,7 @@ 1997-01-15 B - dict + dict Key-value dictionary.

This module provides a Key-Value dictionary. @@ -55,7 +55,7 @@ - + Append a value to keys in a dictionary.

Appends a new Value to the current list @@ -65,7 +65,7 @@ - + Append new values to keys in a dictionary.

Appends a list of values ValList to @@ -77,7 +77,7 @@ - + Erase a key from a dictionary.

Erases all items with a given key from a dictionary.

@@ -85,7 +85,7 @@
- + Look up values in a dictionary.

Returns the value associated with Key @@ -98,7 +98,7 @@ - + Return all keys in a dictionary.

Returns a list of all keys in dictionary Dict.

@@ -116,7 +116,7 @@
- + Select elements that satisfy a predicate.

Dict2 is a dictionary of all keys and values in @@ -127,7 +127,7 @@ - + Search for a key in a dictionary.

Searches for a key in dictionary Dict. Returns @@ -139,7 +139,7 @@ - + Fold a function over a dictionary.

Calls Fun on successive keys and values of @@ -153,7 +153,7 @@ - + Convert a list of pairs to a dictionary.

Converts the Key-Value list @@ -171,7 +171,7 @@ - + Test if a key is in a dictionary.

Tests if Key is contained in @@ -180,7 +180,7 @@ - + Map a function over a dictionary.

Calls Fun on successive keys and values @@ -190,7 +190,7 @@ - + Merge two dictionaries.

Merges two dictionaries, Dict1 and @@ -209,7 +209,7 @@ merge(Fun, D1, D2) -> - + Create a dictionary.

Creates a new dictionary.

@@ -217,7 +217,7 @@ merge(Fun, D1, D2) ->
- + Return the number of elements in a dictionary.

Returns the number of elements in dictionary @@ -226,7 +226,7 @@ merge(Fun, D1, D2) -> - + Store a value in a dictionary.

Stores a Key-Value pair in @@ -237,7 +237,7 @@ merge(Fun, D1, D2) -> - + Convert a dictionary to a list of pairs.

Converts dictionary Dict to a list representation.

@@ -245,7 +245,7 @@ merge(Fun, D1, D2) ->
- + Update a value in a dictionary.

Updates a value in a dictionary by calling Fun on @@ -255,7 +255,7 @@ merge(Fun, D1, D2) -> - + Update a value in a dictionary.

Updates a value in a dictionary by calling Fun on @@ -269,7 +269,7 @@ append(Key, Val, D) -> - + Increment a value in a dictionary.

Adds Increment to the value associated with diff --git a/lib/stdlib/doc/src/digraph.xml b/lib/stdlib/doc/src/digraph.xml index a5252b443b..cf2c0844c9 100644 --- a/lib/stdlib/doc/src/digraph.xml +++ b/lib/stdlib/doc/src/digraph.xml @@ -32,7 +32,7 @@ C digraph.xml - digraph + digraph Directed graphs.

This module provides a version of labeled @@ -144,9 +144,9 @@ - - - + + + Add an edge to a digraph. @@ -183,9 +183,9 @@ - - - + + + Add or modify a vertex of a digraph.

add_vertex/3 creates (or modifies) vertex @@ -204,7 +204,7 @@ - + Delete an edge from a digraph.

Deletes edge E from digraph @@ -213,7 +213,7 @@ - + Delete edges from a digraph.

Deletes the edges in list Edges from digraph @@ -222,7 +222,7 @@ - + Delete paths from a digraph.

Deletes edges from digraph G until there are no @@ -252,7 +252,7 @@ - + Delete a vertex from a digraph.

Deletes vertex V from digraph @@ -265,7 +265,7 @@ - + Delete vertices from a digraph.

Deletes the vertices in list Vertices from @@ -274,7 +274,7 @@ - + Delete a digraph.

Deletes digraph G. This call is important @@ -285,7 +285,7 @@ - + Return the vertices and the label of an edge of a digraph. @@ -303,7 +303,7 @@ - + Return all edges of a digraph.

Returns a list of all edges of digraph G, in @@ -312,7 +312,7 @@ - + Return the edges emanating from or incident on a vertex of a digraph. @@ -324,7 +324,7 @@ - + Find one cycle in a digraph.

If a simple cycle of @@ -341,7 +341,7 @@ - + Find one path in a digraph.

Tries to find @@ -357,7 +357,7 @@ - + Find one short cycle in a digraph.

Tries to find an as short as possible @@ -375,7 +375,7 @@ - + Find one short path in a digraph.

Tries to find an as short as possible @@ -392,7 +392,7 @@ - + Return the in-degree of a vertex of a digraph.

Returns the in-degree of @@ -401,7 +401,7 @@ - + Return all edges incident on a vertex of a digraph.

Returns a list of all @@ -412,7 +412,7 @@ - + Return all in-neighbors of a vertex of a digraph.

Returns a list of @@ -423,7 +423,7 @@ - + Return information about a digraph. @@ -453,7 +453,7 @@ - + Return a protected empty digraph, where cycles are allowed. @@ -462,7 +462,7 @@ - + Create a new empty digraph. @@ -492,7 +492,7 @@ - + Return the number of edges of a digraph.

Returns the number of edges of digraph G.

@@ -500,7 +500,7 @@
- + Return the number of vertices of a digraph.

Returns the number of vertices of digraph G.

@@ -508,7 +508,7 @@
- + Return the out-degree of a vertex of a digraph.

Returns the out-degree of @@ -517,7 +517,7 @@ - + Return all edges emanating from a vertex of a digraph. @@ -529,7 +529,7 @@ - + Return all out-neighbors of a vertex of a digraph.

Returns a list of @@ -540,7 +540,7 @@ - + Return the label of a vertex of a digraph.

Returns {VLabel}, @@ -553,7 +553,7 @@ - + Return all vertices of a digraph.

Returns a list of all vertices of digraph G, in diff --git a/lib/stdlib/doc/src/digraph_utils.xml b/lib/stdlib/doc/src/digraph_utils.xml index cb316e5b93..13b0aaad9e 100644 --- a/lib/stdlib/doc/src/digraph_utils.xml +++ b/lib/stdlib/doc/src/digraph_utils.xml @@ -32,7 +32,7 @@ PA1 digraph_utils.xml - digraph_utils + digraph_utils Algorithms for directed graphs.

This module provides algorithms based on depth-first traversal of @@ -154,7 +154,7 @@ - + Check if a digraph is an arborescence.

Returns {yes, Root} if Root @@ -164,7 +164,7 @@ - + Return the components of a digraph.

Returns a list @@ -177,7 +177,7 @@ - + Return a condensed graph of a digraph.

Creates a digraph where the vertices are @@ -202,7 +202,7 @@ - + Return the cyclic strong components of a digraph.

Returns a list of strongly @@ -218,7 +218,7 @@ - + Check if a digraph is acyclic.

Returns true if and only if digraph @@ -228,7 +228,7 @@ - + Check if a digraph is an arborescence.

Returns true if and only if digraph @@ -238,7 +238,7 @@ - + Check if a digraph is a tree.

Returns true if and only if digraph @@ -248,7 +248,7 @@ - + Return the vertices of a digraph included in some loop. @@ -258,7 +258,7 @@ - + Return the vertices of a digraph in postorder.

Returns all vertices of digraph Digraph. @@ -273,7 +273,7 @@ - + Return the vertices of a digraph in preorder.

Returns all vertices of digraph Digraph. @@ -285,7 +285,7 @@ - + Return the vertices reachable from some vertices of a digraph. @@ -300,7 +300,7 @@ - + Return the neighbors reachable from some vertices of a digraph. @@ -316,7 +316,7 @@ - + Return the vertices that reach some vertices of a digraph. @@ -330,7 +330,7 @@ - + Return the neighbors that reach some vertices of a digraph. @@ -345,7 +345,7 @@ - + Return the strong components of a digraph.

Returns a list of strongly @@ -359,8 +359,8 @@ - - + + Return a subgraph of a digraph.

Creates a maximal subgraph @@ -387,7 +387,7 @@ - + Return a topological sorting of the vertices of a digraph. diff --git a/lib/stdlib/doc/src/epp.xml b/lib/stdlib/doc/src/epp.xml index d9eefc19e0..110c1cea2c 100644 --- a/lib/stdlib/doc/src/epp.xml +++ b/lib/stdlib/doc/src/epp.xml @@ -32,7 +32,7 @@ B epp.xml - epp + epp An Erlang code preprocessor.

The Erlang code preprocessor includes functions that are used by the @@ -76,7 +76,7 @@ - + Close the preprocessing of the file associated with Epp. @@ -136,7 +136,7 @@ - + Open a file for preprocessing.

Equivalent to @@ -145,7 +145,7 @@ - + Open a file for preprocessing.

Equivalent to epp:open([{name, FileName}, {includes, IncludePath}, @@ -154,7 +154,7 @@ - + Return the next Erlang form from the opened Erlang source file. @@ -185,7 +185,7 @@ - + Preprocess and parse an Erlang source file.

Equivalent to epp:parse_file(FileName, [{includes, IncludePath}, diff --git a/lib/stdlib/doc/src/erl_eval.xml b/lib/stdlib/doc/src/erl_eval.xml index 1c0f7f062f..813cbecd89 100644 --- a/lib/stdlib/doc/src/erl_eval.xml +++ b/lib/stdlib/doc/src/erl_eval.xml @@ -32,7 +32,7 @@ B erl_eval.xml - erl_eval + erl_eval The Erlang meta interpreter.

This module provides an interpreter for Erlang expressions. The @@ -96,7 +96,7 @@ - + Add a binding.

Adds binding Name=Value @@ -106,7 +106,7 @@ - + Return bindings.

Returns the binding of Name @@ -115,7 +115,7 @@ - + Return bindings.

Returns the list of bindings contained in the binding @@ -124,7 +124,7 @@ - + Delete a binding.

Removes the binding of Name @@ -134,10 +134,10 @@ - - - - + + + + Evaluate expression.

Evaluates Expression with the set of bindings @@ -157,9 +157,9 @@ - - - + + + Evaluate a list of expressions.

Evaluates a list of expressions in parallel, using the same @@ -174,9 +174,9 @@ - - - + + + Evaluate expressions.

Evaluates Expressions with the set of bindings @@ -197,7 +197,7 @@ - + Return a bindings structure.

Returns an empty binding structure.

diff --git a/lib/stdlib/doc/src/erl_expand_records.xml b/lib/stdlib/doc/src/erl_expand_records.xml index b6aa75ed03..20e5f1960b 100644 --- a/lib/stdlib/doc/src/erl_expand_records.xml +++ b/lib/stdlib/doc/src/erl_expand_records.xml @@ -34,7 +34,7 @@ PA1 erl_expand_records.xml - erl_expand_records + erl_expand_records Expands records in a module.

This module expands records in a module.

@@ -42,7 +42,7 @@ - + Expand all records in a module.

Expands all records in a module to use explicit tuple diff --git a/lib/stdlib/doc/src/erl_id_trans.xml b/lib/stdlib/doc/src/erl_id_trans.xml index 16952a9582..ec66842ac0 100644 --- a/lib/stdlib/doc/src/erl_id_trans.xml +++ b/lib/stdlib/doc/src/erl_id_trans.xml @@ -34,7 +34,7 @@ B erl_id_trans.xml - erl_id_trans + erl_id_trans An identity parse transform.

This module performs an identity parse transformation of Erlang code. @@ -46,7 +46,7 @@ - parse_transform(Forms, Options) -> Forms + parse_transform(Forms, Options) -> Forms Transform Erlang forms. Forms = [erl_parse:abstract_form() diff --git a/lib/stdlib/doc/src/erl_internal.xml b/lib/stdlib/doc/src/erl_internal.xml index 45264e82a8..77551ffed7 100644 --- a/lib/stdlib/doc/src/erl_internal.xml +++ b/lib/stdlib/doc/src/erl_internal.xml @@ -34,7 +34,7 @@ B erl_internal.xml - erl_internal + erl_internal Internal Erlang definitions.

This module defines Erlang BIFs, guard tests, and operators. @@ -54,7 +54,7 @@ - + Test for an arithmetic operator.

Returns true if OpName/Arity @@ -63,7 +63,7 @@ - + Test for an Erlang BIF.

Returns true if Name/Arity @@ -73,7 +73,7 @@ - + Test for a Boolean operator.

Returns true if OpName/Arity @@ -82,7 +82,7 @@ - + Test for a comparison operator.

Returns true if OpName/Arity @@ -91,7 +91,7 @@ - + Test for an Erlang BIF allowed in guards.

Returns true if Name/Arity is @@ -100,7 +100,7 @@ - + Test for a list operator.

Returns true if OpName/Arity @@ -109,7 +109,7 @@ - + Return operator type.

Returns the Type of operator that @@ -120,7 +120,7 @@ - + Test for a send operator.

Returns true if OpName/Arity @@ -129,7 +129,7 @@ - + Test for a valid type test.

Returns true if Name/Arity is diff --git a/lib/stdlib/doc/src/erl_lint.xml b/lib/stdlib/doc/src/erl_lint.xml index 77cb7a9916..12eaafc3a8 100644 --- a/lib/stdlib/doc/src/erl_lint.xml +++ b/lib/stdlib/doc/src/erl_lint.xml @@ -32,7 +32,7 @@ B erl_lint.xml - erl_lint + erl_lint The Erlang code linter.

This module is used to check Erlang code for illegal syntax and @@ -78,7 +78,7 @@ - + Format an error descriptor.

Takes an ErrorDescriptor and returns a string @@ -90,7 +90,7 @@ - + Test for a guard test.

Tests if Expr is a legal guard test. @@ -102,9 +102,9 @@ - - - + + + Check a module for errors.

Checks all the forms in a module for errors. It returns:

diff --git a/lib/stdlib/doc/src/erl_parse.xml b/lib/stdlib/doc/src/erl_parse.xml index dd15d495a4..8142e5c0aa 100644 --- a/lib/stdlib/doc/src/erl_parse.xml +++ b/lib/stdlib/doc/src/erl_parse.xml @@ -32,7 +32,7 @@ B erl_parse.xml - erl_parse + erl_parse The Erlang parser.

This module is the basic Erlang parser that converts tokens into @@ -89,7 +89,7 @@ - + Convert an Erlang term into an abstract form.

Converts the Erlang data structure Data into an @@ -171,7 +171,7 @@ - format_error(ErrorDescriptor) -> Chars + format_error(ErrorDescriptor) -> Chars Format an error descriptor. ErrorDescriptor = - + Convert abstract form to an Erlang term.

Converts the abstract form AbsTerm of a @@ -247,7 +247,7 @@ - + Parse Erlang expressions.

Parses Tokens as if it was a list of expressions. @@ -267,7 +267,7 @@ - + Parse an Erlang form.

Parses Tokens as if it was a form. Returns one @@ -287,7 +287,7 @@ - + Parse an Erlang term.

Parses Tokens as if it was a term. Returns @@ -307,8 +307,8 @@ - - + + Generate a list of tokens for an expression.

Generates a list of tokens representing the abstract diff --git a/lib/stdlib/doc/src/erl_pp.xml b/lib/stdlib/doc/src/erl_pp.xml index 77a7f1e8d1..f1c3aa5a41 100644 --- a/lib/stdlib/doc/src/erl_pp.xml +++ b/lib/stdlib/doc/src/erl_pp.xml @@ -34,7 +34,7 @@ B erl_pp.xml - erl_pp + erl_pp The Erlang pretty printer.

The functions in this module are used to generate @@ -73,8 +73,8 @@ - - + + Pretty print an attribute.

Same as form/1,2, @@ -83,10 +83,10 @@ - - - - + + + + Pretty print one Expression.

Prints one expression. It is useful for implementing hooks (see @@ -96,9 +96,9 @@ - - - + + + Pretty print Expressions.

Same as form/1,2, @@ -108,8 +108,8 @@ - - + + Pretty print a form.

Pretty prints a @@ -120,8 +120,8 @@ - - + + Pretty print a function.

Same as form/1,2, @@ -130,8 +130,8 @@ - - + + Pretty print a guard.

Same as form/1,2, diff --git a/lib/stdlib/doc/src/erl_scan.xml b/lib/stdlib/doc/src/erl_scan.xml index 6507f23dab..38111f73bc 100644 --- a/lib/stdlib/doc/src/erl_scan.xml +++ b/lib/stdlib/doc/src/erl_scan.xml @@ -32,7 +32,7 @@ B erl_scan.xml - erl_scan + erl_scan The Erlang token scanner.

This module contains functions for tokenizing (scanning) characters into @@ -101,7 +101,7 @@ - + Format an error descriptor.

Uses an ErrorDescriptor and returns a string @@ -131,7 +131,7 @@ - + Test for a reserved word.

Returns true if Atom is an @@ -140,9 +140,9 @@ - - - + + + Scan a string and return the Erlang tokens.

Takes the list of characters String and tries to @@ -247,8 +247,8 @@ - - + + Re-entrant scanner. diff --git a/lib/stdlib/doc/src/erl_tar.xml b/lib/stdlib/doc/src/erl_tar.xml index 0a0b5fa115..ea8173748a 100644 --- a/lib/stdlib/doc/src/erl_tar.xml +++ b/lib/stdlib/doc/src/erl_tar.xml @@ -32,7 +32,7 @@ A erl_tar.xml - erl_tar + erl_tar Unix 'tar' utility for reading and writing tar archives. @@ -127,7 +127,7 @@ - add(TarDescriptor, Filename, Options) -> RetValue + add(TarDescriptor, Filename, Options) -> RetValue Add a file to an open tar file. TarDescriptor = term() @@ -211,7 +211,7 @@ - add(TarDescriptor, FilenameOrBin, NameInArchive, Options) -> + add(TarDescriptor, FilenameOrBin, NameInArchive, Options) -> RetValue Add a file to an open tar file. @@ -233,7 +233,7 @@ - close(TarDescriptor) + close(TarDescriptor) Close an open tar file. TarDescriptor = term() @@ -245,7 +245,7 @@ - create(Name, FileList) ->RetValue + create(Name, FileList) ->RetValue Create a tar archive. Name = filename() @@ -264,7 +264,7 @@ - create(Name, FileList, OptionList) + create(Name, FileList, OptionList) Create a tar archive with options. Name = filename() @@ -315,7 +315,7 @@ - extract(Name) -> RetValue + extract(Name) -> RetValue Extract all files from a tar file. Name = filename() | {binary,binary()} | {file,Fd} @@ -339,7 +339,7 @@ - extract(Name, OptionList) + extract(Name, OptionList) Extract files from a tar file. Name = filename() | {binary,binary()} | {file,Fd} @@ -411,7 +411,7 @@ - format_error(Reason) -> string() + format_error(Reason) -> string() Convert error term to a readable string. Reason = term() @@ -518,7 +518,7 @@ erl_tar:close(TarDesc) - open(Name, OpenModeList) -> RetValue + open(Name, OpenModeList) -> RetValue Open a tar file for writing. Name = filename() @@ -565,7 +565,7 @@ erl_tar:close(TarDesc) - table(Name) -> RetValue + table(Name) -> RetValue Retrieve the name of all files in a tar file. Name = filename()|{binary,binary()}|{file,file_descriptor()} @@ -578,7 +578,7 @@ erl_tar:close(TarDesc) - table(Name, Options) + table(Name, Options) Retrieve name and information of all files in a tar file. @@ -590,7 +590,7 @@ erl_tar:close(TarDesc) - t(Name) + t(Name) Print the name of each file in a tar file. Name = filename()|{binary,binary()}|{file,file_descriptor()} @@ -602,7 +602,7 @@ erl_tar:close(TarDesc) - tt(Name) + tt(Name) Print name and information for each file in a tar file. diff --git a/lib/stdlib/doc/src/ets.xml b/lib/stdlib/doc/src/ets.xml index 98c5c39f2b..70d1aaa74d 100644 --- a/lib/stdlib/doc/src/ets.xml +++ b/lib/stdlib/doc/src/ets.xml @@ -28,7 +28,7 @@ - ets + ets Built-in term storage.

This module is an interface to the Erlang built-in term storage @@ -207,7 +207,7 @@ - + Return a list of all ETS tables.

Returns a list of all tables at the node. Named tables are @@ -222,7 +222,7 @@ - + Delete an entire ETS table.

Deletes the entire table Tab.

@@ -230,7 +230,7 @@
- + Delete all objects with a specified key from an ETS table. @@ -240,7 +240,7 @@ - + Delete all objects in an ETS table.

Delete all objects in the ETS table Tab. @@ -250,7 +250,7 @@ - + Deletes a specific from an ETS table.

Delete the exact object Object from the @@ -262,7 +262,7 @@ - + Read an ETS table from a file.

Reads a file produced by @@ -274,7 +274,7 @@ - + Read an ETS table from a file.

Reads a file produced by @@ -306,7 +306,7 @@ - + Return the first key in an ETS table.

Returns the first key Key in table @@ -321,7 +321,7 @@ - + Fold a function over an ETS table.

Acc0 is returned if the table is empty. @@ -337,7 +337,7 @@ - + Fold a function over an ETS table.

Acc0 is returned if the table is empty. @@ -353,7 +353,7 @@ - + Fill an ETS table with objects from a Dets table. @@ -367,7 +367,7 @@ - + Pseudo function that transforms fun syntax to a match specification. @@ -436,7 +436,7 @@ Error: fun containing local Erlang function calls - + Change owner of a table.

Make process Pid the new owner of table @@ -454,7 +454,7 @@ Error: fun containing local Erlang function calls - + Display information about all ETS tables on a terminal. @@ -463,7 +463,7 @@ Error: fun containing local Erlang function calls - + Browse an ETS table on a terminal.

Browses table Tab on a terminal.

@@ -471,7 +471,7 @@ Error: fun containing local Erlang function calls
- + Return information about an table.

Returns information about table Tab as a list of @@ -547,7 +547,7 @@ Error: fun containing local Erlang function calls - + Return the information associated with the specified item for an ETS table. @@ -619,7 +619,7 @@ Error: fun containing local Erlang function calls - + Replace all objects of an ETS table.

Replaces the existing objects of table Tab with @@ -649,7 +649,7 @@ Error: fun containing local Erlang function calls - + Insert an object into an ETS table.

Inserts the object or all of the objects in list @@ -681,7 +681,7 @@ Error: fun containing local Erlang function calls - + Insert an object into an ETS table if the key is not already present. @@ -700,7 +700,7 @@ Error: fun containing local Erlang function calls - + Check if an Erlang term is the result of match_spec_compile. @@ -732,7 +732,7 @@ ets:is_compiled_ms(Broken). - + Return the last key in an ETS table of type ordered_set. @@ -747,7 +747,7 @@ ets:is_compiled_ms(Broken). - + Return all objects with a specified key in an ETS table. @@ -787,7 +787,7 @@ ets:is_compiled_ms(Broken). - + Return the Pos:th element of all objects with a specified key in an ETS table. @@ -810,7 +810,7 @@ ets:is_compiled_ms(Broken). - + Continues matching objects in an ETS table.

Continues a match started with @@ -824,7 +824,7 @@ ets:is_compiled_ms(Broken). - + Match the objects in an ETS table against a pattern. @@ -856,7 +856,7 @@ ets:is_compiled_ms(Broken). - + Match the objects in an ETS table against a pattern and return part of the answers. @@ -875,7 +875,7 @@ ets:is_compiled_ms(Broken). - + Delete all objects that match a specified pattern from an ETS table. @@ -886,7 +886,7 @@ ets:is_compiled_ms(Broken). - + Continues matching objects in an ETS table.

Continues a match started with @@ -901,7 +901,7 @@ ets:is_compiled_ms(Broken). - + Match the objects in an ETS table against a pattern. @@ -920,7 +920,7 @@ ets:is_compiled_ms(Broken). - + Match the objects in an ETS table against a pattern and return part of the answers. @@ -940,7 +940,7 @@ ets:is_compiled_ms(Broken). - + Compile a match specification into its internal representation. @@ -968,7 +968,7 @@ ets:is_compiled_ms(Broken). - + Perform matching, using a compiled match specification on a list of terms. @@ -1005,7 +1005,7 @@ ets:select(Table, MatchSpec), - + Tests for occurrence of a key in an ETS table.

Works like lookup/2, @@ -1016,7 +1016,7 @@ ets:select(Table, MatchSpec), - + Create a new ETS table.

Creates a new table and returns a table identifier that can @@ -1180,7 +1180,7 @@ ets:select(Table, MatchSpec), - + Return the next key in an ETS table.

Returns the next key Key2, following key @@ -1202,7 +1202,7 @@ ets:select(Table, MatchSpec), - + Return the previous key in an ETS table of type ordered_set. @@ -1218,7 +1218,7 @@ ets:select(Table, MatchSpec), - + Rename a named ETS table.

Renames the named table Tab to the new name @@ -1228,7 +1228,7 @@ ets:select(Table, MatchSpec), - + Repair a continuation from ets:select/1 or ets:select/3 that has passed through external representation. @@ -1283,7 +1283,7 @@ ets:select(ets:repair_continuation(Broken,MS)). - + Fix an ETS table for safe traversal.

Fixes a table of type set, bag, or @@ -1339,7 +1339,7 @@ clean_all_with_value(Tab,X,Key) -> - + Continue matching objects in an ETS table.

Continues a match started with @@ -1353,7 +1353,7 @@ clean_all_with_value(Tab,X,Key) -> - + Match the objects in an ETS table against a match specification. @@ -1448,7 +1448,7 @@ is_integer(X), is_integer(Y), X + Y < 4711]]> - + Match the objects in an ETS table against a match specification and return part of the answers. @@ -1467,7 +1467,7 @@ is_integer(X), is_integer(Y), X + Y < 4711]]> - + Match the objects in an ETS table against a match specification and return the number of objects for which the match specification returned true. @@ -1486,7 +1486,7 @@ is_integer(X), is_integer(Y), X + Y < 4711]]> - + Match the objects in an ETS table against a match specification and delete objects where the match specification returns true. @@ -1612,7 +1612,7 @@ Success = (1 =:= ets:select_replace(T, [{Old, [], [{const, New}]}])), - + Set table options.

Sets table options. The only allowed option to be set after the @@ -1623,7 +1623,7 @@ Success = (1 =:= ets:select_replace(T, [{Old, [], [{const, New}]}])), - + Return all objects in a specified slot of an ETS table. @@ -1648,7 +1648,7 @@ Success = (1 =:= ets:select_replace(T, [{Old, [], [{const, New}]}])), - + Dump an ETS table to a file.

Dumps table Tab to file @@ -1659,7 +1659,7 @@ Success = (1 =:= ets:select_replace(T, [{Old, [], [{const, New}]}])), - + Dump an ETS table to a file.

Dumps table Tab to file @@ -1706,7 +1706,7 @@ Success = (1 =:= ets:select_replace(T, [{Old, [], [{const, New}]}])), - + Return a list of all objects in an ETS table.

Returns a list of all objects in table Tab.

@@ -1714,7 +1714,7 @@ Success = (1 =:= ets:select_replace(T, [{Old, [], [{const, New}]}])),
- + Return a list of all objects in an ETS table.

Returns information about the table dumped to file by @@ -1792,8 +1792,8 @@ Success = (1 =:= ets:select_replace(T, [{Old, [], [{const, New}]}])), - - + + Return a QLC query handle.

Returns a Query List @@ -1884,7 +1884,7 @@ true - + Test a match specification for use in select/2. @@ -1911,7 +1911,7 @@ true - + Fill a Dets table with objects from an ETS table. @@ -1922,11 +1922,11 @@ true - + - + - + Update a counter object in an ETS table. @@ -2006,8 +2006,8 @@ true - - + + Update the Pos:th element of the object with a specified key in an ETS table. diff --git a/lib/stdlib/doc/src/file_sorter.xml b/lib/stdlib/doc/src/file_sorter.xml index e988d58c2f..942d98fe61 100644 --- a/lib/stdlib/doc/src/file_sorter.xml +++ b/lib/stdlib/doc/src/file_sorter.xml @@ -32,7 +32,7 @@ PA1 file_sorter.xml - file_sorter + file_sorter File sorter.

This module contains functions for sorting terms on files, merging @@ -334,8 +334,8 @@ output(L) -> - - + + Check whether terms on files are sorted.

Checks files for sortedness. If a file is not sorted, the @@ -347,8 +347,8 @@ output(L) -> - - + + Check whether terms on files are sorted by key.

Checks files for sortedness. If a file is not sorted, the @@ -360,8 +360,8 @@ output(L) -> - - + + Merge terms on files by key.

Merges tuples on files. Each input file is assumed to be @@ -372,7 +372,7 @@ output(L) -> - + Sort terms on files by key.

Sorts tuples on files.

@@ -382,8 +382,8 @@ output(L) ->
- - + + Sort terms on files by key.

Sorts tuples on files. The sort is performed on the @@ -397,8 +397,8 @@ output(L) -> - - + + Merge terms on files.

Merges terms on files. Each input file is assumed to be @@ -409,7 +409,7 @@ output(L) -> - + Sort terms on files.

Sorts terms on files.

@@ -419,8 +419,8 @@ output(L) ->
- - + + Sort terms on files.

Sorts terms on files.

diff --git a/lib/stdlib/doc/src/filelib.xml b/lib/stdlib/doc/src/filelib.xml index 790f289ae5..5df415834f 100644 --- a/lib/stdlib/doc/src/filelib.xml +++ b/lib/stdlib/doc/src/filelib.xml @@ -32,7 +32,7 @@ A filelib.xml - filelib + filelib File utilities, such as wildcard matching of filenames. @@ -94,7 +94,7 @@ - + Ensure that all parent directories for a file or directory exist. @@ -108,7 +108,7 @@ - + Return the size in bytes of a file.

Returns the size of the specified file.

@@ -116,7 +116,7 @@
- + Fold over all files matching a regular expression.

Folds function Fun over all (regular) files @@ -142,7 +142,7 @@ - + Test whether Name refers to a directory.

Returns true if Name @@ -151,7 +151,7 @@ - + Test whether Name refers to a file or directory. @@ -161,7 +161,7 @@ - + Test whether Name refers to a (regular) file.

Returns true if Name @@ -170,7 +170,7 @@ - + Return the local date and time when a file was last modified. @@ -180,7 +180,7 @@ - + Match filenames using Unix-style wildcards.

Returns a list of all files that match Unix-style wildcard string @@ -252,7 +252,7 @@ filelib:wildcard("lib/**/*.{erl,hrl}") - + Match filenames using Unix-style wildcards starting at a specified directory. diff --git a/lib/stdlib/doc/src/filename.xml b/lib/stdlib/doc/src/filename.xml index e4cca2074a..ae42846c6b 100644 --- a/lib/stdlib/doc/src/filename.xml +++ b/lib/stdlib/doc/src/filename.xml @@ -28,7 +28,7 @@ 1997-11-13 B - filename + filename Filename manipulation functions.

This module provides functions @@ -87,7 +87,7 @@ - + Convert a filename to an absolute name, relative the working directory. @@ -119,7 +119,7 @@ - + Convert a filename to an absolute name, relative a specified directory. @@ -130,7 +130,7 @@ - + Join an absolute directory with a relative filename.

Joins an absolute directory with a relative filename. Similar to @@ -314,7 +314,7 @@ true - + Return the last component of a filename.

Returns the last component of Filename, or @@ -332,7 +332,7 @@ true - + Return the last component of a filename, stripped of the specified extension. @@ -357,7 +357,7 @@ true - + Return the directory part of a path name.

Returns the directory part of Filename.

@@ -374,7 +374,7 @@ true
- + Return the file extension.

Returns the file extension of Filename, @@ -390,8 +390,8 @@ true - - + + Find the filename and compiler options for a module.

Finds the source filename and compiler options for a module. @@ -438,7 +438,7 @@ true - + Convert a filename to a flat string.

Converts a possibly deep list filename consisting of @@ -448,7 +448,7 @@ true - + Join a list of filename components with directory separators. @@ -476,7 +476,7 @@ true - + Join two filename components with directory separators. @@ -487,7 +487,7 @@ true - + Return the native form of a file path.

Converts Path to a form accepted by the command @@ -506,7 +506,7 @@ true - + Return the path type.

Returns the path type, which is one of the following:

@@ -536,8 +536,8 @@ true
- - + + Remove a filename extension.

Removes a filename extension. rootname/2 works as @@ -584,7 +584,7 @@ unsafe - + Split a filename into its path components.

Returns a list whose elements are the path components of diff --git a/lib/stdlib/doc/src/gb_sets.xml b/lib/stdlib/doc/src/gb_sets.xml index 16db0906f5..a9596c6e4d 100644 --- a/lib/stdlib/doc/src/gb_sets.xml +++ b/lib/stdlib/doc/src/gb_sets.xml @@ -28,7 +28,7 @@ - gb_sets + gb_sets General balanced trees.

This module provides ordered sets using Prof. Arne Andersson's @@ -123,8 +123,8 @@ - - + + Add a (possibly existing) element to a set.

Returns a new set formed from Set1 with @@ -135,7 +135,7 @@ - + Rebalance tree representation of a set.

Rebalances the tree representation of Set1. @@ -149,7 +149,7 @@ - + Remove a (possibly non-existing) element from a set.

Returns a new set formed from Set1 with @@ -160,7 +160,7 @@ - + Remove an element from a set.

Returns a new set formed from Set1 with @@ -171,7 +171,7 @@ - + Remove a (possibly non-existing) element from a set.

Returns a new set formed from Set1 with @@ -182,7 +182,7 @@ - + Return the difference of two sets.

Returns only the elements of Set1 that are not @@ -191,7 +191,7 @@ - + Return an empty set.

Returns a new empty set.

@@ -199,7 +199,7 @@
- + Filter set elements.

Filters elements in Set1 using predicate function @@ -208,7 +208,7 @@ - + Fold over set elements.

Folds Function over every element in @@ -218,7 +218,7 @@ - + Convert a list into a set.

Returns a set of the elements in List, where @@ -227,7 +227,7 @@ - + Make a set from an ordset list.

Turns an ordered-set list List into a set. @@ -236,7 +236,7 @@ - + Add a new element to a set.

Returns a new set formed from Set1 with @@ -247,7 +247,7 @@ - + Return the intersection of a list of sets.

Returns the intersection of the non-empty list of sets.

@@ -255,7 +255,7 @@
- + Return the intersection of two sets.

Returns the intersection of Set1 and @@ -264,7 +264,7 @@ - + Check whether two sets are disjoint.

Returns true if Set1 and @@ -274,7 +274,7 @@ - + Test for membership of a set.

Returns true if Element is an element of @@ -283,7 +283,7 @@ - + Test for empty set.

Returns true if Set is an empty set, @@ -292,7 +292,7 @@ - + Test for membership of a set.

Returns true if Element is an element of @@ -301,7 +301,7 @@ - + Test for a set.

Returns true if Term appears to be a set, @@ -310,7 +310,7 @@ - + Test for subset.

Returns true when every element of Set1 is @@ -319,7 +319,7 @@ - + Return an iterator for a set.

Returns an iterator that can be used for traversing the entries of @@ -351,7 +351,7 @@ - + Return largest element.

Returns the largest element in Set. Assumes that @@ -360,7 +360,7 @@ - + Return an empty set.

Returns a new empty set.

@@ -368,7 +368,7 @@
- + Traverse a set with an iterator.

Returns {Element, Iter2}, where @@ -381,7 +381,7 @@ - + Return a set with one element.

Returns a set containing only element Element. @@ -390,7 +390,7 @@ - + Return the number of elements in a set.

Returns the number of elements in Set.

@@ -398,7 +398,7 @@
- + Return smallest element.

Returns the smallest element in Set. Assumes that @@ -407,7 +407,7 @@ - + Return the difference of two sets.

Returns only the elements of Set1 that are not @@ -416,7 +416,7 @@ - + Extract largest element.

Returns {Element, Set2}, where @@ -428,7 +428,7 @@ - + Extract smallest element.

Returns {Element, Set2}, where @@ -440,7 +440,7 @@ - + Convert a set into a list.

Returns the elements of Set as a list.

@@ -448,7 +448,7 @@
- + Return the union of a list of sets.

Returns the merged (union) set of the list of sets.

@@ -456,7 +456,7 @@
- + Return the union of two sets.

Returns the merged (union) set of Set1 and diff --git a/lib/stdlib/doc/src/gb_trees.xml b/lib/stdlib/doc/src/gb_trees.xml index 3b55c2c75d..570c9c7cb6 100644 --- a/lib/stdlib/doc/src/gb_trees.xml +++ b/lib/stdlib/doc/src/gb_trees.xml @@ -28,7 +28,7 @@ - gb_trees + gb_trees General balanced trees.

This module provides Prof. Arne Andersson's General @@ -75,7 +75,7 @@ - + Rebalance a tree.

Rebalances Tree1. Notice that this is @@ -88,7 +88,7 @@ - + Remove a node from a tree.

Removes the node with key Key from @@ -98,7 +98,7 @@ - + Remove a (possibly non-existing) node from a tree.

Removes the node with key Key from @@ -131,7 +131,7 @@ - + Return an empty tree.

Returns a new empty tree.

@@ -139,7 +139,7 @@
- + Insert or update key with value in a tree.

Inserts Key with value Value @@ -151,7 +151,7 @@ - + Make a tree from an orddict.

Turns an ordered list List of key-value tuples @@ -160,7 +160,7 @@ - + Look up a key in a tree, if present.

Retrieves the value stored with Key in @@ -171,7 +171,7 @@ - + Insert a new key and value in a tree.

Inserts Key with value Value @@ -182,7 +182,7 @@ - + Test for membership of a tree.

Returns true if Key is present in @@ -191,7 +191,7 @@ - + Test for empty tree.

Returns true if Tree is an empty tree, @@ -200,7 +200,7 @@ - + Return an iterator for a tree.

Returns an iterator that can be used for traversing the @@ -233,7 +233,7 @@ - + Return a list of the keys in a tree.

Returns the keys in Tree as an ordered list.

@@ -241,7 +241,7 @@
- + Return largest key and value.

Returns {Key, Value}, where @@ -253,7 +253,7 @@ - + Look up a key in a tree.

Looks up Key in Tree. @@ -263,7 +263,7 @@ - + Return largest key and value.

Maps function F(K, V1) -> V2 @@ -275,7 +275,7 @@ - + Traverse a tree with an iterator.

Returns {Key, Value, @@ -288,7 +288,7 @@ - + Return the number of nodes in a tree.

Returns the number of nodes in Tree.

@@ -296,7 +296,7 @@
- + Return smallest key and value.

Returns {Key, Value}, where @@ -308,7 +308,7 @@ - + Extract largest key and value.

Returns {Key, Value, @@ -321,7 +321,7 @@ - + Extract smallest key and value.

Returns {Key, Value, @@ -334,7 +334,7 @@ - + Convert a tree into a list.

Converts a tree into an ordered list of key-value tuples.

@@ -342,7 +342,7 @@
- + Update a key to new value in a tree.

Updates Key to value Value @@ -352,7 +352,7 @@ - + Return a list of the values in a tree.

Returns the values in Tree as an ordered list, diff --git a/lib/stdlib/doc/src/gen_event.xml b/lib/stdlib/doc/src/gen_event.xml index ff7da620c7..2915c4f507 100644 --- a/lib/stdlib/doc/src/gen_event.xml +++ b/lib/stdlib/doc/src/gen_event.xml @@ -28,7 +28,7 @@ - gen_event + gen_event Generic event handling behavior.

This behavior module provides event handling functionality. It @@ -130,7 +130,7 @@ gen_event:stop -----> Module:terminate/2 - add_handler(EventMgrRef, Handler, Args) -> Result + add_handler(EventMgrRef, Handler, Args) -> Result Add an event handler to a generic event manager. EventMgrRef = Name | {Name,Node} | {global,GlobalName} @@ -178,7 +178,7 @@ gen_event:stop -----> Module:terminate/2 - add_sup_handler(EventMgrRef, Handler, Args) -> Result + add_sup_handler(EventMgrRef, Handler, Args) -> Result Add a supervised event handler to a generic event manager. @@ -241,8 +241,8 @@ gen_event:stop -----> Module:terminate/2 - call(EventMgrRef, Handler, Request) -> Result - call(EventMgrRef, Handler, Request, Timeout) -> Result + call(EventMgrRef, Handler, Request) -> Result + call(EventMgrRef, Handler, Request, Timeout) -> Result Make a synchronous call to a generic event manager. EventMgrRef = Name | {Name,Node} | {global,GlobalName} @@ -285,7 +285,7 @@ gen_event:stop -----> Module:terminate/2 - delete_handler(EventMgrRef, Handler, Args) -> Result + delete_handler(EventMgrRef, Handler, Args) -> Result Delete an event handler from a generic event manager. EventMgrRef = Name | {Name,Node} | {global,GlobalName} @@ -318,8 +318,8 @@ gen_event:stop -----> Module:terminate/2 - notify(EventMgrRef, Event) -> ok - sync_notify(EventMgrRef, Event) -> ok + notify(EventMgrRef, Event) -> ok + sync_notify(EventMgrRef, Event) -> ok Notify an event manager about an event. EventMgrRef = Name | {Name,Node} | {global,GlobalName} @@ -349,8 +349,8 @@ gen_event:stop -----> Module:terminate/2 - start() -> Result - start(EventMgrName | Options) -> Result + start() -> Result + start(EventMgrName | Options) -> Result start(EventMgrName, Options) -> Result Create a stand-alone event manager process. @@ -375,8 +375,8 @@ gen_event:stop -----> Module:terminate/2 - start_link() -> Result - start_link(EventMgrName | Options) -> Result + start_link() -> Result + start_link(EventMgrName | Options) -> Result start_link(EventMgrName, Options) -> Result Create a generic event manager process in a supervision tree. @@ -436,7 +436,7 @@ gen_event:stop -----> Module:terminate/2 - stop(EventMgrRef) -> ok + stop(EventMgrRef) -> ok stop(EventMgrRef, Reason, Timeout) -> ok Terminate a generic event manager. @@ -474,7 +474,7 @@ gen_event:stop -----> Module:terminate/2 - swap_handler(EventMgrRef, {Handler1,Args1}, {Handler2,Args2}) -> Result + swap_handler(EventMgrRef, {Handler1,Args1}, {Handler2,Args2}) -> Result Replace an event handler in a generic event manager. EventMgrRef = Name | {Name,Node} | {global,GlobalName} @@ -521,7 +521,7 @@ gen_event:stop -----> Module:terminate/2 - swap_sup_handler(EventMgrRef, {Handler1,Args1}, {Handler2,Args2}) -> Result + swap_sup_handler(EventMgrRef, {Handler1,Args1}, {Handler2,Args2}) -> Result Replace an event handler in a generic event manager. EventMgrRef = Name | {Name,Node} | {global,GlobalName} @@ -546,7 +546,7 @@ gen_event:stop -----> Module:terminate/2 - which_handlers(EventMgrRef) -> [Handler] + which_handlers(EventMgrRef) -> [Handler] Return all event handlers installed in a generic event manager. @@ -575,7 +575,7 @@ gen_event:stop -----> Module:terminate/2 - Module:code_change(OldVsn, State, Extra) -> {ok, NewState} + Module:code_change(OldVsn, State, Extra) -> {ok, NewState} Update the internal state during upgrade/downgrade. OldVsn = Vsn | {down, Vsn} @@ -667,7 +667,7 @@ gen_event:stop -----> Module:terminate/2 - Module:handle_call(Request, State) -> Result + Module:handle_call(Request, State) -> Result Handle a synchronous request. Request = term() @@ -698,7 +698,7 @@ gen_event:stop -----> Module:terminate/2 - Module:handle_event(Event, State) -> Result + Module:handle_event(Event, State) -> Result Handle an event. Event = term() @@ -756,7 +756,7 @@ gen_event:stop -----> Module:terminate/2 - Module:handle_info(Info, State) -> Result + Module:handle_info(Info, State) -> Result Handle an incoming message. Info = term() @@ -788,7 +788,7 @@ gen_event:stop -----> Module:terminate/2 - Module:init(InitArgs) -> {ok,State} | {ok,State,hibernate} | {error,Reason} + Module:init(InitArgs) -> {ok,State} | {ok,State,hibernate} | {error,Reason} Initialize an event handler. InitArgs = Args | {Args,Term} @@ -825,7 +825,7 @@ gen_event:stop -----> Module:terminate/2 - Module:terminate(Arg, State) -> term() + Module:terminate(Arg, State) -> term() Clean up before deletion. Arg = Args | {stop,Reason} | stop | remove_handler diff --git a/lib/stdlib/doc/src/gen_server.xml b/lib/stdlib/doc/src/gen_server.xml index f3742fb8fb..a4554d7657 100644 --- a/lib/stdlib/doc/src/gen_server.xml +++ b/lib/stdlib/doc/src/gen_server.xml @@ -28,7 +28,7 @@ - gen_server + gen_server Generic server behavior.

This behavior module provides the server of a client-server @@ -101,8 +101,8 @@ gen_server:abcast -----> Module:handle_cast/2 - abcast(Name, Request) -> abcast - abcast(Nodes, Name, Request) -> abcast + abcast(Name, Request) -> abcast + abcast(Nodes, Name, Request) -> abcast Send an asynchronous request to many generic servers. Nodes = [Node] @@ -124,8 +124,8 @@ gen_server:abcast -----> Module:handle_cast/2 - call(ServerRef, Request) -> Reply - call(ServerRef, Request, Timeout) -> Reply + call(ServerRef, Request) -> Reply + call(ServerRef, Request, Timeout) -> Reply Make a synchronous call to a generic server. ServerRef = Name | {Name,Node} | {global,GlobalName} @@ -175,7 +175,7 @@ gen_server:abcast -----> Module:handle_cast/2 - cast(ServerRef, Request) -> ok + cast(ServerRef, Request) -> ok Send an asynchronous request to a generic server. ServerRef = Name | {Name,Node} | {global,GlobalName} @@ -200,10 +200,10 @@ gen_server:abcast -----> Module:handle_cast/2 - enter_loop(Module, Options, State) - enter_loop(Module, Options, State, ServerName) - enter_loop(Module, Options, State, Timeout) - enter_loop(Module, Options, State, ServerName, Timeout) + enter_loop(Module, Options, State) + enter_loop(Module, Options, State, ServerName) + enter_loop(Module, Options, State, Timeout) + enter_loop(Module, Options, State, ServerName, Timeout) Enter the gen_server receive loop. Module = atom() @@ -248,9 +248,9 @@ gen_server:abcast -----> Module:handle_cast/2 - multi_call(Name, Request) -> Result - multi_call(Nodes, Name, Request) -> Result - multi_call(Nodes, Name, Request, Timeout) -> Result + multi_call(Name, Request) -> Result + multi_call(Nodes, Name, Request) -> Result + multi_call(Nodes, Name, Request, Timeout) -> Result Make a synchronous call to many generic servers. Nodes = [Node] @@ -307,7 +307,7 @@ gen_server:abcast -----> Module:handle_cast/2 - reply(Client, Reply) -> Result + reply(Client, Reply) -> Result Send a reply to a client. Client - see below @@ -332,8 +332,8 @@ gen_server:abcast -----> Module:handle_cast/2 - start(Module, Args, Options) -> Result - start(ServerName, Module, Args, Options) -> Result + start(Module, Args, Options) -> Result + start(ServerName, Module, Args, Options) -> Result Create a standalone gen_server process. ServerName = {local,Name} | {global,GlobalName} @@ -361,8 +361,8 @@ gen_server:abcast -----> Module:handle_cast/2 - start_link(Module, Args, Options) -> Result - start_link(ServerName, Module, Args, Options) -> Result + start_link(Module, Args, Options) -> Result + start_link(ServerName, Module, Args, Options) -> Result Create a gen_server process in a supervision tree. @@ -508,7 +508,7 @@ gen_server:abcast -----> Module:handle_cast/2 - Module:code_change(OldVsn, State, Extra) -> {ok, NewState} | {error, Reason} + Module:code_change(OldVsn, State, Extra) -> {ok, NewState} | {error, Reason} Update the internal state during upgrade/downgrade. OldVsn = Vsn | {down, Vsn} @@ -610,7 +610,7 @@ gen_server:abcast -----> Module:handle_cast/2 - Module:handle_call(Request, From, State) -> Result + Module:handle_call(Request, From, State) -> Result Handle a synchronous request. Request = term() @@ -677,7 +677,7 @@ gen_server:abcast -----> Module:handle_cast/2 - Module:handle_cast(Request, State) -> Result + Module:handle_cast(Request, State) -> Result Handle an asynchronous request. Request = term() @@ -738,7 +738,7 @@ gen_server:abcast -----> Module:handle_cast/2 - Module:handle_info(Info, State) -> Result + Module:handle_info(Info, State) -> Result Handle an incoming message. Info = timeout | term() @@ -770,7 +770,7 @@ gen_server:abcast -----> Module:handle_cast/2 - Module:init(Args) -> Result + Module:init(Args) -> Result Initialize process and internal state. Args = term() @@ -811,7 +811,7 @@ gen_server:abcast -----> Module:handle_cast/2 - Module:terminate(Reason, State) + Module:terminate(Reason, State) Clean up before termination. Reason = normal | shutdown | {shutdown,term()} | term() diff --git a/lib/stdlib/doc/src/io.xml b/lib/stdlib/doc/src/io.xml index 943b3479ca..d69e808586 100644 --- a/lib/stdlib/doc/src/io.xml +++ b/lib/stdlib/doc/src/io.xml @@ -28,7 +28,7 @@ - io + io Standard I/O server interface functions.

This module provides an interface to standard Erlang I/O servers. @@ -104,8 +104,8 @@ - - + + Get the number of columns of an I/O device.

Retrieves the number of columns of the @@ -116,12 +116,12 @@ - - - - - - + + + + + + Write formatted output.

Writes the items in Data ([]) on the @@ -523,8 +523,8 @@ ok - - + + Read formatted input. @@ -690,8 +690,8 @@ enter>: alan : joe - - + + Read a specified number of characters. @@ -722,8 +722,8 @@ enter>: alan : joe - - + + Read a line. @@ -754,8 +754,8 @@ enter>: alan : joe - - + + Get the supported options and values from an I/O server. @@ -781,8 +781,8 @@ enter>: alan : joe - - + + Write a newline.

Writes new line to the standard output @@ -791,9 +791,9 @@ enter>: alan : joe - - - + + + Read, tokenize, and parse Erlang expressions. @@ -844,9 +844,9 @@ enter>abc("hey". - - - + + + Read, tokenize, and parse an Erlang form. @@ -918,8 +918,8 @@ enter>abc("hey". - - + + Write a list of characters.

Writes the characters of CharData to the I/O @@ -928,8 +928,8 @@ enter>abc("hey". - - + + Read a term. @@ -960,7 +960,7 @@ enter>abc("hey". - + Read a term. @@ -997,8 +997,8 @@ enter>abc("hey". - - + + Get the number of rows of an I/O device.

Retrieves the number of rows of IoDevice @@ -1009,9 +1009,9 @@ enter>abc("hey". - - - + + + Read and tokenize Erlang expressions. @@ -1060,9 +1060,9 @@ enter>1.0er. - - - + + + Read and tokenize an Erlang form. @@ -1083,8 +1083,8 @@ enter>1.0er. - - + + Set options.

Set options for the standard I/O device @@ -1198,8 +1198,8 @@ fun("") -> {yes, "quit", []}; - - + + Write a term.

Writes term Term to the standard output diff --git a/lib/stdlib/doc/src/io_lib.xml b/lib/stdlib/doc/src/io_lib.xml index 8a0b674126..cd4ca0a3a7 100644 --- a/lib/stdlib/doc/src/io_lib.xml +++ b/lib/stdlib/doc/src/io_lib.xml @@ -28,7 +28,7 @@ - io_lib + io_lib I/O library functions.

This module contains functions for converting to and from @@ -108,7 +108,7 @@ - + Test for a list of characters.

Returns true if Term is a flat list of @@ -117,7 +117,7 @@ - + Test for a deep list of characters.

Returns true if Term is a, possibly deep, @@ -136,8 +136,8 @@ - - + + Write formatted output.

Returns a character list that represents Data @@ -181,7 +181,7 @@ - + Read formatted input.

Tries to read String in accordance with the @@ -222,7 +222,7 @@ - + Re-entrant formatted reader

This is the re-entrant formatted reader. The continuation of @@ -268,7 +268,7 @@ - + Indentation after printing string.

Returns the indentation if String has been @@ -286,7 +286,7 @@ - + Write a newline.

Returns a character list that represents a new line character.

@@ -294,8 +294,8 @@
- - + + Pretty print a term.

Returns a list of characters that represents @@ -324,7 +324,7 @@ - + Test for a list of printable characters.

Returns true if Term is a flat list of @@ -383,9 +383,9 @@ - - - + + + Write a term.

Returns a character list that represents Term. @@ -411,7 +411,7 @@ - + Write an atom.

Returns the list of characters needed to print atom @@ -430,7 +430,7 @@ - + Write a character.

Returns the list of characters needed to print a character @@ -467,7 +467,7 @@ - + Write a string.

Returns the list of characters needed to print diff --git a/lib/stdlib/doc/src/lists.xml b/lib/stdlib/doc/src/lists.xml index f126326b09..66146e9258 100644 --- a/lib/stdlib/doc/src/lists.xml +++ b/lib/stdlib/doc/src/lists.xml @@ -28,7 +28,7 @@ 1996-09-28 A - lists + lists List processing functions.

This module contains functions for list processing.

@@ -63,7 +63,7 @@ - + Return true if all elements in a list satisfy Pred. @@ -74,7 +74,7 @@ - + Return true if any of the elements in a list satisfies Pred. @@ -85,7 +85,7 @@ - + Append a list of lists.

Returns a list in which all the sublists of @@ -98,7 +98,7 @@ - + Append two lists.

Returns a new list List3, which is made from @@ -113,7 +113,7 @@ - + Concatenate a list of atoms.

Concatenates the text representation of the elements of @@ -127,7 +127,7 @@ - + Delete an element from a list.

Returns a copy of List1 where the first element @@ -147,7 +147,7 @@ - + Drop elements from a list while a predicate is true. @@ -159,7 +159,7 @@ - + Make N copies of element.

Returns a list containing N copies of term @@ -172,7 +172,7 @@ - + Select elements that satisfy a predicate.

List2 is a list of all elements @@ -211,7 +211,7 @@ filtermap(Fun, List1) -> - + Length of flattened deep list.

Equivalent to length(flatten(DeepList)), but @@ -220,7 +220,7 @@ filtermap(Fun, List1) -> - + Map and flatten in one pass.

Takes a function from As to lists of @@ -241,7 +241,7 @@ flatmap(Fun, List1) -> - + Flatten a deep list.

Returns a flattened version of DeepList.

@@ -249,7 +249,7 @@ flatmap(Fun, List1) ->
- + Flatten a deep list.

Returns a flattened version of DeepList with tail @@ -258,7 +258,7 @@ flatmap(Fun, List1) -> - + Fold a function over a list.

Calls Fun(Elem, AccIn) @@ -278,7 +278,7 @@ flatmap(Fun, List1) -> - + Fold a function over a list.

Like foldl/3, but the @@ -312,7 +312,7 @@ flatmap(Fun, List1) -> - + Apply a function to each element of a list.

Calls Fun(Elem) for each element @@ -324,7 +324,7 @@ flatmap(Fun, List1) -> - + Delete an element from a list of tuples. 1..tuple_size(Tuple) @@ -336,7 +336,7 @@ flatmap(Fun, List1) -> - + Search for an element in a list of tuples. 1..tuple_size(Tuple) @@ -349,7 +349,7 @@ flatmap(Fun, List1) -> - + Map a function over a list of tuples. 1..tuple_size(Tuple) @@ -368,7 +368,7 @@ flatmap(Fun, List1) -> - + Test for membership of a list of tuples. 1..tuple_size(Tuple) @@ -379,7 +379,7 @@ flatmap(Fun, List1) -> - + Merge two key-sorted lists of tuples. 1..tuple_size(Tuple) @@ -395,7 +395,7 @@ flatmap(Fun, List1) -> - + Replace an element in a list of tuples. 1..tuple_size(Tuple) @@ -407,7 +407,7 @@ flatmap(Fun, List1) -> - + Search for an element in a list of tuples. 1..tuple_size(Tuple) @@ -425,7 +425,7 @@ flatmap(Fun, List1) -> - + Sort a list of tuples. 1..tuple_size(Tuple) @@ -436,7 +436,7 @@ flatmap(Fun, List1) -> - + Store an element in a list of tuples. 1..tuple_size(Tuple) @@ -452,7 +452,7 @@ flatmap(Fun, List1) -> - + Extract an element from a list of tuples. 1..tuple_size(Tuple) @@ -467,7 +467,7 @@ flatmap(Fun, List1) -> - + Return last element in a list.

Returns the last element in List.

@@ -475,7 +475,7 @@ flatmap(Fun, List1) ->
- + Map a function over a list.

Takes a function from As to @@ -488,7 +488,7 @@ flatmap(Fun, List1) -> - + Map and fold in one pass.

Combines the operations of @@ -504,7 +504,7 @@ flatmap(Fun, List1) -> - + Map and fold in one pass.

Combines the operations of @@ -514,7 +514,7 @@ flatmap(Fun, List1) -> - + Return maximum element of a list.

Returns the first element of List that compares @@ -524,7 +524,7 @@ flatmap(Fun, List1) -> - + Test for membership of a list.

Returns true if Elem matches some element @@ -533,7 +533,7 @@ flatmap(Fun, List1) -> - + Merge a list of sorted lists.

Returns the sorted list formed by merging all the sublists of @@ -546,7 +546,7 @@ flatmap(Fun, List1) -> - + Merge two sorted lists.

Returns the sorted list formed by merging List1 @@ -559,7 +559,7 @@ flatmap(Fun, List1) -> - + Merge two sorted list.

Returns the sorted list formed by merging List1 @@ -577,7 +577,7 @@ flatmap(Fun, List1) -> - + Merge three sorted lists.

Returns the sorted list formed by merging List1, @@ -593,7 +593,7 @@ flatmap(Fun, List1) -> - + Return minimum element of a list.

Returns the first element of List that compares @@ -603,7 +603,7 @@ flatmap(Fun, List1) -> - + Return the Nth element of a list. 1..length(List) @@ -617,7 +617,7 @@ c - + Return the Nth tail of a list. 0..length(List) @@ -638,7 +638,7 @@ c - + Partition a list into two lists based on a predicate.

Partitions List into two lists, where the first @@ -658,7 +658,7 @@ c - + Test for list prefix.

Returns true if List1 is a prefix of @@ -667,7 +667,7 @@ c - + Reverse a list.

Returns a list with the elements in List1 @@ -676,7 +676,7 @@ c - + Reverse a list appending a tail.

Returns a list with the elements in List1 @@ -689,8 +689,8 @@ c - - + + Generate a sequence of integers.

Returns a sequence of integers that starts with @@ -736,7 +736,7 @@ length(lists:seq(From, To, Incr)) =:= (To - From + Incr) div Incr - + Sort a list.

Returns a list containing the sorted elements of @@ -745,7 +745,7 @@ length(lists:seq(From, To, Incr)) =:= (To - From + Incr) div Incr - + Sort a list.

Returns a list containing the sorted elements of @@ -759,7 +759,7 @@ length(lists:seq(From, To, Incr)) =:= (To - From + Incr) div Incr - + Split a list into two lists. 0..length(List1) @@ -783,7 +783,7 @@ length(lists:seq(From, To, Incr)) =:= (To - From + Incr) div Incr - + Split a list into two lists based on a predicate.

Partitions List into two lists according to @@ -804,7 +804,7 @@ splitwith(Pred, List) -> - + Return a sublist of a certain length, starting at the first position. @@ -816,7 +816,7 @@ splitwith(Pred, List) -> - + Return a sublist starting at a specified position and with a specified number of elements. 1..(length(List1)+1) @@ -838,7 +838,7 @@ splitwith(Pred, List) -> - + Subtract the element in one list from another list.

Returns a new list List3 that is a copy of @@ -854,7 +854,7 @@ splitwith(Pred, List) -> - + Test for list suffix.

Returns true if List1 is a suffix of @@ -863,7 +863,7 @@ splitwith(Pred, List) -> - + Return the sum of elements in a list.

Returns the sum of the elements in List.

@@ -871,7 +871,7 @@ splitwith(Pred, List) ->
- + Take elements from a list while a predicate is true. @@ -884,7 +884,7 @@ splitwith(Pred, List) -> - + Merge two key-sorted lists of tuples, removing duplicates. 1..tuple_size(Tuple) @@ -902,7 +902,7 @@ splitwith(Pred, List) -> - + Sort a list of tuples, removing duplicates. 1..tuple_size(Tuple) @@ -914,7 +914,7 @@ splitwith(Pred, List) -> - + Merge a list of sorted lists, removing duplicates.

Returns the sorted list formed by merging all the sublists @@ -927,7 +927,7 @@ splitwith(Pred, List) -> - + Merge two sorted lists, removing duplicates.

Returns the sorted list formed by merging List1 @@ -941,7 +941,7 @@ splitwith(Pred, List) -> - + Merge two sorted lists, removing duplicates.

Returns the sorted list formed by merging List1 @@ -958,7 +958,7 @@ splitwith(Pred, List) -> - + Merge three sorted lists, removing duplicates.

Returns the sorted list formed by merging List1, @@ -973,7 +973,7 @@ splitwith(Pred, List) -> - + Unzip a list of two-tuples into two lists.

"Unzips" a list of two-tuples into two lists, where the first @@ -983,7 +983,7 @@ splitwith(Pred, List) -> - + Unzip a list of three-tuples into three lists.

"Unzips" a list of three-tuples into three lists, where @@ -994,7 +994,7 @@ splitwith(Pred, List) -> - + Sort a list, removing duplicates.

Returns a list containing the sorted elements of @@ -1004,7 +1004,7 @@ splitwith(Pred, List) -> - + Sort a list, removing duplicates.

Returns a list containing the sorted elements of @@ -1019,7 +1019,7 @@ splitwith(Pred, List) -> - + Zip two lists into a list of two-tuples.

"Zips" two lists of equal length into one list of two-tuples, @@ -1030,7 +1030,7 @@ splitwith(Pred, List) -> - + Zip three lists into a list of three-tuples.

"Zips" three lists of equal length into one list of @@ -1042,7 +1042,7 @@ splitwith(Pred, List) -> - + Zip two lists into one list according to a fun.

Combines the elements of two lists of equal length into one list. @@ -1059,7 +1059,7 @@ splitwith(Pred, List) -> - + Zip three lists into one list according to a fun.

Combines the elements of three lists of equal length into one diff --git a/lib/stdlib/doc/src/log_mf_h.xml b/lib/stdlib/doc/src/log_mf_h.xml index edc3d31025..b922006cc0 100644 --- a/lib/stdlib/doc/src/log_mf_h.xml +++ b/lib/stdlib/doc/src/log_mf_h.xml @@ -34,7 +34,7 @@ A log_mf_h.xml - log_mf_h + log_mf_h An event handler that logs events to disk.

This module is a gen_event handler module that can be installed @@ -60,8 +60,8 @@ - - + + Initiate the event handler.

Initiates the event handler. Returns Args, which diff --git a/lib/stdlib/doc/src/math.xml b/lib/stdlib/doc/src/math.xml index 0672da88b9..d89310e2c8 100644 --- a/lib/stdlib/doc/src/math.xml +++ b/lib/stdlib/doc/src/math.xml @@ -34,7 +34,7 @@ B math.xml - math + math Mathematical functions.

This module provides an interface to a number of mathematical @@ -50,28 +50,28 @@ - - - - - - - + + + + + + + - - - + + + - - + + - - - - - - + + + + + + Diverse math functions. @@ -82,7 +82,7 @@ - + Error function.

Returns the error function of X, where:

@@ -92,7 +92,7 @@ erf(X) = 2/sqrt(pi)*integral from 0 to X of exp(-t*t) dt.
- + Another error function.

erfc(X) returns 1.0 - erf(X), computed by @@ -101,7 +101,7 @@ erf(X) = 2/sqrt(pi)*integral from 0 to X of exp(-t*t) dt. - + A useful number.

A useful number.

diff --git a/lib/stdlib/doc/src/ms_transform.xml b/lib/stdlib/doc/src/ms_transform.xml index 0a05fa37c5..65cc150507 100644 --- a/lib/stdlib/doc/src/ms_transform.xml +++ b/lib/stdlib/doc/src/ms_transform.xml @@ -32,7 +32,7 @@ C ms_transform.xml - ms_transform + ms_transform A parse transformation that translates fun syntax into match specifications. @@ -731,7 +731,7 @@ ets:select(Table, [{{'$1',test,'$2'},[],['$_']}]). - + Error formatting function as required by the parse transformation interface.

Takes an error code returned by one of the other functions @@ -741,7 +741,7 @@ ets:select(Table, [{{'$1',test,'$2'},[],['$_']}]). - + Transforms Erlang abstract format containing calls to ets/dbg:fun2ms/1 into literal match specifications. Option list, required but not used. @@ -762,7 +762,7 @@ ets:select(Table, [{{'$1',test,'$2'},[],['$_']}]). - + Used when transforming funs created in the shell into match_specifications. List of variable bindings in the diff --git a/lib/stdlib/doc/src/orddict.xml b/lib/stdlib/doc/src/orddict.xml index e4dae4104d..27ccccee7e 100644 --- a/lib/stdlib/doc/src/orddict.xml +++ b/lib/stdlib/doc/src/orddict.xml @@ -32,7 +32,7 @@ B orddict.xml - orddict + orddict Key-value dictionary as ordered list.

This module provides a Key-Value dictionary. @@ -61,7 +61,7 @@ - + Append a value to keys in a dictionary.

Appends a new Value to the current list @@ -73,7 +73,7 @@ - + Append new values to keys in a dictionary.

Appends a list of values ValList to @@ -85,7 +85,7 @@ - + Erase a key from a dictionary.

Erases all items with a specified key from a dictionary.

@@ -93,7 +93,7 @@
- + Look up values in a dictionary.

Returns the value associated with Key @@ -105,7 +105,7 @@ - + Return all keys in a dictionary.

Returns a list of all keys in a dictionary.

@@ -122,7 +122,7 @@
- + Select elements that satisfy a predicate.

Orddict2 is a dictionary of all keys and values @@ -133,7 +133,7 @@ - + Search for a key in a dictionary.

Searches for a key in a dictionary. Returns @@ -145,7 +145,7 @@ - + Fold a function over a dictionary.

Calls Fun on successive keys and values of @@ -157,7 +157,7 @@ - + Convert a list of pairs to a dictionary.

Converts the Key-Value list @@ -175,7 +175,7 @@ - + Test if a key is in a dictionary.

Tests if Key is contained in @@ -184,7 +184,7 @@ - + Map a function over a dictionary.

Calls Fun on successive keys and values of @@ -193,7 +193,7 @@ - + Merge two dictionaries.

Merges two dictionaries, Orddict1 and @@ -212,7 +212,7 @@ merge(Fun, D1, D2) -> - + Create a dictionary.

Creates a new dictionary.

@@ -220,7 +220,7 @@ merge(Fun, D1, D2) ->
- + Return the number of elements in an ordered dictionary. @@ -229,7 +229,7 @@ merge(Fun, D1, D2) -> - + Store a value in a dictionary.

Stores a Key-Value pair in a @@ -240,7 +240,7 @@ merge(Fun, D1, D2) -> - + Convert a dictionary to a list of pairs.

Converts a dictionary to a list representation.

@@ -248,7 +248,7 @@ merge(Fun, D1, D2) ->
- + Update a value in a dictionary.

Updates a value in a dictionary by calling Fun @@ -258,7 +258,7 @@ merge(Fun, D1, D2) -> - + Update a value in a dictionary.

Updates a value in a dictionary by calling Fun @@ -273,7 +273,7 @@ append(Key, Val, D) -> - + Increment a value in a dictionary.

Adds Increment to the value associated with diff --git a/lib/stdlib/doc/src/ordsets.xml b/lib/stdlib/doc/src/ordsets.xml index d1e24facef..fbe334c009 100644 --- a/lib/stdlib/doc/src/ordsets.xml +++ b/lib/stdlib/doc/src/ordsets.xml @@ -32,7 +32,7 @@ A ordsets.xml - ordsets + ordsets Functions for manipulating sets as ordered lists. @@ -60,7 +60,7 @@ - + Add an element to an Ordset.

Returns a new ordered set formed from Ordset1 @@ -69,7 +69,7 @@ - + Remove an element from an Ordset.

Returns Ordset1, but with @@ -78,7 +78,7 @@ - + Filter set elements.

Filters elements in Ordset1 with boolean function @@ -87,7 +87,7 @@ - + Fold over set elements.

Folds Function over every element in @@ -97,7 +97,7 @@ - + Convert a list into an Ordset.

Returns an ordered set of the elements in List. @@ -106,7 +106,7 @@ - + Return the intersection of a list of Ordsets

Returns the intersection of the non-empty list of sets.

@@ -114,7 +114,7 @@
- + Return the intersection of two Ordsets.

Returns the intersection of Ordset1 and @@ -123,7 +123,7 @@ - + Check whether two Ordsets are disjoint.

Returns true if Ordset1 and @@ -133,7 +133,7 @@ - + Test for membership of an Ordset.

Returns true if Element is an element of @@ -151,7 +151,7 @@ - + Test for an Ordset.

Returns true if Ordset is an ordered set @@ -160,7 +160,7 @@ - + Test for subset.

Returns true when every element of Ordset1 @@ -170,7 +170,7 @@ - + Return an empty set.

Returns a new empty ordered set.

@@ -178,7 +178,7 @@
- + Return the number of elements in a set.

Returns the number of elements in Ordset.

@@ -186,7 +186,7 @@
- + Return the difference of two Ordsets.

Returns only the elements of Ordset1 that are not @@ -195,7 +195,7 @@ - + Convert an Ordset into a list.

Returns the elements of Ordset as a list.

@@ -203,7 +203,7 @@
- + Return the union of a list of Ordsets.

Returns the merged (union) set of the list of sets.

@@ -211,7 +211,7 @@
- + Return the union of two Ordsets.

Returns the merged (union) set of Ordset1 and diff --git a/lib/stdlib/doc/src/pool.xml b/lib/stdlib/doc/src/pool.xml index 05d12ade28..675ee08bfb 100644 --- a/lib/stdlib/doc/src/pool.xml +++ b/lib/stdlib/doc/src/pool.xml @@ -28,7 +28,7 @@ - pool + pool Load distribution facility.

This module can be used to run a set of Erlang nodes as a pool @@ -54,7 +54,7 @@ - + Ensure that a pool master is running.

Ensures that a pool master is running and includes @@ -63,7 +63,7 @@ - + Return the node with the expected lowest future load.

Returns the node with the expected lowest future load.

@@ -71,7 +71,7 @@
- + Return a list of the current member nodes of the pool. @@ -80,7 +80,7 @@ - + Spawn a process on the pool node with expected lowest future load. @@ -90,7 +90,7 @@ - + Spawn and link to a process on the pool node with expected lowest future load. @@ -100,8 +100,8 @@ - - + + >Start a new pool.

Starts a new pool. The file .hosts.erlang is read to @@ -122,7 +122,7 @@ - + Stop the pool and kill all the slave nodes.

Stops the pool and kills all the slave nodes.

diff --git a/lib/stdlib/doc/src/proc_lib.xml b/lib/stdlib/doc/src/proc_lib.xml index 8e7308ca74..aeb9f48735 100644 --- a/lib/stdlib/doc/src/proc_lib.xml +++ b/lib/stdlib/doc/src/proc_lib.xml @@ -28,7 +28,7 @@ - proc_lib + proc_lib Functions for asynchronous and synchronous start of processes adhering to the OTP design principles. @@ -102,7 +102,7 @@ - + Format a crash report.

Equivalent to @@ -162,7 +162,7 @@ - + Hibernate a process until a message is sent to it.

This function does the same as (and does call) the @@ -176,8 +176,8 @@ - - + + Used by a process when it has started.

This function must be used by a process that has been started by @@ -214,7 +214,7 @@ init(Parent) -> - + Extract the initial call of a proc_libspawned process. @@ -244,10 +244,10 @@ init(Parent) -> - - - - + + + + Spawn a new process. @@ -262,10 +262,10 @@ init(Parent) -> - - - - + + + + Spawn and link to a new process. @@ -281,10 +281,10 @@ init(Parent) -> - - - - + + + + Spawn a new process with specified options. @@ -306,12 +306,12 @@ init(Parent) -> - - - - - - + + + + + + Start a new process synchronously.

Starts a new process synchronously. Spawns the process and @@ -375,7 +375,7 @@ init(Parent) -> - + Extract and translate the initial call of a proc_libspawned process. diff --git a/lib/stdlib/doc/src/proplists.xml b/lib/stdlib/doc/src/proplists.xml index f9a54bf804..9d7eb55a7e 100644 --- a/lib/stdlib/doc/src/proplists.xml +++ b/lib/stdlib/doc/src/proplists.xml @@ -32,7 +32,7 @@ A proplists.xml - proplists + proplists Support functions for property lists.

Property lists are ordinary lists containing entries in the form @@ -61,7 +61,7 @@ - +

Similar to @@ -79,7 +79,7 @@ append_values(a, [{a, [1,2]}, {b, 0}, {a, 3}, {c, -1}, {a, [4]}]) - +

Minimizes the representation of all entries in the list. This is @@ -91,7 +91,7 @@ append_values(a, [{a, [1,2]}, {b, 0}, {a, 3}, {c, -1}, {a, [4]}]) - +

Deletes all entries associated with Key from @@ -100,7 +100,7 @@ append_values(a, [{a, [1,2]}, {b, 0}, {a, 3}, {c, -1}, {a, [4]}]) - +

Expands particular properties to corresponding sets of @@ -133,7 +133,7 @@ expand([{{foo, true}, [bar, baz]}], [{foo, false}, fie, foo, fum]) - +

Similar to @@ -145,7 +145,7 @@ expand([{{foo, true}, [bar, baz]}], [{foo, false}, fie, foo, fum]) - +

Returns the value of a boolean key/value option. If @@ -159,7 +159,7 @@ expand([{{foo, true}, [bar, baz]}], [{foo, false}, fie, foo, fum]) - +

Returns an unordered list of the keys used in @@ -168,7 +168,7 @@ expand([{{foo, true}, [bar, baz]}], [{foo, false}, fie, foo, fum]) - +

Equivalent to @@ -177,7 +177,7 @@ expand([{{foo, true}, [bar, baz]}], [{foo, false}, fie, foo, fum]) - +

Returns the value of a simple key/value property in @@ -194,7 +194,7 @@ expand([{{foo, true}, [bar, baz]}], [{foo, false}, fie, foo, fum]) - +

Returns true if List contains at least @@ -204,7 +204,7 @@ expand([{{foo, true}, [bar, baz]}], [{foo, false}, fie, foo, fum]) - +

Returns the first entry associated with Key in @@ -219,7 +219,7 @@ expand([{{foo, true}, [bar, baz]}], [{foo, false}, fie, foo, fum]) - +

Returns the list of all entries associated with @@ -231,7 +231,7 @@ expand([{{foo, true}, [bar, baz]}], [{foo, false}, fie, foo, fum]) - +

Passes ListIn through a sequence of @@ -263,7 +263,7 @@ expand([{{foo, true}, [bar, baz]}], [{foo, false}, fie, foo, fum]) - +

Creates a normal form (minimal) representation of a property. If @@ -276,7 +276,7 @@ expand([{{foo, true}, [bar, baz]}], [{foo, false}, fie, foo, fum]) - +

Creates a normal form (minimal) representation of a simple key/value @@ -289,7 +289,7 @@ expand([{{foo, true}, [bar, baz]}], [{foo, false}, fie, foo, fum]) - +

Partitions List into a list of sublists and a @@ -310,7 +310,7 @@ split([{c, 2}, {e, 1}, a, {c, 3, 4}, d, {b, 5}, b], [a, b, c]) - +

Substitutes keys of properties. For each entry in @@ -332,7 +332,7 @@ split([{c, 2}, {e, 1}, a, {c, 3, 4}, d, {b, 5}, b], [a, b, c]) - +

Substitutes keys of boolean-valued properties and @@ -360,7 +360,7 @@ split([{c, 2}, {e, 1}, a, {c, 3, 4}, d, {b, 5}, b], [a, b, c]) - +

Unfolds all occurrences of atoms in ListIn to diff --git a/lib/stdlib/doc/src/qlc.xml b/lib/stdlib/doc/src/qlc.xml index fe14a6334c..fe60c2e9bb 100644 --- a/lib/stdlib/doc/src/qlc.xml +++ b/lib/stdlib/doc/src/qlc.xml @@ -32,7 +32,7 @@ PA1 qlc.xml - qlc + qlc Query interface to Mnesia, ETS, Dets, and so on. @@ -720,7 +720,7 @@ ets:match_spec_run(ets:lookup(86033, {2,2}), - + Return a query handle.

Returns a query handle. When evaluating query handle @@ -731,7 +731,7 @@ ets:match_spec_run(ets:lookup(86033, {2,2}), - + Return a query handle.

Returns a query handle. When evaluating query handle @@ -744,8 +744,8 @@ ets:match_spec_run(ets:lookup(86033, {2,2}), - - + + Create a query cursor.

Creates a query cursor and @@ -777,7 +777,7 @@ ok - + Delete a query cursor.

Deletes a query cursor. Only the owner of the cursor can @@ -786,10 +786,10 @@ ok - - - - + + + + Return all answers to a query.

Evaluates a query handle in the @@ -805,8 +805,8 @@ ok - - + + Fold a function over the answers to a query.

Calls Function on successive answers to @@ -830,7 +830,7 @@ ok - + Return an English description of a an error tuple.

Returns a descriptive string in English of an error tuple @@ -841,8 +841,8 @@ ok - - + + Return code describing a query handle.

Returns information about a @@ -946,8 +946,8 @@ end - - + + Return a query handle.

Returns a query handle. When evaluating query handle @@ -967,8 +967,8 @@ end - - + + Return some or all answers to a query.

Returns some or all of the remaining answers to a query @@ -983,8 +983,8 @@ end - - + + Return a handle for a query list comprehension.

Returns a query handle for a QLC. @@ -1188,8 +1188,8 @@ ets:match_spec_run( - - + + Return a query handle.

Returns a query handle. When evaluating query handle @@ -1208,9 +1208,9 @@ ets:match_spec_run( - - - + + + Return a handle for a query list comprehension.

A string version of q/1,2. @@ -1238,7 +1238,7 @@ ets:match_spec_run( - + Return a query handle for a table.

Returns a query handle for a QLC table. diff --git a/lib/stdlib/doc/src/queue.xml b/lib/stdlib/doc/src/queue.xml index 9f3aff03a3..83a8afea81 100644 --- a/lib/stdlib/doc/src/queue.xml +++ b/lib/stdlib/doc/src/queue.xml @@ -32,7 +32,7 @@ B queue.xml - queue + queue Abstract data type for FIFO queues.

This module provides (double-ended) FIFO queues @@ -113,7 +113,7 @@ - + Filter a queue.

Returns a queue Q2 that is the result of calling @@ -134,7 +134,7 @@ - + Convert a list to a queue.

Returns a queue containing the items in L in the @@ -144,7 +144,7 @@ - + Insert an item at the rear of a queue.

Inserts Item at the rear of queue @@ -154,7 +154,7 @@ - + Insert an item at the front of a queue.

Inserts Item at the front of queue @@ -164,7 +164,7 @@ - + Test if a queue is empty.

Tests if Q is empty and returns true if @@ -173,7 +173,7 @@ - + Test if a term is a queue.

Tests if Term is a queue and returns true @@ -182,7 +182,7 @@ - + Join two queues.

Returns a queue Q3 that is the result of joining @@ -192,7 +192,7 @@ - + Get the length of a queue.

Calculates and returns the length of queue Q.

@@ -200,7 +200,7 @@
- + Test if an item is in a queue.

Returns true if Item matches some element @@ -209,7 +209,7 @@ - + Create an empty queue.

Returns an empty queue.

@@ -217,7 +217,7 @@
- + Remove the front item from a queue.

Removes the item at the front of queue Q1. @@ -230,7 +230,7 @@ - + Remove the rear item from a queue.

Removes the item at the rear of queue Q1. @@ -242,7 +242,7 @@ - + Reverse a queue.

Returns a queue Q2 containing the items of @@ -251,7 +251,7 @@ - + Split a queue in two.

Splits Q1 in two. The N @@ -261,7 +261,7 @@ - + Convert a queue to a list.

Returns a list of the items in the queue in the same order; @@ -276,7 +276,7 @@ - + Remove the front item from a queue.

Returns a queue Q2 that is the result of removing @@ -286,7 +286,7 @@ - + Remove the rear item from a queue.

Returns a queue Q2 that is the result of removing @@ -296,7 +296,7 @@ - + Return the front item of a queue.

Returns Item at the front of queue @@ -306,7 +306,7 @@ - + Return the rear item of a queue.

Returns Item at the rear of queue @@ -316,7 +316,7 @@ - + Return the front item of a queue.

Returns tuple {value, Item}, where @@ -326,7 +326,7 @@ - + Return the rear item of a queue.

Returns tuple {value, Item}, where @@ -342,7 +342,7 @@ - + Insert an item at the head of a queue.

Inserts Item at the head of queue @@ -352,7 +352,7 @@ - + Return the tail item of a queue.

Returns the tail item of queue Q.

@@ -361,7 +361,7 @@
- + Return the item at the head of a queue.

Returns Item from the head of queue @@ -371,7 +371,7 @@ - + Remove the tail item from a queue.

Returns a queue Q2 that is the result of removing @@ -381,7 +381,7 @@ - + Remove the tail item from a queue.

Returns a queue Q2 that is the result of removing @@ -392,7 +392,7 @@ - + Return the tail item of a queue.

Returns the tail item of queue Q.

@@ -401,7 +401,7 @@
- + Remove the tail item from a queue.

Returns a queue Q2 that is the result of removing @@ -411,7 +411,7 @@ - + Insert an item at the tail of a queue.

Inserts Item as the tail item of queue @@ -421,7 +421,7 @@ - + Remove the head item from a queue.

Returns a queue Q2 that is the result of removing diff --git a/lib/stdlib/doc/src/random.xml b/lib/stdlib/doc/src/random.xml index 8d090d20b3..f0261ed009 100644 --- a/lib/stdlib/doc/src/random.xml +++ b/lib/stdlib/doc/src/random.xml @@ -32,7 +32,7 @@ A random.xml - random + random Pseudo-random number generation.

This module provides a random number generator. The method is attributed @@ -73,7 +73,7 @@ - + Seed random number generation with default values.

Seeds random number generation with default (fixed) values @@ -82,7 +82,7 @@ - + Seed random number generator.

seed({A1, A2, A3}) @@ -92,7 +92,7 @@ - + Seed random number generator.

Seeds random number generation with integer values in the process @@ -116,7 +116,7 @@ random:seed(erlang:phash2([node()]), - + Return default state for random number generation.

Returns the default state.

@@ -124,7 +124,7 @@ random:seed(erlang:phash2([node()]),
- + Return a random float.

Returns a random float uniformly distributed between 0.0 @@ -133,7 +133,7 @@ random:seed(erlang:phash2([node()]), - + Return a random integer.

Returns, for a specified integer N >= 1, @@ -144,7 +144,7 @@ random:seed(erlang:phash2([node()]), - + Return a random float.

Returns, for a specified state, a random float uniformly @@ -153,7 +153,7 @@ random:seed(erlang:phash2([node()]), - + Return a random integer.

Returns, for a specified integer N >= 1 and a diff --git a/lib/stdlib/doc/src/re.xml b/lib/stdlib/doc/src/re.xml index 71f49cb640..b04434492d 100644 --- a/lib/stdlib/doc/src/re.xml +++ b/lib/stdlib/doc/src/re.xml @@ -34,7 +34,7 @@ A re.xml - re + re Perl-like regular expressions for Erlang.

This module contains regular expression matching functions for @@ -87,7 +87,7 @@ - + Compile a regular expression into a match program

The same as compile(Regexp,[])

@@ -95,7 +95,7 @@
- + Compile a regular expression into a match program.

Compiles a regular expression, with the syntax @@ -348,7 +348,7 @@ - + Match a subject against regular expression and replace matching elements with Replacement. @@ -358,7 +358,7 @@ - + Match a subject against regular expression and replace matching elements with Replacement. @@ -408,7 +408,7 @@ re:replace("abcd","c","[\\&]",[{return,list}]). - + Match a subject against regular expression and capture subpatterns. @@ -417,7 +417,7 @@ re:replace("abcd","c","[\\&]",[{return,list}]). - + Match a subject against regular expression and capture subpatterns. See @@ -992,7 +992,7 @@ re:run("cacb","c(a|b)",[global,{capture,[1],list}]). - + Split a string by tokens specified as a regular expression. @@ -1001,7 +1001,7 @@ re:run("cacb","c(a|b)",[global,{capture,[1],list}]). - + Split a string by tokens specified as a regular expression See compile/2. diff --git a/lib/stdlib/doc/src/sets.xml b/lib/stdlib/doc/src/sets.xml index e076b9a5ec..07ce41b7a7 100644 --- a/lib/stdlib/doc/src/sets.xml +++ b/lib/stdlib/doc/src/sets.xml @@ -32,7 +32,7 @@ A sets.xml - sets + sets Functions for set manipulation.

Sets are collections of elements with no duplicate elements. @@ -59,7 +59,7 @@ - + Add an element to a Set.

Returns a new set formed from Set1 with @@ -68,7 +68,7 @@ - + Remove an element from a Set.

Returns Set1, but with @@ -77,7 +77,7 @@ - + Filter set elements.

Filters elements in Set1 with boolean function @@ -86,7 +86,7 @@ - + Fold over set elements.

Folds Function over every element in @@ -96,7 +96,7 @@ - + Convert a list into a Set.

Returns a set of the elements in List.

@@ -104,7 +104,7 @@
- + Return the intersection of a list of Sets.

Returns the intersection of the non-empty list of sets.

@@ -112,7 +112,7 @@
- + Return the intersection of two Sets.

Returns the intersection of Set1 and @@ -121,7 +121,7 @@ - + Check whether two Sets are disjoint.

Returns true if Set1 and @@ -131,7 +131,7 @@ - + Test for membership of a Set.

Returns true if Element is an element of @@ -149,7 +149,7 @@ - + Test for a Set.

Returns true if Set is a set of @@ -158,7 +158,7 @@ - + Test for subset.

Returns true when every element of Set1 is @@ -167,7 +167,7 @@ - + Return an empty set.

Returns a new empty set.

@@ -175,7 +175,7 @@
- + Return the number of elements in a set.

Returns the number of elements in Set.

@@ -183,7 +183,7 @@
- + Return the difference of two Sets.

Returns only the elements of Set1 that are not @@ -192,7 +192,7 @@ - + Convert a Setinto a list.

Returns the elements of Set as a list. @@ -201,7 +201,7 @@ - + Return the union of a list of Sets.

Returns the merged (union) set of the list of sets.

@@ -209,7 +209,7 @@
- + Return the union of two Sets.

Returns the merged (union) set of Set1 and diff --git a/lib/stdlib/doc/src/shell.xml b/lib/stdlib/doc/src/shell.xml index 892bb64daf..50a0968531 100644 --- a/lib/stdlib/doc/src/shell.xml +++ b/lib/stdlib/doc/src/shell.xml @@ -32,7 +32,7 @@ A shell.xml - shell + shell The Erlang shell.

This module provides an Erlang shell.

@@ -874,7 +874,7 @@ q - quit erlang - catch_exception(Bool) -> boolean() + catch_exception(Bool) -> boolean() Set the exception handling of the shell. Bool = boolean() @@ -892,7 +892,7 @@ q - quit erlang - + Set the number of previous commands to keep.

Sets the number of previous commands to keep in the @@ -911,7 +911,7 @@ q - quit erlang - + Set the number of previous results to keep.

Sets the number of results from previous commands to keep in @@ -921,7 +921,7 @@ q - quit erlang - + Exit a normal shell and starts a restricted shell.

Exits a normal shell and starts a restricted shell. @@ -936,7 +936,7 @@ q - quit erlang - + Exit a restricted shell and starts a normal shell.

Exits a restricted shell and starts a normal shell. The function diff --git a/lib/stdlib/doc/src/slave.xml b/lib/stdlib/doc/src/slave.xml index e53ec8231b..80fb28b548 100644 --- a/lib/stdlib/doc/src/slave.xml +++ b/lib/stdlib/doc/src/slave.xml @@ -28,7 +28,7 @@ - slave + slave Functions for starting and controlling slave nodes. @@ -68,7 +68,7 @@ - pseudo([Master | ServerList]) -> ok + pseudo([Master | ServerList]) -> ok Start a number of pseudo servers. Master = node() @@ -84,7 +84,7 @@ - + Start a number of pseudo servers.

Starts a number of pseudo servers. A pseudo server is a @@ -102,7 +102,7 @@ rpc:call(N, slave, pseudo, [node(), [pxw_server]]). - + Run a pseudo server.

Runs a pseudo server. This function never returns any value @@ -113,9 +113,9 @@ rpc:call(N, slave, pseudo, [node(), [pxw_server]]). - - - + + + Start a slave node on a host.

Starts a slave node on host Host. Host names @@ -178,9 +178,9 @@ slave:start(H, Name, Arg). - - - + + + Start and link to a slave node on a host.

Starts a slave node in the same way as start/1,2,3, @@ -193,7 +193,7 @@ slave:start(H, Name, Arg). - + Stop (kill) a node.

Stops (kills) a node.

diff --git a/lib/stdlib/doc/src/sofs.xml b/lib/stdlib/doc/src/sofs.xml index 4cf1984d46..a0759d2f52 100644 --- a/lib/stdlib/doc/src/sofs.xml +++ b/lib/stdlib/doc/src/sofs.xml @@ -32,7 +32,7 @@ PA1 sofs.xml - sofs + sofs Functions for manipulating sets of sets.

This module provides operations on finite sets and @@ -456,8 +456,8 @@ fun(S) -> sofs:partition(1, S) end - - + + Create a function.

Creates a function. @@ -470,7 +470,7 @@ fun(S) -> sofs:partition(1, S) end - + Return the canonical map.

Returns the binary relation containing the elements @@ -490,7 +490,7 @@ fun(S) -> sofs:partition(1, S) end - + Return the composite of two functions.

Returns the composite of @@ -506,7 +506,7 @@ fun(S) -> sofs:partition(1, S) end - + Create the function that maps each element of a set onto another set. @@ -522,7 +522,7 @@ fun(S) -> sofs:partition(1, S) end - + Return the converse of a binary relation.

Returns the converse @@ -536,7 +536,7 @@ fun(S) -> sofs:partition(1, S) end - + Return the difference of two sets.

Returns the difference of @@ -545,8 +545,8 @@ fun(S) -> sofs:partition(1, S) end - - + + Create a family from a directed graph.

Creates a family from @@ -565,7 +565,7 @@ fun(S) -> sofs:partition(1, S) end - + Return the domain of a binary relation.

Returns the domain of @@ -579,7 +579,7 @@ fun(S) -> sofs:partition(1, S) end - + Return a restriction of a binary relation.

Returns the difference between the binary relation @@ -598,7 +598,7 @@ fun(S) -> sofs:partition(1, S) end - + Return a restriction of a relation.

Returns a subset of Set1 containing those @@ -618,7 +618,7 @@ fun(S) -> sofs:partition(1, S) end - + Return the untyped empty set.

Returns the untyped empty @@ -628,7 +628,7 @@ fun(S) -> sofs:partition(1, S) end - + Extend the domain of a binary relation.

Returns the extension of @@ -648,8 +648,8 @@ fun(S) -> sofs:partition(1, S) end - - + + Create a family of subsets.

Creates a family of subsets. @@ -662,7 +662,7 @@ fun(S) -> sofs:partition(1, S) end - + Return the difference of two families.

If Family1 and Family2 @@ -683,7 +683,7 @@ fun(S) -> sofs:partition(1, S) end - + Return a family of domains.

If Family1 is @@ -704,7 +704,7 @@ fun(S) -> sofs:partition(1, S) end - + Return a family of fields.

If Family1 is @@ -728,7 +728,7 @@ fun(S) -> sofs:partition(1, S) end - + Return the intersection of a family of sets of sets. @@ -752,7 +752,7 @@ fun(S) -> sofs:partition(1, S) end - + Return the intersection of two families.

If Family1 and Family2 @@ -772,7 +772,7 @@ fun(S) -> sofs:partition(1, S) end - + Return a family of modified subsets.

If Family1 is @@ -791,7 +791,7 @@ fun(S) -> sofs:partition(1, S) end - + Return a family of ranges.

If Family1 is @@ -812,7 +812,7 @@ fun(S) -> sofs:partition(1, S) end - + Select a subset of a family using a predicate.

If Family1 is @@ -837,8 +837,8 @@ fun(S) -> sofs:partition(1, S) end - - + + Create a directed graph from a family.

Creates a directed graph from @@ -863,7 +863,7 @@ fun(S) -> sofs:partition(1, S) end - + Create a binary relation from a family.

If Family is @@ -881,7 +881,7 @@ fun(S) -> sofs:partition(1, S) end - + Return the union of a family of sets of sets.

If Family1 is @@ -904,7 +904,7 @@ fun(S) -> sofs:partition(1, S) end - + Return the union of two families.

If Family1 and Family2 @@ -926,7 +926,7 @@ fun(S) -> sofs:partition(1, S) end - + Return the field of a binary relation.

Returns the field of the @@ -942,7 +942,7 @@ fun(S) -> sofs:partition(1, S) end - + Create a set.

Creates a set from the external @@ -955,7 +955,7 @@ fun(S) -> sofs:partition(1, S) end - + Create a set out of a list of sets.

Returns the unordered @@ -971,7 +971,7 @@ fun(S) -> sofs:partition(1, S) end - + Create an ordered set out of a tuple of sets.

Returns the ordered @@ -981,8 +981,8 @@ fun(S) -> sofs:partition(1, S) end - - + + Create a set.

Creates an element @@ -1031,7 +1031,7 @@ fun(S) -> sofs:partition(1, S) end - + Return the image of a set under a binary relation.

Returns the image of @@ -1047,7 +1047,7 @@ fun(S) -> sofs:partition(1, S) end - + Return the intersection of a set of sets.

Returns @@ -1059,7 +1059,7 @@ fun(S) -> sofs:partition(1, S) end - + Return the intersection of two sets.

Returns @@ -1069,7 +1069,7 @@ fun(S) -> sofs:partition(1, S) end - + Return the intersection of a family.

Returns the intersection of @@ -1086,7 +1086,7 @@ fun(S) -> sofs:partition(1, S) end - + Return the inverse of a function.

Returns the inverse @@ -1100,7 +1100,7 @@ fun(S) -> sofs:partition(1, S) end - + Return the inverse image of a set under a binary relation. @@ -1117,7 +1117,7 @@ fun(S) -> sofs:partition(1, S) end - + Test for a function.

Returns true if the binary relation BinRel @@ -1127,7 +1127,7 @@ fun(S) -> sofs:partition(1, S) end - + Test for disjoint sets.

Returns true if Set1 @@ -1138,7 +1138,7 @@ fun(S) -> sofs:partition(1, S) end - + Test for an empty set.

Returns true if AnySet is an empty @@ -1147,7 +1147,7 @@ fun(S) -> sofs:partition(1, S) end - + Test two sets for equality.

Returns true if AnySet1 @@ -1164,7 +1164,7 @@ true - + Test for an unordered set.

Returns true if AnySet is @@ -1175,7 +1175,7 @@ true - + Test for an unordered set.

Returns true if Term is @@ -1185,7 +1185,7 @@ true - + Test two sets for subset.

Returns true if Set1 is @@ -1195,7 +1195,7 @@ true - + Test for a type.

Returns true if term Term is @@ -1204,7 +1204,7 @@ true - + Return the join of two relations.

Returns the natural @@ -1221,7 +1221,7 @@ true - + Return the multiple relative product of a tuple of binary relations and a relation. @@ -1242,7 +1242,7 @@ true - + Return the number of elements of a set.

Returns the number of elements of the ordered or unordered @@ -1251,7 +1251,7 @@ true - + Return the coarsest partition given a set of sets.

Returns the partition of @@ -1268,7 +1268,7 @@ true - + Return a partition of a set.

Returns the partition of @@ -1284,7 +1284,7 @@ true - + Return a partition of a set.

Returns a pair of sets that, regarded as constituting a @@ -1307,7 +1307,7 @@ true - + Return a family indexing a partition.

Returns family @@ -1328,7 +1328,7 @@ true - + Return the Cartesian product of a tuple of sets.

Returns the Cartesian @@ -1347,7 +1347,7 @@ true - + Return the Cartesian product of two sets.

Returns the Cartesian @@ -1365,7 +1365,7 @@ true - + Return a set of substituted elements.

Returns the set created by substituting each element of @@ -1384,7 +1384,7 @@ true - + Return the range of a binary relation.

Returns the range of the @@ -1398,8 +1398,8 @@ true - - + + Create a relation.

Creates a relation. @@ -1417,7 +1417,7 @@ true - + Create a family from a binary relation.

Returns family @@ -1435,8 +1435,8 @@ true - - + + Return the relative product of a list of binary relations and a binary relation. @@ -1466,7 +1466,7 @@ true - + Return the relative product of two binary relations. @@ -1477,7 +1477,7 @@ true - + Return the relative_product of two binary relations. @@ -1498,7 +1498,7 @@ true - + Return a restriction of a binary relation.

Returns the restriction of @@ -1514,7 +1514,7 @@ true - + Return a restriction of a set.

Returns a subset of Set1 containing those @@ -1530,8 +1530,8 @@ true - - + + Create a set of atoms or any type of sets.

Creates an unordered @@ -1543,7 +1543,7 @@ true - + Select a subset using a predicate.

Returns the set containing every element @@ -1564,7 +1564,7 @@ true - + Return the strict relation corresponding to a given relation. @@ -1580,7 +1580,7 @@ true - + Return a function with a given set as domain.

Returns a function, the domain of which @@ -1629,7 +1629,7 @@ images2(SetOfSets, BinRel) -> - + Return the symmetric difference of two sets.

Returns the symmetric @@ -1645,7 +1645,7 @@ images2(SetOfSets, BinRel) -> - + Return a partition of two sets.

Returns a triple of sets:

@@ -1666,7 +1666,7 @@ images2(SetOfSets, BinRel) ->
- + Return the elements of a set.

Returns the external @@ -1675,7 +1675,7 @@ images2(SetOfSets, BinRel) -> - + Return a list or a tuple of the elements of a set.

Returns the elements of the ordered set ASet @@ -1686,7 +1686,7 @@ images2(SetOfSets, BinRel) -> - + Return the type of a set.

Returns the type of an @@ -1695,7 +1695,7 @@ images2(SetOfSets, BinRel) -> - + Return the union of a set of sets.

Returns the union of the @@ -1704,7 +1704,7 @@ images2(SetOfSets, BinRel) -> - + Return the union of two sets.

Returns the union of @@ -1713,7 +1713,7 @@ images2(SetOfSets, BinRel) -> - + Return the union of a family.

Returns the union of family @@ -1727,7 +1727,7 @@ images2(SetOfSets, BinRel) -> - + Return the weak relation corresponding to a given relation. diff --git a/lib/stdlib/doc/src/string.xml b/lib/stdlib/doc/src/string.xml index d3b0175d69..d102191a57 100644 --- a/lib/stdlib/doc/src/string.xml +++ b/lib/stdlib/doc/src/string.xml @@ -32,7 +32,7 @@ A string.xml - string + string String processing functions.

This module provides functions for string processing.

@@ -164,7 +164,7 @@
- + Test string equality. @@ -522,7 +522,7 @@ ÖÄÅ - + Return a float whose text representation is the integers (ASCII values) of a string. @@ -544,7 +544,7 @@ ÖÄÅ - + Return an integer whose text representation is the integers (ASCII values) of a string. @@ -649,8 +649,8 @@ ÖÄÅ - - + + Center a string.

Returns a string, where String is centered in the @@ -664,8 +664,8 @@ ÖÄÅ - - + + Return a string consisting of numbers of characters.

Returns a string consisting of Number characters @@ -678,7 +678,7 @@ ÖÄÅ - + Return the index of the first occurrence of a character in a string. @@ -692,7 +692,7 @@ ÖÄÅ - + Concatenate two strings.

Concatenates String1 and @@ -712,7 +712,7 @@ ÖÄÅ - + Copy a string.

Returns a string containing String repeated @@ -724,7 +724,7 @@ ÖÄÅ - + Span characters at start of a string.

Returns the length of the maximum initial segment of @@ -741,7 +741,7 @@ ÖÄÅ - + Join a list of strings with separator.

Returns a string with the elements of StringList @@ -757,8 +757,8 @@ ÖÄÅ - - + + Adjust left end of a string.

Returns String with the length adjusted in @@ -778,7 +778,7 @@ ÖÄÅ - + Return the length of a string.

Returns the number of characters in String.

@@ -789,7 +789,7 @@ ÖÄÅ
- + Return the index of the last occurrence of a character in a string. @@ -803,8 +803,8 @@ ÖÄÅ - - + + Adjust right end of a string.

Returns String with the length adjusted in @@ -823,7 +823,7 @@ ÖÄÅ - + Find the index of a substring.

Returns the position where the last occurrence of @@ -841,7 +841,7 @@ ÖÄÅ - + Span characters at start of a string.

Returns the length of the maximum initial segment of @@ -858,7 +858,7 @@ ÖÄÅ - + Find the index of a substring.

Returns the position where the first occurrence of @@ -876,9 +876,9 @@ ÖÄÅ - - - + + + Strip leading or trailing characters.

Returns a string, where leading or trailing, or both, blanks or a @@ -898,8 +898,8 @@ ÖÄÅ - - + + Extract a substring.

Returns a substring of String, starting at @@ -916,8 +916,8 @@ sub_string("Hello World", 4, 8). - - + + Return a substring of a string.

Returns a substring of String, starting at @@ -934,8 +934,8 @@ sub_string("Hello World", 4, 8). - - + + Extract subword.

Returns the word in position Number of @@ -952,10 +952,10 @@ sub_string("Hello World", 4, 8). - - - - + + + + Convert case of string (ISO/IEC 8859-1). @@ -974,7 +974,7 @@ sub_string("Hello World", 4, 8). - + Split string into tokens.

Returns a list of tokens in String, separated @@ -994,8 +994,8 @@ sub_string("Hello World", 4, 8). - - + + Count blank separated words.

Returns the number of words in String, separated diff --git a/lib/stdlib/doc/src/supervisor.xml b/lib/stdlib/doc/src/supervisor.xml index eb6168c002..f15b1a2dd3 100644 --- a/lib/stdlib/doc/src/supervisor.xml +++ b/lib/stdlib/doc/src/supervisor.xml @@ -28,7 +28,7 @@ - supervisor + supervisor Generic supervisor behavior.

This behavior module provides a supervisor, a process that @@ -318,7 +318,7 @@ child_spec() = #{id => child_id(), % mandatory - + Check if children specifications are syntactically correct. @@ -366,7 +366,7 @@ child_spec() = #{id => child_id(), % mandatory - + Delete a child specification from a supervisor.

Tells supervisor SupRef to delete the child @@ -400,7 +400,7 @@ child_spec() = #{id => child_id(), % mandatory - + Restart a terminated child process belonging to a supervisor. @@ -436,7 +436,7 @@ child_spec() = #{id => child_id(), % mandatory - + Dynamically add a child process to a supervisor. @@ -503,8 +503,8 @@ child_spec() = #{id => child_id(), % mandatory - - + + Create a supervisor process. @@ -584,7 +584,7 @@ child_spec() = #{id => child_id(), % mandatory - + Terminate a child process belonging to a supervisor.

Tells supervisor SupRef to terminate the @@ -621,7 +621,7 @@ child_spec() = #{id => child_id(), % mandatory - + Return information about all children specifications and child processes belonging to a supervisor. @@ -666,7 +666,7 @@ child_spec() = #{id => child_id(), % mandatory - Module:init(Args) -> Result + Module:init(Args) -> Result Return a supervisor specification. Args = term() diff --git a/lib/stdlib/doc/src/supervisor_bridge.xml b/lib/stdlib/doc/src/supervisor_bridge.xml index c4c1b37548..ee5d97fea1 100644 --- a/lib/stdlib/doc/src/supervisor_bridge.xml +++ b/lib/stdlib/doc/src/supervisor_bridge.xml @@ -30,7 +30,7 @@ - supervisor_bridge + supervisor_bridge Generic supervisor bridge behavior.

This behavior module provides a supervisor bridge, a process @@ -57,8 +57,8 @@ - - + + Create a supervisor bridge process.

Creates a supervisor bridge process, linked to the calling process, @@ -133,7 +133,7 @@ - Module:init(Args) -> Result + Module:init(Args) -> Result Initialize process and start subsystem. Args = term() @@ -164,7 +164,7 @@ - Module:terminate(Reason, State) + Module:terminate(Reason, State) Clean up and stop subsystem. Reason = shutdown | term() diff --git a/lib/stdlib/doc/src/sys.xml b/lib/stdlib/doc/src/sys.xml index 040f6587ec..6fc508b853 100644 --- a/lib/stdlib/doc/src/sys.xml +++ b/lib/stdlib/doc/src/sys.xml @@ -32,7 +32,7 @@ sys.xml - sys + sys A functional interface to system messages.

This module contains functions for sending system messages used by @@ -129,8 +129,8 @@ - - + + Send the code change system message to the process.

Tells the process to change code. The process must be @@ -227,8 +227,8 @@ - - + + Get the status of the process.

Gets the status of the process.

@@ -265,8 +265,8 @@
- - + + Install a debug function in the process.

Enables installation of alternative debug functions. An example of @@ -283,8 +283,8 @@ - - + + Log system events in memory.

Turns the logging of system events on or off. If on, a @@ -302,8 +302,8 @@ - - + + Log system events to the specified file.

Enables or disables the logging of all system events in text @@ -315,8 +315,8 @@ - - + + Turn off debugging.

Turns off all debugging for the process. This includes @@ -327,8 +327,8 @@ - - + + Remove a debug function from the process.

Removes an installed debug function from the @@ -451,8 +451,8 @@ - - + + Resume a suspended process.

Resumes a suspended process.

@@ -460,8 +460,8 @@
- - + + Enable or disable the collections of statistics.

Enables or disables the collection of statistics. If @@ -471,8 +471,8 @@ - - + + Suspend the process.

Suspends the process. When the process is suspended, it @@ -494,8 +494,8 @@ - - + + Print all system events on standard_io.

Prints all system events on standard_io. The events are @@ -518,7 +518,7 @@ - + Convert a list of options to a debug structure.

Can be used by a process that initiates a debug @@ -529,7 +529,7 @@ - + Get the data associated with a debug option.

Gets the data associated with a debug option. @@ -541,7 +541,7 @@ - + Generate a system event.

This function is called by a process when it generates a @@ -556,7 +556,7 @@ - + Take care of system messages.

This function is used by a process module to take care of system @@ -594,7 +594,7 @@ - + Print the logged events in the debug structure.

Prints the logged system events in the debug structure, @@ -605,7 +605,7 @@ - Module:system_code_change(Misc, Module, OldVsn, Extra) -> + Module:system_code_change(Misc, Module, OldVsn, Extra) -> {ok, NMisc} Called when the process is to perform a code change. @@ -628,7 +628,7 @@ - Module:system_continue(Parent, Debug, Misc) -> none() + Module:system_continue(Parent, Debug, Misc) -> none() Called when the process is to continue its execution. Parent = pid() @@ -681,7 +681,7 @@ - Module:system_terminate(Reason, Parent, Debug, Misc) -> none() + Module:system_terminate(Reason, Parent, Debug, Misc) -> none() Called when the process is to terminate. Reason = term() diff --git a/lib/stdlib/doc/src/timer.xml b/lib/stdlib/doc/src/timer.xml index 885bb89b1a..165eecfbb0 100644 --- a/lib/stdlib/doc/src/timer.xml +++ b/lib/stdlib/doc/src/timer.xml @@ -32,7 +32,7 @@ D timer.xml - timer + timer Timer functions.

This module provides useful functions related to time. Unless otherwise @@ -62,7 +62,7 @@ - + Apply Module:Function(Arguments) after a specified Time. @@ -75,7 +75,7 @@ - + Evaluate Module:Function(Arguments) repeatedly at intervals of Time. @@ -88,7 +88,7 @@ - + Cancel a previously requested time-out identified by TRef. @@ -101,8 +101,8 @@ - - + + Send an exit signal with Reason after a specified Time. @@ -117,7 +117,7 @@ - + Convert Hours+Minutes+Seconds to Milliseconds. @@ -127,7 +127,7 @@ - + Convert Hours to Milliseconds.

Returns the number of milliseconds in Hours.

@@ -135,8 +135,8 @@
- - + + Send an exit signal with Reason after a specified Time. @@ -148,7 +148,7 @@ - + Converts Minutes to Milliseconds.

Returns the number of milliseconds in @@ -157,7 +157,7 @@ - + Calculate time difference between time stamps. In microseconds @@ -173,7 +173,7 @@ - + Convert Seconds to Milliseconds.

Returns the number of milliseconds in @@ -182,8 +182,8 @@ - - + + Send Message to Pid after a specified Time. @@ -206,8 +206,8 @@ - - + + Send Message repeatedly at intervals of Time. @@ -231,7 +231,7 @@ - + Suspend the calling process for Time milliseconds. @@ -244,7 +244,7 @@ - + Start a global timer server (named timer_server). @@ -260,7 +260,7 @@ - + Measure the real time it takes to evaluate apply(Module, Function, Arguments) or apply(Fun, Arguments). In microseconds diff --git a/lib/stdlib/doc/src/unicode.xml b/lib/stdlib/doc/src/unicode.xml index 2451006564..b7696a4b7e 100644 --- a/lib/stdlib/doc/src/unicode.xml +++ b/lib/stdlib/doc/src/unicode.xml @@ -30,7 +30,7 @@ - unicode + unicode Functions for converting Unicode characters.

This module contains functions for converting between different character @@ -139,7 +139,7 @@ - + Identify UTF byte order marks in a binary. @@ -156,7 +156,7 @@ - + Convert a collection of characters to a UTF-8 binary.

Same as characters_to_binary(Data, unicode, @@ -165,7 +165,7 @@ - + Convert a collection of characters to a UTF-8 binary.

Same as characters_to_binary(Data, @@ -174,7 +174,7 @@ - + Convert a collection of characters to a UTF-8 binary.

Behaves as @@ -211,7 +211,7 @@ - + Convert a collection of characters to a list of Unicode characters. @@ -220,7 +220,7 @@ - + Convert a collection of characters to a list of Unicode characters. @@ -515,7 +515,7 @@ decode_data(Data) -> - + Create a binary UTF byte order mark from encoding. A binary() such that byte_size(Bin) >= 4. diff --git a/lib/stdlib/doc/src/win32reg.xml b/lib/stdlib/doc/src/win32reg.xml index f4a4fa1626..5e2aed6062 100644 --- a/lib/stdlib/doc/src/win32reg.xml +++ b/lib/stdlib/doc/src/win32reg.xml @@ -32,7 +32,7 @@ PA1 win32reg.xml - win32reg + win32reg Provides access to the registry on Windows.

This module provides read and write access to the @@ -112,7 +112,7 @@ hkdd HKEY_DYN_DATA - + Move to a key in the registry.

Changes the current key to another key. Works like cd. @@ -122,7 +122,7 @@ hkdd HKEY_DYN_DATA - + Move to a key, create it if it is not there.

Creates a key, or just changes to it, if it is already there. Works @@ -133,7 +133,7 @@ hkdd HKEY_DYN_DATA - + Close the registry.

Closes the registry. After that, the RegHandle @@ -142,7 +142,7 @@ hkdd HKEY_DYN_DATA - + Return the path to the current key.

Returns the path to the current key. This is the equivalent of @@ -153,7 +153,7 @@ hkdd HKEY_DYN_DATA - + Delete the current key.

Deletes the current key, if it is valid. Calls the Win32 API @@ -166,7 +166,7 @@ hkdd HKEY_DYN_DATA - + Delete the named value on the current key.

Deletes a named value on the current key. The atom default is @@ -176,7 +176,7 @@ hkdd HKEY_DYN_DATA - + Expand a string with environment variables.

Expands a string containing environment variables between percent @@ -189,7 +189,7 @@ hkdd HKEY_DYN_DATA - + Convert a POSIX error code to a string.

Converts a POSIX error code to a string @@ -198,7 +198,7 @@ hkdd HKEY_DYN_DATA - + Open the registry for reading or writing.

Opens the registry for reading or writing. The current key is the @@ -211,7 +211,7 @@ hkdd HKEY_DYN_DATA - + Set value at the current registry key with specified name. @@ -230,7 +230,7 @@ hkdd HKEY_DYN_DATA - + Get subkeys to the current key.

Returns a list of subkeys to the current key. Calls the Win32 @@ -240,7 +240,7 @@ hkdd HKEY_DYN_DATA - + Get the named value on the current key.

Retrieves the named value (or default) on the current key. @@ -251,7 +251,7 @@ hkdd HKEY_DYN_DATA - + Get all values on the current key.

Retrieves a list of all values on the current key. The values diff --git a/lib/stdlib/doc/src/zip.xml b/lib/stdlib/doc/src/zip.xml index aaa25952c2..bb2ed7727a 100644 --- a/lib/stdlib/doc/src/zip.xml +++ b/lib/stdlib/doc/src/zip.xml @@ -32,7 +32,7 @@ PA1 zip.xml - zip + zip Utility for reading and creating 'zip' archives. @@ -234,10 +234,10 @@ - - - - + + + + Retrieve the name of all files in a zip archive.

list_dir/1 retrieves all filenames in the zip archive @@ -263,7 +263,7 @@ - + Print the name of each file in a zip archive.

Prints all filenames in the zip archive Archive @@ -272,7 +272,7 @@ - + Print name and information for each file in a zip archive. @@ -283,10 +283,10 @@ - - - - + + + + Extract files from a zip archive.

unzip/1 extracts all files from a zip archive.

@@ -353,10 +353,10 @@
- - - - + + + + Create a zip archive with options.

Creates a zip archive containing the files specified in @@ -481,7 +481,7 @@ - + Close an open archive.

Closes a zip archive, previously opened with @@ -492,8 +492,8 @@ - - + + Extract files from an open archive.

Extracts one or all files from an open archive.

@@ -505,7 +505,7 @@
- + Return a table of files in open zip archive.

Returns the file list of an open zip archive. The first returned @@ -514,8 +514,8 @@ - - + + Open an archive and return a handle to it.

Opens a zip archive, and reads and saves its directory. This diff --git a/lib/tftp/doc/src/tftp.xml b/lib/tftp/doc/src/tftp.xml index e72a4ec985..57d64b7379 100644 --- a/lib/tftp/doc/src/tftp.xml +++ b/lib/tftp/doc/src/tftp.xml @@ -28,7 +28,7 @@ - tftp + tftp Trivial FTP.

Interface module for the tftp application.

@@ -172,7 +172,7 @@ - change_config(daemons, Options) -> [{Pid, Result}] + change_config(daemons, Options) -> [{Pid, Result}] Changes configuration for all daemons. @@ -187,7 +187,7 @@ - change_config(servers, Options) -> [{Pid, Result}] + change_config(servers, Options) -> [{Pid, Result}] Changes configuration for all servers. @@ -202,7 +202,7 @@ - change_config(Pid, Options) -> Result + change_config(Pid, Options) -> Result Changes configuration for a TFTP daemon, server, or client process. @@ -217,7 +217,7 @@ - info(daemons) -> [{Pid, Options}] + info(daemons) -> [{Pid, Options}] Returns information about all daemons. Pid = [pid()] @@ -230,7 +230,7 @@ - info(servers) -> [{Pid, Options}] + info(servers) -> [{Pid, Options}] Returns information about all servers. Pid = [pid()] @@ -243,7 +243,7 @@ - info(Pid) -> {ok, Options} | {error, Reason} + info(Pid) -> {ok, Options} | {error, Reason} Returns information about a daemon, server, or client process. Options = [option()] @@ -255,7 +255,7 @@ - read_file(RemoteFilename, LocalFilename, Options) -> {ok, LastCallbackState} | {error, Reason} + read_file(RemoteFilename, LocalFilename, Options) -> {ok, LastCallbackState} | {error, Reason} Reads a (virtual) file from a TFTP server. RemoteFilename = string() @@ -285,7 +285,7 @@ - start(Options) -> {ok, Pid} | {error, Reason} + start(Options) -> {ok, Pid} | {error, Reason} Starts a daemon process. Options = [option()] @@ -301,7 +301,7 @@ - write_file(RemoteFilename, LocalFilename, Options) -> {ok, LastCallbackState} | {error, Reason} + write_file(RemoteFilename, LocalFilename, Options) -> {ok, LastCallbackState} | {error, Reason} Writes a (virtual) file to a TFTP server. RemoteFilename = string() diff --git a/lib/tools/doc/src/cover.xml b/lib/tools/doc/src/cover.xml index ac49be4652..64c24cea2a 100644 --- a/lib/tools/doc/src/cover.xml +++ b/lib/tools/doc/src/cover.xml @@ -30,7 +30,7 @@ - cover + cover A Coverage Analysis Tool for Erlang

The module cover provides a set of functions for coverage @@ -115,7 +115,7 @@ - start() -> {ok,Pid} | {error,Reason} + start() -> {ok,Pid} | {error,Reason} Start Cover. Pid = pid() @@ -128,7 +128,7 @@ - start(Nodes) -> {ok,StartedNodes} | {error,not_main_node} + start(Nodes) -> {ok,StartedNodes} | {error,not_main_node} Start Cover on remote nodes. Nodes = StartedNodes = [atom()] @@ -139,10 +139,10 @@ - compile(ModFiles) -> Result | [Result] - compile(ModFiles, Options) -> Result | [Result] - compile_module(ModFiles) -> Result | [Result] - compile_module(ModFiles, Options) -> Result | [Result] + compile(ModFiles) -> Result | [Result] + compile(ModFiles, Options) -> Result | [Result] + compile_module(ModFiles) -> Result | [Result] + compile_module(ModFiles, Options) -> Result | [Result] Compile one or more modules for Cover analysis. ModFiles = ModFile | [ModFile] @@ -176,9 +176,9 @@ - compile_directory() -> [Result] | {error,Reason} - compile_directory(Dir) -> [Result] | {error,Reason} - compile_directory(Dir, Options) -> [Result] | {error,Reason} + compile_directory() -> [Result] | {error,Reason} + compile_directory(Dir) -> [Result] | {error,Reason} + compile_directory(Dir, Options) -> [Result] | {error,Reason} Compile all modules in a directory for Cover analysis. Dir = string() @@ -199,7 +199,7 @@ - compile_beam(ModFiles) -> Result | [Result] + compile_beam(ModFiles) -> Result | [Result] Compile one or more modules for Cover analysis, using existing beam(s). ModFiles = ModFile | [ModFile] @@ -241,8 +241,8 @@ - compile_beam_directory() -> [Result] | {error,Reason} - compile_beam_directory(Dir) -> [Result] | {error,Reason} + compile_beam_directory() -> [Result] | {error,Reason} + compile_beam_directory(Dir) -> [Result] | {error,Reason} Compile all .beam files in a directory for Cover analysis. Dir = string() @@ -261,13 +261,13 @@ 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} - analyse(Modules, Analysis) -> OneResult | {result,Ok,Fail} | {error,not_main_node} - analyse(Modules, Level) -> OneResult | {result,Ok,Fail} | {error,not_main_node} - analyse(Analysis, Level) -> {result,Ok,Fail} | {error,not_main_node} - analyse(Modules, Analysis, Level) -> OneResult | {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} + analyse(Modules, Analysis) -> OneResult | {result,Ok,Fail} | {error,not_main_node} + analyse(Modules, Level) -> OneResult | {result,Ok,Fail} | {error,not_main_node} + analyse(Analysis, Level) -> {result,Ok,Fail} | {error,not_main_node} + analyse(Modules, Analysis, Level) -> OneResult | {result,Ok,Fail} | {error,not_main_node} Analyse one or more Cover compiled modules. Modules = Module | [Module] @@ -306,9 +306,9 @@ 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} + 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} Detailed coverage analysis of one or more Cover compiled modules. Modules = Module | [Module] @@ -384,7 +384,7 @@ - modules() -> [Module] | {error,not_main_node} + modules() -> [Module] | {error,not_main_node} Return all Cover compiled modules. Module = atom() @@ -395,7 +395,7 @@ - imported_modules() -> [Module] | {error,not_main_node} + imported_modules() -> [Module] | {error,not_main_node} Return all modules for which there are imported data. Module = atom() @@ -406,7 +406,7 @@ - imported() -> [File] | {error,not_main_node} + imported() -> [File] | {error,not_main_node} Return all imported files. File = string() @@ -416,7 +416,7 @@ - which_nodes() -> [Node] | {error,not_main_node} + which_nodes() -> [Node] | {error,not_main_node} Return all nodes that are part of the coverage analysis. Node = atom() @@ -428,7 +428,7 @@ - is_compiled(Module) -> {file,File} | false | {error,not_main_node} + is_compiled(Module) -> {file,File} | false | {error,not_main_node} Check if a module is Cover compiled. Module = atom() @@ -442,8 +442,8 @@ - reset(Module) -> - reset() -> ok | {error,not_main_node} + reset(Module) -> + reset() -> ok | {error,not_main_node} Reset coverage data for Cover compiled modules. Module = atom() @@ -458,8 +458,8 @@ - export(ExportFile) - export(ExportFile,Module) -> ok | {error,Reason} + export(ExportFile) + export(ExportFile,Module) -> ok | {error,Reason} Reset coverage data for Cover compiled modules. ExportFile = string() @@ -480,7 +480,7 @@ - import(ExportFile) -> ok | {error,Reason} + import(ExportFile) -> ok | {error,Reason} Reset coverage data for Cover compiled modules. ExportFile = string() @@ -504,14 +504,14 @@ - stop() -> ok | {error,not_main_node} + stop() -> ok | {error,not_main_node} Stop Cover.

Stops the Cover server and unloads all Cover compiled code.

- stop(Nodes) -> ok | {error,not_main_node} + stop(Nodes) -> ok | {error,not_main_node} Stop Cover on remote nodes. Nodes = [atom()] diff --git a/lib/tools/doc/src/cprof.xml b/lib/tools/doc/src/cprof.xml index df0acbe617..b6af8b6d28 100644 --- a/lib/tools/doc/src/cprof.xml +++ b/lib/tools/doc/src/cprof.xml @@ -34,7 +34,7 @@ PA1 cprof.sgml - cprof + cprof A simple Call Count Profiling Tool using breakpoints for minimal runtime performance impact.

The cprof module is used to profile a program @@ -65,10 +65,10 @@ - analyse() -> {AllCallCount, ModAnalysisList} - analyse(Limit) -> {AllCallCount, ModAnalysisList} - analyse(Mod) -> ModAnalysis - analyse(Mod, Limit) -> ModAnalysis + analyse() -> {AllCallCount, ModAnalysisList} + analyse(Limit) -> {AllCallCount, ModAnalysisList} + analyse(Mod) -> ModAnalysis + analyse(Mod, Limit) -> ModAnalysis Collect and analyse call counters. Limit = integer() @@ -122,7 +122,7 @@ - pause() -> integer() + pause() -> integer() Pause running call count trace for all functions.

Pause call count tracing for all functions in all modules @@ -137,9 +137,9 @@ - pause(FuncSpec) -> integer() - pause(Mod, Func) -> integer() - pause(Mod, Func, Arity) -> integer() + pause(FuncSpec) -> integer() + pause(Mod, Func) -> integer() + pause(Mod, Func, Arity) -> integer() Pause running call count trace for matching functions. FuncSpec = Mod | {Mod,Func,Arity}, {FS} @@ -167,10 +167,10 @@ - restart() -> integer() - restart(FuncSpec) -> integer() - restart(Mod, Func) -> integer() - restart(Mod, Func, Arity) -> integer() + restart() -> integer() + restart(FuncSpec) -> integer() + restart(Mod, Func) -> integer() + restart(Mod, Func, Arity) -> integer() Restart existing call counters for matching functions. FuncSpec = Mod | {Mod,Func,Arity}, {FS} @@ -197,7 +197,7 @@ - start() -> integer() + start() -> integer() Start call count tracing for all functions.

Start call count tracing for all functions in all modules, @@ -212,9 +212,9 @@ - start(FuncSpec) -> integer() - start(Mod, Func) -> integer() - start(Mod, Func, Arity) -> integer() + start(FuncSpec) -> integer() + start(Mod, Func) -> integer() + start(Mod, Func, Arity) -> integer() Start call count tracing for matching functions. FuncSpec = Mod | {Mod,Func,Arity}, {FS} @@ -240,7 +240,7 @@ - stop() -> integer() + stop() -> integer() Stop call count tracing for all functions.

Stop call count tracing for all functions in all modules, @@ -255,9 +255,9 @@ - stop(FuncSpec) -> integer() - stop(Mod, Func) -> integer() - stop(Mod, Func, Arity) -> integer() + stop(FuncSpec) -> integer() + stop(Mod, Func) -> integer() + stop(Mod, Func, Arity) -> integer() Stop call count tracing for matching functions. FuncSpec = Mod | {Mod,Func,Arity}, {FS} diff --git a/lib/tools/doc/src/eprof.xml b/lib/tools/doc/src/eprof.xml index 158f61d9e9..c9e4edd991 100644 --- a/lib/tools/doc/src/eprof.xml +++ b/lib/tools/doc/src/eprof.xml @@ -28,7 +28,7 @@ - eprof + eprof A Time Profiling Tool for Erlang

The module eprof provides a set of functions for time @@ -40,7 +40,7 @@ - start() -> {ok,Pid} | {error,Reason} + start() -> {ok,Pid} | {error,Reason} Start Eprof. Pid = pid() @@ -51,7 +51,7 @@ - start_profiling(Rootset) -> profiling | {error, Reason} + start_profiling(Rootset) -> profiling | {error, Reason} start_profiling(Rootset,Pattern) -> profiling | {error, Reason} start_profiling(Rootset,Pattern,Options) -> profiling | {error, Reason} Start profiling. @@ -79,7 +79,7 @@ - stop_profiling() -> profiling_stopped | profiling_already_stopped + stop_profiling() -> profiling_stopped | profiling_already_stopped Stop profiling.

Stops profiling started with start_profiling/1 or @@ -87,12 +87,12 @@ - profile(Fun) -> profiling | {error, Reason} - profile(Fun, Options) -> profiling | {error, Reason} - profile(Rootset) -> profiling | {error, Reason} - profile(Rootset,Fun) -> {ok, Value} | {error,Reason} + profile(Fun) -> profiling | {error, Reason} + 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,Module,Function,Args) -> {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} Start profiling. @@ -152,7 +152,7 @@ - log(File) -> ok + log(File) -> ok Activate logging of eprofprintouts. File = atom() | string() @@ -164,7 +164,7 @@ - stop() -> stopped + stop() -> stopped Stop Eprof.

Stops the Eprof server.

diff --git a/lib/tools/doc/src/fprof.xml b/lib/tools/doc/src/fprof.xml index 1fd828d127..4bb8862016 100644 --- a/lib/tools/doc/src/fprof.xml +++ b/lib/tools/doc/src/fprof.xml @@ -32,7 +32,7 @@ PA1 fprof.sgml - fprof + fprof A Time Profiling Tool using trace to file for minimal runtime performance impact.

This module is used to profile a program @@ -101,7 +101,7 @@ - start() -> {ok, Pid} | {error, {already_started, Pid}} + start() -> {ok, Pid} | {error, {already_started, Pid}} Starts the fprof server. Pid = pid() @@ -117,14 +117,14 @@ - stop() -> ok + stop() -> ok Same as stop(normal).

Same as stop(normal).

- stop(Reason) -> ok + stop(Reason) -> ok Stops the fprof server. Reason = term() @@ -149,7 +149,7 @@
- apply(Func, Args) -> term() + apply(Func, Args) -> term() Same as apply(Func, Args, []). Func = function() | {Module, Function} @@ -162,7 +162,7 @@
- apply(Module, Function, Args) -> term() + apply(Module, Function, Args) -> term() Same as apply({Module, Function}, Args, []). Args = [term()] @@ -174,7 +174,7 @@
- apply(Func, Args, OptionList) -> term() + apply(Func, Args, OptionList) -> term() Calls erlang:apply(Func, Args)surrounded bytrace([start | OptionList])andtrace(stop). Func = function() | {Module, Function} @@ -210,7 +210,7 @@
- apply(Module, Function, Args, OptionList) -> term() + apply(Module, Function, Args, OptionList) -> term() Same as apply({Module, Function}, Args, OptionList). Module = atom() @@ -228,7 +228,7 @@
- trace(start, Filename) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + trace(start, Filename) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as trace([start, {file, Filename}]). Reason = term() @@ -238,7 +238,7 @@
- trace(verbose, Filename) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + trace(verbose, Filename) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as trace([start, verbose, {file, Filename}]). Reason = term() @@ -249,7 +249,7 @@
- trace(OptionName, OptionValue) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + trace(OptionName, OptionValue) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as trace([{OptionName, OptionValue}]). OptionName = atom() @@ -262,7 +262,7 @@
- trace(verbose) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + trace(verbose) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as trace([start, verbose]). Reason = term() @@ -272,7 +272,7 @@ - trace(OptionName) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + trace(OptionName) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as trace([OptionName]). OptionName = atom() @@ -283,7 +283,7 @@ - trace({OptionName, OptionValue}) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + trace({OptionName, OptionValue}) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as trace([{OptionName, OptionValue}]). OptionName = atom() @@ -296,7 +296,7 @@ - trace([Option]) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + trace([Option]) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Starts or stops tracing. Option = start | stop | {procs, PidSpec} | {procs, [PidSpec]} | verbose | {verbose, bool()} | file | {file, Filename} | {tracer, Tracer} @@ -360,7 +360,7 @@ - profile() -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + profile() -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as profile([]). Reason = term() @@ -370,7 +370,7 @@ - profile(OptionName, OptionValue) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + profile(OptionName, OptionValue) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as profile([{OptionName, OptionValue}]). OptionName = atom() @@ -383,7 +383,7 @@ - profile(OptionName) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + profile(OptionName) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as profile([OptionName]). OptionName = atom() @@ -394,7 +394,7 @@ - profile({OptionName, OptionValue}) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + profile({OptionName, OptionValue}) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as profile([{OptionName, OptionValue}]). OptionName = atom() @@ -407,7 +407,7 @@ - profile([Option]) -> ok | {ok, Tracer} | {error, Reason} | {'EXIT', ServerPid, Reason} + profile([Option]) -> ok | {ok, Tracer} | {error, Reason} | {'EXIT', ServerPid, Reason} Compiles a trace into raw profile data held by the fprof server. Option = file | {file, Filename} | dump | {dump, Dump} | append | start | stop @@ -465,7 +465,7 @@ - analyse() -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + analyse() -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as analyse([]). Reason = term() @@ -475,7 +475,7 @@ - analyse(OptionName, OptionValue) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + analyse(OptionName, OptionValue) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as analyse([{OptionName, OptionValue}]). OptionName = atom() @@ -488,7 +488,7 @@ - analyse(OptionName) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + analyse(OptionName) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as analyse([OptionName]). OptionName = atom() @@ -499,7 +499,7 @@ - analyse({OptionName, OptionValue}) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + analyse({OptionName, OptionValue}) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as analyse([{OptionName, OptionValue}]). OptionName = atom() @@ -512,7 +512,7 @@ - analyse([Option]) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + analyse([Option]) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Analyses raw profile data in the fprof server. Option = dest | {dest, Dest} | append | {cols, Cols} | callers | {callers, bool()} | no_callers | {sort, SortSpec} | totals | {totals, bool()} | details | {details, bool()} | no_details diff --git a/lib/tools/doc/src/instrument.xml b/lib/tools/doc/src/instrument.xml index bc1276bdd5..75be22de9b 100644 --- a/lib/tools/doc/src/instrument.xml +++ b/lib/tools/doc/src/instrument.xml @@ -32,7 +32,7 @@ PA1 instrument.sgml - instrument + instrument Analysis and Utility Functions for Instrumentation

The module instrument contains support for studying the resource diff --git a/lib/tools/doc/src/make.xml b/lib/tools/doc/src/make.xml index 123fcd4afc..af2404707f 100644 --- a/lib/tools/doc/src/make.xml +++ b/lib/tools/doc/src/make.xml @@ -30,7 +30,7 @@ - make + make A Make Utility for Erlang

The module make provides a set of functions similar to @@ -38,8 +38,8 @@ - all() -> up_to_date | error - all(Options) -> up_to_date | error + all() -> up_to_date | error + all(Options) -> up_to_date | error Compile a set of modules. Options = [Option] @@ -87,8 +87,8 @@ - files(ModFiles) -> up_to_date | error - files(ModFiles, Options) -> up_to_date | error + files(ModFiles) -> up_to_date | error + files(ModFiles, Options) -> up_to_date | error Compile a set of modules. ModFiles = [Module | File] diff --git a/lib/tools/doc/src/tags.xml b/lib/tools/doc/src/tags.xml index ea0ae5cc4d..90a8b28177 100644 --- a/lib/tools/doc/src/tags.xml +++ b/lib/tools/doc/src/tags.xml @@ -32,7 +32,7 @@ A tags.sgml - tags + tags Generate Emacs TAGS file from Erlang source files

A TAGS file is used by Emacs to find function and variable @@ -42,14 +42,14 @@ - file(File [, Options]) + file(File [, Options]) Create a TAGSfile for the file File.

Create a TAGS file for the file File.

- files(FileList [, Options]) + files(FileList [, Options]) Create a TAGS file for the files in the listFileList.

Create a TAGS file for the files in the list @@ -57,7 +57,7 @@ - dir(Dir [, Options]) + dir(Dir [, Options]) Create a TAGS file for all files in directoryDir.

Create a TAGS file for all files in directory @@ -65,7 +65,7 @@ - dirs(DirList [, Options]) + dirs(DirList [, Options]) Create a TAGS file for all files in any directory inDirList.

Create a TAGS file for all files in any directory in @@ -73,7 +73,7 @@ - subdir(Dir [, Options]) + subdir(Dir [, Options]) Descend recursively down the directory Dirand create a TAGSfile based on all files found.

Descend recursively down the directory Dir and @@ -81,7 +81,7 @@ - subdirs(DirList [, Options]) + subdirs(DirList [, Options]) Descend recursively down all the directories inDirListand create a TAGSfile based on all files found.

Descend recursively down all the directories in @@ -90,7 +90,7 @@ - root([Options]) + root([Options]) Create a TAGSfile covering all files in the Erlang distribution.

Create a TAGS file covering all files in diff --git a/lib/tools/doc/src/xref.xml b/lib/tools/doc/src/xref.xml index 6f833246ad..ab3641a52f 100644 --- a/lib/tools/doc/src/xref.xml +++ b/lib/tools/doc/src/xref.xml @@ -32,7 +32,7 @@ PA1 xref.sgml - xref + xref A Cross Reference Tool for analyzing dependencies between functions, modules, applications and releases.

Xref is a cross reference tool that can be used for finding @@ -729,7 +729,7 @@ xref() = atom() | pid() - add_application(Xref, Directory [, Options]) -> {ok, application()} | Error + add_application(Xref, Directory [, Options]) -> {ok, application()} | Error Add the modules of an application. Directory = directory() @@ -761,7 +761,7 @@ xref() = atom() | pid() - add_directory(Xref, Directory [, Options]) -> {ok, Modules} | Error + add_directory(Xref, Directory [, Options]) -> {ok, Modules} | Error Add the modules in a directory. Directory = directory() @@ -791,7 +791,7 @@ xref() = atom() | pid() - add_module(Xref, File [, Options]) -> {ok, module()} | Error + add_module(Xref, File [, Options]) -> {ok, module()} | Error Add a module. Error = {error, module(), Reason} @@ -814,7 +814,7 @@ xref() = atom() | pid() - add_release(Xref, Directory [, Options]) -> {ok, release()} | Error + add_release(Xref, Directory [, Options]) -> {ok, release()} | Error Add the modules of a release. Directory = directory() @@ -849,7 +849,7 @@ xref() = atom() | pid() - analyze(Xref, Analysis [, Options]) -> {ok, Answer} | Error + analyze(Xref, Analysis [, Options]) -> {ok, Answer} | Error Evaluate a predefined analysis. Analysis = undefined_function_calls | undefined_functions | locals_not_used | exports_not_used | deprecated_function_calls | {deprecated_function_calls, DeprFlag} | deprecated_functions | {deprecated_functions, DeprFlag} | {call, FuncSpec} | {use, FuncSpec} | {module_call, ModSpec} | {module_use, ModSpec} | {application_call, AppSpec} | {application_use, AppSpec} | {release_call, RelSpec} | {release_use, RelSpec} @@ -939,7 +939,7 @@ Evaluates a predefined analysis. - d(Directory) -> [DebugInfoResult] | [NoDebugInfoResult] | Error + d(Directory) -> [DebugInfoResult] | [NoDebugInfoResult] | Error Check the modules in a directory using the code path. Directory = directory() @@ -979,8 +979,8 @@ Evaluates a predefined analysis. - forget(Xref) -> ok - forget(Xref, Variables) -> ok | Error + forget(Xref) -> ok + forget(Xref, Variables) -> ok | Error Remove user variables and their values. Error = {error, module(), Reason} @@ -994,7 +994,7 @@ Evaluates a predefined analysis. - format_error(Error) -> Chars + format_error(Error) -> Chars Return an English description of an Xref error reply. Error = {error, module(), term()} @@ -1008,8 +1008,8 @@ Evaluates a predefined analysis. - get_default(Xref) -> [{Option, Value}] - get_default(Xref, Option) -> {ok, Value} | Error + get_default(Xref) -> [{Option, Value}] + get_default(Xref, Option) -> {ok, Value} | Error Return the default values of options. Error = {error, module(), Reason} @@ -1023,7 +1023,7 @@ Evaluates a predefined analysis. - get_library_path(Xref) -> {ok, LibraryPath} + get_library_path(Xref) -> {ok, LibraryPath} Return the library path. LibraryPath = library_path() @@ -1034,9 +1034,9 @@ Evaluates a predefined analysis. - info(Xref) -> [Info] - info(Xref, Category) -> [{Item, [Info]}] - info(Xref, Category, Items) -> [{Item, [Info]}] + info(Xref) -> [Info] + info(Xref, Category) -> [{Item, [Info]}] + info(Xref, Category, Items) -> [{Item, [Info]}] Return information about an Xref server. Application = [] | [application()] @@ -1220,8 +1220,8 @@ Evaluates a predefined analysis. - m(Module) -> [DebugInfoResult] | [NoDebugInfoResult] | Error - m(File) -> [DebugInfoResult] | [NoDebugInfoResult] | Error + m(Module) -> [DebugInfoResult] | [NoDebugInfoResult] | Error + m(File) -> [DebugInfoResult] | [NoDebugInfoResult] | Error Check a module using the code path. DebugInfoResult = {deprecated, [funcall()]} | {undefined, [funcall()]} | {unused, [mfa()]} @@ -1263,7 +1263,7 @@ Evaluates a predefined analysis. - q(Xref, Query [, Options]) -> {ok, Answer} | Error + q(Xref, Query [, Options]) -> {ok, Answer} | Error Evaluate a query. Answer = false | [constant()] | [Call] | [Component] | int() | [DefineAt] | [CallAt] | [AllLines] @@ -1322,7 +1322,7 @@ Evaluates a predefined analysis. - remove_application(Xref, Applications) -> ok | Error + remove_application(Xref, Applications) -> ok | Error Remove applications and their modules. Applications = application() | [application()] @@ -1335,7 +1335,7 @@ Evaluates a predefined analysis. - remove_module(Xref, Modules) -> ok | Error + remove_module(Xref, Modules) -> ok | Error Remove analyzed modules. Error = {error, module(), Reason} @@ -1348,7 +1348,7 @@ Evaluates a predefined analysis. - remove_release(Xref, Releases) -> ok | Error + remove_release(Xref, Releases) -> ok | Error Remove releases and their applications and modules. Error = {error, module(), Reason} @@ -1363,7 +1363,7 @@ Evaluates a predefined analysis. - replace_application(Xref, Application, Directory [, Options]) -> {ok, application()} | Error + replace_application(Xref, Application, Directory [, Options]) -> {ok, application()} | Error Replace an application's modules. Application = application() @@ -1384,7 +1384,7 @@ Evaluates a predefined analysis. - replace_module(Xref, Module, File [, Options]) -> {ok, module()} | Error + replace_module(Xref, Module, File [, Options]) -> {ok, module()} | Error Replace an analyzed module. Error = {error, module(), Reason} @@ -1409,8 +1409,8 @@ Evaluates a predefined analysis. - set_default(Xref, Option, Value) -> {ok, OldValue} | Error - set_default(Xref, OptionValues) -> ok | Error + set_default(Xref, Option, Value) -> {ok, OldValue} | Error + set_default(Xref, OptionValues) -> ok | Error Set the default values of options. Error = {error, module(), Reason} @@ -1435,7 +1435,7 @@ Evaluates a predefined analysis. - set_library_path(Xref, LibraryPath [, Options]) -> ok | Error + set_library_path(Xref, LibraryPath [, Options]) -> ok | Error Set the library path and finds the library modules. Error = {error, module(), Reason} @@ -1469,7 +1469,7 @@ Evaluates a predefined analysis. - start(NameOrOptions) -> Return + start(NameOrOptions) -> Return Create an Xref server. NameOrOptions = Name | Options @@ -1487,7 +1487,7 @@ Evaluates a predefined analysis. - start(Name, Options) -> Return + start(Name, Options) -> Return Create an Xref server. Name = atom() @@ -1504,7 +1504,7 @@ Evaluates a predefined analysis. - stop(Xref) + stop(Xref) Delete an Xref server. Xref = xref() @@ -1514,7 +1514,7 @@ Evaluates a predefined analysis. - update(Xref [, Options]) -> {ok, Modules} | Error + update(Xref [, Options]) -> {ok, Modules} | Error Replace newly compiled analyzed modules. Error = {error, module(), Reason} @@ -1534,7 +1534,7 @@ Evaluates a predefined analysis. - variables(Xref [, Options]) -> {ok, [VariableInfo]} + variables(Xref [, Options]) -> {ok, [VariableInfo]} Return the names of variables. Options = [Option] | Option diff --git a/lib/xmerl/doc/src/xmerl_sax_parser.xml b/lib/xmerl/doc/src/xmerl_sax_parser.xml index 8ea197e209..2390779028 100644 --- a/lib/xmerl/doc/src/xmerl_sax_parser.xml +++ b/lib/xmerl/doc/src/xmerl_sax_parser.xml @@ -31,7 +31,7 @@ - xmerl_sax_parser + xmerl_sax_parser XML SAX parser API @@ -325,7 +325,7 @@ - file(Filename, Options) -> Result + file(Filename, Options) -> Result Parse file containing an XML document. Filename = string() @@ -347,7 +347,7 @@ - stream(Xml, Options) -> Result + stream(Xml, Options) -> Result Parse a stream containing an XML document. Xml = unicode_binary() | latin1_binary() | [unicode_char()] @@ -381,7 +381,7 @@ - ContinuationFun(State) -> {NewBytes, NewState} + ContinuationFun(State) -> {NewBytes, NewState} Continuation call back function. State = NewState = term() @@ -402,7 +402,7 @@ - EventFun(Event, Location, State) -> NewState + EventFun(Event, Location, State) -> NewState Event call back function. Event = event() -- cgit v1.2.3 From 606ed183e31bb68c453495caae1c9fad787d48ea Mon Sep 17 00:00:00 2001 From: Sverker Eriksson Date: Wed, 12 Dec 2018 19:26:25 +0100 Subject: Fix since attribute for troubled function docs --- lib/mnesia/doc/src/mnesia.xml | 8 ++++---- lib/observer/doc/src/ttb.xml | 3 ++- lib/parsetools/doc/src/leex.xml | 3 ++- 3 files changed, 8 insertions(+), 6 deletions(-) (limited to 'lib') diff --git a/lib/mnesia/doc/src/mnesia.xml b/lib/mnesia/doc/src/mnesia.xml index 921721d4b7..94f1af34bf 100644 --- a/lib/mnesia/doc/src/mnesia.xml +++ b/lib/mnesia/doc/src/mnesia.xml @@ -2153,7 +2153,7 @@ mnesia:create_table(employee, - sync_transaction(Fun, [[, Args], Retries]) -> {aborted, Reason} | {atomic, ResultOfFun} + sync_transaction(Fun, [[, Args], Retries]) -> {aborted, Reason} | {atomic, ResultOfFun} Synchronously executes a transaction. @@ -2353,7 +2353,7 @@ mnesia:create_table(employee, - table(Tab [,[Option]]) -> QueryHandle + table(Tab [,[Option]]) -> QueryHandle Return a QLC query handle. @@ -2560,7 +2560,7 @@ mnesia:create_table(employee, - transaction(Fun [[, Args], Retries]) -> {aborted, Reason} | {atomic, ResultOfFun} + transaction(Fun [[, Args], Retries]) -> {aborted, Reason} | {atomic, ResultOfFun} Executes a transaction. @@ -2658,7 +2658,7 @@ raise(Name, Amount) -> - traverse_backup(Source, [SourceMod,] Target, [TargetMod,] Fun, Acc) -> {ok, LastAcc} | {error, Reason} + traverse_backup(Source, [SourceMod,] Target, [TargetMod,] Fun, Acc) -> {ok, LastAcc} | {error, Reason} Traversal of a backup. diff --git a/lib/observer/doc/src/ttb.xml b/lib/observer/doc/src/ttb.xml index c42bb9c60c..fee95e0b21 100644 --- a/lib/observer/doc/src/ttb.xml +++ b/lib/observer/doc/src/ttb.xml @@ -277,7 +277,8 @@ ttb:p(all, call). - tp, tpl, tpe, ctp, ctpl, ctpg, ctpe + tp, tpl, ctp, ctpl, ctpg + tpe, ctpe Set and clear trace patterns.

These functions are to be used with trace diff --git a/lib/parsetools/doc/src/leex.xml b/lib/parsetools/doc/src/leex.xml index 2ba1044882..3b82f60201 100644 --- a/lib/parsetools/doc/src/leex.xml +++ b/lib/parsetools/doc/src/leex.xml @@ -38,7 +38,8 @@ Token = tuple() - file(FileName, [, Options]) -> LeexRet + file(FileName) -> LeexRet + file(FileName, Options) -> LeexRet Generate a lexical analyzer FileName = filename() -- cgit v1.2.3