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. --- erts/doc/src/atomics.xml | 22 +- erts/doc/src/counters.xml | 16 +- erts/doc/src/erl_driver.xml | 30 +- erts/doc/src/erl_nif.xml | 336 +++++++++++------------ erts/doc/src/erl_prim_loader.xml | 2 +- erts/doc/src/erl_tracer.xml | 40 +-- erts/doc/src/erlang.xml | 100 +++---- erts/doc/src/persistent_term.xml | 12 +- erts/doc/src/zlib.xml | 12 +- 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 ++--- 139 files changed, 1431 insertions(+), 1431 deletions(-) diff --git a/erts/doc/src/atomics.xml b/erts/doc/src/atomics.xml index 3fca92fb97..46231d9234 100644 --- a/erts/doc/src/atomics.xml +++ b/erts/doc/src/atomics.xml @@ -23,7 +23,7 @@ atomics - atomics + atomics Atomic Functions

This module provides a set of functions to do atomic operations towards @@ -70,7 +70,7 @@ - + Create atomic array

Create a new atomic array of Arity atomics.

@@ -89,7 +89,7 @@ - + Set atomic value

Set atomic to Value.

@@ -97,7 +97,7 @@ - + Read atomic value

Read atomic value.

@@ -105,7 +105,7 @@ - + Add to atomic

Add Incr to atomic.

@@ -113,7 +113,7 @@ - + Atomic add and get

Atomic addition and return of the result.

@@ -121,7 +121,7 @@ - + Subtract from atomic

Subtract Decr from atomic.

@@ -129,7 +129,7 @@ - + Atomic sub and get

Atomic subtraction and return of the result.

@@ -137,7 +137,7 @@ - + Atomic exchange.

Atomically replaces the value of the atomic with @@ -147,7 +147,7 @@ - + Atomic compare and exchange.

Atomically compares the atomic with Expected, @@ -158,7 +158,7 @@ - + Get information about atomic array.

Return information about an atomic array in a map. The map diff --git a/erts/doc/src/counters.xml b/erts/doc/src/counters.xml index ba4a22759f..c3b0bfcf85 100644 --- a/erts/doc/src/counters.xml +++ b/erts/doc/src/counters.xml @@ -23,7 +23,7 @@ counters - counters + counters Counter Functions

This module provides a set of functions to do operations towards @@ -71,7 +71,7 @@ - + Create counter array

Create a new counter array of Size counters.

@@ -107,7 +107,7 @@ - + Read counter value

Read counter value.

@@ -115,7 +115,7 @@ - + Add to counter

Add Incr to counter at index @@ -124,7 +124,7 @@ - + Subtract from counter

Subtract Decr from counter at index @@ -133,7 +133,7 @@ - + Set counter to value

Write Value to counter at index @@ -144,14 +144,14 @@ operation compared to the very lightweight and scalable add and sub. The cost for a put with - write_concurrency is lika a get + write_concurrency is like a get plus a put without write_concurrency.

 - + Get information about counter array.

Return information about a counter array in a map. The map diff --git a/erts/doc/src/erl_driver.xml b/erts/doc/src/erl_driver.xml index 7055889e4a..f2aea77dee 100644 --- a/erts/doc/src/erl_driver.xml +++ b/erts/doc/src/erl_driver.xml @@ -1076,7 +1076,7 @@ r = driver_async(myPort, &myKey, myData, myFunc); ]]> - unsigned intdriver_async_port_key(ErlDrvPort + unsigned intdriver_async_port_key(ErlDrvPort port) Calculate an async key from an ErlDrvPort. @@ -1755,7 +1755,7 @@ r = driver_async(myPort, &myKey, myData, myFunc); ]]> - ErlDrvSizeTdriver_peekqv(ErlDrvPort port, + ErlDrvSizeTdriver_peekqv(ErlDrvPort port, ErlIOVec *ev) Get the driver queue as an I/O vector. @@ -2029,7 +2029,7 @@ r = driver_async(myPort, &myKey, myData, myFunc); ]]> - voiderl_drv_busy_msgq_limits(ErlDrvPort port, + voiderl_drv_busy_msgq_limits(ErlDrvPort port, ErlDrvSizeT *low, ErlDrvSizeT *high) Set and get limits for busy port message queue. @@ -2128,7 +2128,7 @@ r = driver_async(myPort, &myKey, myData, myFunc); ]]> - char *erl_drv_cond_name(ErlDrvCond + char *erl_drv_cond_name(ErlDrvCond *cnd) Get name of driver mutex. @@ -2185,7 +2185,7 @@ r = driver_async(myPort, &myKey, myData, myFunc); ]]> - interl_drv_consume_timeslice(ErlDrvPort port, + interl_drv_consume_timeslice(ErlDrvPort port, int percent) Give the runtime system a hint about how much CPU time the current driver callback call has consumed. @@ -2228,7 +2228,7 @@ r = driver_async(myPort, &myKey, myData, myFunc); ]]> - ErlDrvTimeerl_drv_convert_time_unit(ErlDrvTime + ErlDrvTimeerl_drv_convert_time_unit(ErlDrvTime val, ErlDrvTimeUnit from, ErlDrvTimeUnit to) Convert time unit of a time value. @@ -2317,7 +2317,7 @@ r = driver_async(myPort, &myKey, myData, myFunc); ]]> - voiderl_drv_init_ack(ErlDrvPort port, + voiderl_drv_init_ack(ErlDrvPort port, ErlDrvData res) Acknowledge the start of the port. @@ -2345,7 +2345,7 @@ r = driver_async(myPort, &myKey, myData, myFunc); ]]> - ErlDrvTime + ErlDrvTime erl_drv_monotonic_time(ErlDrvTimeUnit time_unit) Get Erlang monotonic time. @@ -2414,7 +2414,7 @@ r = driver_async(myPort, &myKey, myData, myFunc); ]]> - char *erl_drv_mutex_name(ErlDrvMutex + char *erl_drv_mutex_name(ErlDrvMutex *mtx) Get name of driver mutex. @@ -2460,7 +2460,7 @@ r = driver_async(myPort, &myKey, myData, myFunc); ]]> - interl_drv_output_term(ErlDrvTermData port, + interl_drv_output_term(ErlDrvTermData port, ErlDrvTermData* term, int n) Send term data from driver to port owner. @@ -2699,7 +2699,7 @@ erl_drv_output_term(driver_mk_port(drvport), spec, sizeof(spec) / sizeof(spec[0] - char *erl_drv_rwlock_name(ErlDrvRWLock + char *erl_drv_rwlock_name(ErlDrvRWLock *rwlck) Get name of driver mutex. @@ -2819,7 +2819,7 @@ erl_drv_output_term(driver_mk_port(drvport), spec, sizeof(spec) / sizeof(spec[0] - interl_drv_send_term(ErlDrvTermData port, + interl_drv_send_term(ErlDrvTermData port, ErlDrvTermData receiver, ErlDrvTermData* term, int n) Send term data to other process than port owner process. @@ -2843,7 +2843,7 @@ erl_drv_output_term(driver_mk_port(drvport), spec, sizeof(spec) / sizeof(spec[0] - voiderl_drv_set_os_pid(ErlDrvPort port, + voiderl_drv_set_os_pid(ErlDrvPort port, ErlDrvSInt pid) Set the os_pid for the port. @@ -2962,7 +2962,7 @@ erl_drv_output_term(driver_mk_port(drvport), spec, sizeof(spec) / sizeof(spec[0] - char *erl_drv_thread_name(ErlDrvTid + char *erl_drv_thread_name(ErlDrvTid tid) Get name of driver mutex. @@ -3031,7 +3031,7 @@ erl_drv_output_term(driver_mk_port(drvport), spec, sizeof(spec) / sizeof(spec[0] - ErlDrvTimeerl_drv_time_offset(ErlDrvTimeUnit + ErlDrvTimeerl_drv_time_offset(ErlDrvTimeUnit time_unit) Get current time offset. diff --git a/erts/doc/src/erl_nif.xml b/erts/doc/src/erl_nif.xml index bbc12b0a56..53ef3675d8 100644 --- a/erts/doc/src/erl_nif.xml +++ b/erts/doc/src/erl_nif.xml @@ -998,7 +998,7 @@ typedef struct { - ErlNifEnv *enif_alloc_env() + ErlNifEnv *enif_alloc_env() Create a new environment.

Allocates a new process independent environment. The environment can @@ -1012,7 +1012,7 @@ typedef struct { - void *enif_alloc_resource(ErlNifResourceType* + void *enif_alloc_resource(ErlNifResourceType* type, unsigned size) Allocate a memory-managed resource object. @@ -1022,7 +1022,7 @@ typedef struct { - size_tenif_binary_to_term(ErlNifEnv *env, + size_tenif_binary_to_term(ErlNifEnv *env, const unsigned char* data, size_t size, ERL_NIF_TERM *term, ErlNifBinaryToTerm opts) Create a term from the external format. @@ -1047,7 +1047,7 @@ typedef struct { - voidenif_clear_env(ErlNifEnv* env) + voidenif_clear_env(ErlNifEnv* env) Clear an environment for reuse. @@ -1058,7 +1058,7 @@ typedef struct { - int + int enif_compare(ERL_NIF_TERM lhs, ERL_NIF_TERM rhs) Compare two terms. @@ -1073,7 +1073,7 @@ typedef struct { - intenif_compare_monitors(const ErlNifMonitor + intenif_compare_monitors(const ErlNifMonitor *monitor1, const ErlNifMonitor *monitor2) Compare two monitors. @@ -1088,7 +1088,7 @@ typedef struct { - void + void enif_cond_broadcast(ErlNifCond *cnd) @@ -1098,7 +1098,7 @@ typedef struct { - ErlNifCond * + ErlNifCond * enif_cond_create(char *name) @@ -1108,7 +1108,7 @@ typedef struct { - void + void enif_cond_destroy(ErlNifCond *cnd) @@ -1118,7 +1118,7 @@ typedef struct { - char* + char* enif_cond_name(ErlNifCond* cnd) @@ -1128,7 +1128,7 @@ typedef struct { - void + void enif_cond_signal(ErlNifCond *cnd) @@ -1138,7 +1138,7 @@ typedef struct { - void + void enif_cond_wait(ErlNifCond *cnd, ErlNifMutex *mtx) @@ -1149,7 +1149,7 @@ typedef struct { - int + int enif_consume_timeslice(ErlNifEnv *env, int percent) @@ -1184,7 +1184,7 @@ typedef struct { - ErlNifTimeenif_convert_time_unit(ErlNifTime + ErlNifTimeenif_convert_time_unit(ErlNifTime val, ErlNifTimeUnit from, ErlNifTimeUnit to) Convert time unit of a time value. @@ -1209,7 +1209,7 @@ typedef struct { - ERL_NIF_TERM + ERL_NIF_TERM enif_cpu_time(ErlNifEnv *) @@ -1225,8 +1225,8 @@ typedef struct { - intenif_demonitor_process(ErlNifEnv* caller_env, void* obj, - const ErlNifMonitor* mon) + intenif_demonitor_process(ErlNifEnv* caller_env, + void* obj, const ErlNifMonitor* mon) Cancel a process monitor. @@ -1252,7 +1252,7 @@ typedef struct { - int + int enif_equal_tids(ErlNifTid tid1, ErlNifTid tid2) @@ -1263,7 +1263,7 @@ typedef struct { - intenif_fprintf(FILE *stream, const char *format, ...) + intenif_fprintf(FILE *stream, const char *format, ...) Format strings and Erlang terms.

Similar to fprintf but this format string also accepts @@ -1285,7 +1285,7 @@ typedef struct { - void + void enif_free_env(ErlNifEnv* env) Free an environment allocated with enif_alloc_env. @@ -1296,7 +1296,7 @@ typedef struct { - void + void enif_free_iovec(ErlNifIOvec* iov) Free an ErlIOVec @@ -1321,7 +1321,7 @@ enif_free_iovec(iovec);]]> - intenif_get_atom(ErlNifEnv* env, ERL_NIF_TERM + intenif_get_atom(ErlNifEnv* env, ERL_NIF_TERM term, char* buf, unsigned size, ErlNifCharEncoding encode) Get the text representation of an atom term. @@ -1337,7 +1337,7 @@ enif_free_iovec(iovec);]]> - intenif_get_atom_length(ErlNifEnv* env, + intenif_get_atom_length(ErlNifEnv* env, ERL_NIF_TERM term, unsigned* len, ErlNifCharEncoding encode) Get the length of atom term. @@ -1351,7 +1351,7 @@ enif_free_iovec(iovec);]]> - intenif_get_double(ErlNifEnv* env, + intenif_get_double(ErlNifEnv* env, ERL_NIF_TERM term, double* dp) Read a floating-point number term. @@ -1373,7 +1373,7 @@ enif_free_iovec(iovec);]]> - intenif_get_int64(ErlNifEnv* env, ERL_NIF_TERM + intenif_get_int64(ErlNifEnv* env, ERL_NIF_TERM term, ErlNifSInt64* ip) Read a 64-bit integer term. @@ -1384,7 +1384,7 @@ enif_free_iovec(iovec);]]> - intenif_get_local_pid(ErlNifEnv* env, + intenif_get_local_pid(ErlNifEnv* env, ERL_NIF_TERM term, ErlNifPid* pid) Read a local pid term. @@ -1396,7 +1396,7 @@ enif_free_iovec(iovec);]]> - intenif_get_local_port(ErlNifEnv* env, + intenif_get_local_port(ErlNifEnv* env, ERL_NIF_TERM term, ErlNifPort* port_id) Read a local port term. @@ -1420,7 +1420,7 @@ enif_free_iovec(iovec);]]> - intenif_get_list_length(ErlNifEnv* env, + intenif_get_list_length(ErlNifEnv* env, ERL_NIF_TERM term, unsigned* len) Get the length of list term. @@ -1431,7 +1431,7 @@ enif_free_iovec(iovec);]]> - intenif_get_long(ErlNifEnv* env, ERL_NIF_TERM + intenif_get_long(ErlNifEnv* env, ERL_NIF_TERM term, long int* ip) Read a long integer term. @@ -1442,7 +1442,7 @@ enif_free_iovec(iovec);]]> - intenif_get_map_size(ErlNifEnv* env, + intenif_get_map_size(ErlNifEnv* env, ERL_NIF_TERM term, size_t *size) Read the size of a map term. @@ -1454,7 +1454,7 @@ enif_free_iovec(iovec);]]> - intenif_get_map_value(ErlNifEnv* env, + intenif_get_map_value(ErlNifEnv* env, ERL_NIF_TERM map, ERL_NIF_TERM key, ERL_NIF_TERM* value) Get the value of a key in a map. @@ -1467,7 +1467,7 @@ enif_free_iovec(iovec);]]> - intenif_get_resource(ErlNifEnv* env, + intenif_get_resource(ErlNifEnv* env, ERL_NIF_TERM term, ErlNifResourceType* type, void** objp) Get the pointer to a resource object. @@ -1480,7 +1480,7 @@ enif_free_iovec(iovec);]]> - intenif_get_string(ErlNifEnv* env, + intenif_get_string(ErlNifEnv* env, ERL_NIF_TERM list, char* buf, unsigned size, ErlNifCharEncoding encode) Get a C-string from a list. @@ -1504,7 +1504,7 @@ enif_free_iovec(iovec);]]> - intenif_get_tuple(ErlNifEnv* env, ERL_NIF_TERM + intenif_get_tuple(ErlNifEnv* env, ERL_NIF_TERM term, int* arity, const ERL_NIF_TERM** array) Inspect the elements of a tuple. @@ -1520,7 +1520,7 @@ enif_free_iovec(iovec);]]> - intenif_get_uint(ErlNifEnv* env, ERL_NIF_TERM + intenif_get_uint(ErlNifEnv* env, ERL_NIF_TERM term, unsigned int* ip) Read an unsigned integer term. @@ -1532,7 +1532,7 @@ enif_free_iovec(iovec);]]> - intenif_get_uint64(ErlNifEnv* env, + intenif_get_uint64(ErlNifEnv* env, ERL_NIF_TERM term, ErlNifUInt64* ip) Read an unsigned 64-bit integer term. @@ -1557,7 +1557,7 @@ enif_free_iovec(iovec);]]> - intenif_getenv(const char* key, char* value, + intenif_getenv(const char* key, char* value, size_t *value_size) Get the value of an environment variable. @@ -1567,7 +1567,7 @@ enif_free_iovec(iovec);]]> - intenif_has_pending_exception(ErlNifEnv* env, + intenif_has_pending_exception(ErlNifEnv* env, ERL_NIF_TERM* reason) Check if an exception has been raised. @@ -1588,7 +1588,7 @@ enif_free_iovec(iovec);]]> - + ErlNifUInt64 enif_hash(ErlNifHash type, ERL_NIF_TERM term, ErlNifUInt64 salt) @@ -1613,7 +1613,7 @@ enif_free_iovec(iovec);]]> - intenif_inspect_iolist_as_binary(ErlNifEnv* + intenif_inspect_iolist_as_binary(ErlNifEnv* env, ERL_NIF_TERM term, ErlNifBinary* bin) Inspect the content of an iolist. @@ -1627,7 +1627,7 @@ enif_free_iovec(iovec);]]> - intenif_inspect_iovec(ErlNifEnv* + intenif_inspect_iovec(ErlNifEnv* env, size_t max_elements, ERL_NIF_TERM iovec_term, ERL_NIF_TERM* tail, ErlNifIOVec** iovec) Inspect a list of binaries as an ErlNifIOVec. @@ -1667,7 +1667,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - ErlNifIOQueue * + ErlNifIOQueue * enif_ioq_create(ErlNifIOQueueOpts opts) Create a new IO Queue @@ -1678,7 +1678,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - void + void enif_ioq_destroy(ErlNifIOQueue *q) Destroy an IO Queue and free it's content @@ -1687,7 +1687,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - int + int enif_ioq_deq(ErlNifIOQueue *q, size_t count, size_t *size) Dequeue count bytes from the IO Queue @@ -1700,7 +1700,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - int + int enif_ioq_enq_binary(ErlNifIOQueue *q, ErlNifBinary *bin, size_t skip) Enqueue the binary into the IO Queue @@ -1713,7 +1713,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - int + int enif_ioq_enqv(ErlNifIOQueue *q, ErlNifIOVec *iovec, size_t skip) Enqueue the iovec into the IO Queue @@ -1724,7 +1724,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - SysIOVec * + SysIOVec * enif_ioq_peek(ErlNifIOQueue *q, int *iovlen) Peek inside the IO Queue @@ -1738,7 +1738,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - int + int enif_ioq_peek_head(ErlNifEnv *env, ErlNifIOQueue *q, size_t *size, ERL_NIF_TERM *bin_term) Peek the head of the IO Queue. @@ -1753,7 +1753,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - size_t + size_t enif_ioq_size(ErlNifIOQueue *q) Get the current size of the IO Queue @@ -1762,7 +1762,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - int + int enif_is_atom(ErlNifEnv* env, ERL_NIF_TERM term) Determine if a term is an atom. @@ -1782,7 +1782,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - int + int enif_is_current_process_alive(ErlNifEnv* env) Determine if currently executing process is alive. @@ -1795,7 +1795,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - intenif_is_empty_list(ErlNifEnv* env, + intenif_is_empty_list(ErlNifEnv* env, ERL_NIF_TERM term) Determine if a term is an empty list. @@ -1804,7 +1804,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - intenif_is_exception(ErlNifEnv* env, + intenif_is_exception(ErlNifEnv* env, ERL_NIF_TERM term) Determine if a term is an exception. @@ -1813,7 +1813,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - intenif_is_fun(ErlNifEnv* env, ERL_NIF_TERM + intenif_is_fun(ErlNifEnv* env, ERL_NIF_TERM term) Determine if a term is a fun. @@ -1822,7 +1822,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - intenif_is_identical(ERL_NIF_TERM lhs, + intenif_is_identical(ERL_NIF_TERM lhs, ERL_NIF_TERM rhs) Erlang operator =:=. @@ -1832,7 +1832,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - int + int enif_is_list(ErlNifEnv* env, ERL_NIF_TERM term) Determine if a term is a list. @@ -1842,7 +1842,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - intenif_is_map(ErlNifEnv* env, ERL_NIF_TERM + intenif_is_map(ErlNifEnv* env, ERL_NIF_TERM term) Determine if a term is a map. @@ -1852,7 +1852,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - intenif_is_number(ErlNifEnv* env, ERL_NIF_TERM + intenif_is_number(ErlNifEnv* env, ERL_NIF_TERM term) Determine if a term is a number (integer or float). @@ -1861,7 +1861,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - int + int enif_is_pid(ErlNifEnv* env, ERL_NIF_TERM term) Determine if a term is a pid. @@ -1871,7 +1871,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - int + int enif_is_port(ErlNifEnv* env, ERL_NIF_TERM term) Determine if a term is a port. @@ -1881,7 +1881,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - intenif_is_port_alive(ErlNifEnv* env, + intenif_is_port_alive(ErlNifEnv* env, ErlNifPort *port_id) Determine if a local port is alive. @@ -1893,7 +1893,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - intenif_is_process_alive(ErlNifEnv* env, + intenif_is_process_alive(ErlNifEnv* env, ErlNifPid *pid) Determine if a local process is alive. @@ -1905,7 +1905,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - int + int enif_is_ref(ErlNifEnv* env, ERL_NIF_TERM term) Determine if a term is a reference. @@ -1915,7 +1915,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - int + int enif_is_tuple(ErlNifEnv* env, ERL_NIF_TERM term) Determine if a term is a tuple. @@ -1925,7 +1925,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - int + int enif_keep_resource(void* obj) Add a reference to a resource object. @@ -1955,7 +1955,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - ERL_NIF_TERMenif_make_atom_len(ErlNifEnv* env, + ERL_NIF_TERMenif_make_atom_len(ErlNifEnv* env, const char* name, size_t len) Create an atom term. @@ -2010,7 +2010,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - ERL_NIF_TERMenif_make_copy(ErlNifEnv* dst_env, + ERL_NIF_TERMenif_make_copy(ErlNifEnv* dst_env, ERL_NIF_TERM src_term) Make a copy of a term. @@ -2021,7 +2021,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - ERL_NIF_TERM + ERL_NIF_TERM enif_make_double(ErlNifEnv* env, double d) Create a floating-point term. @@ -2033,7 +2033,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - intenif_make_existing_atom(ErlNifEnv* env, + intenif_make_existing_atom(ErlNifEnv* env, const char* name, ERL_NIF_TERM* atom, ErlNifCharEncoding encode) Create an existing atom term. @@ -2049,7 +2049,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - intenif_make_existing_atom_len(ErlNifEnv* env, + intenif_make_existing_atom_len(ErlNifEnv* env, const char* name, size_t len, ERL_NIF_TERM* atom, ErlNifCharEncoding encoding) Create an existing atom term. @@ -2074,7 +2074,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - ERL_NIF_TERM + ERL_NIF_TERM enif_make_int64(ErlNifEnv* env, ErlNifSInt64 i) Create an integer term. @@ -2097,24 +2097,24 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - ERL_NIF_TERM + ERL_NIF_TERM enif_make_list1(ErlNifEnv* env, ERL_NIF_TERM e1) - ERL_NIF_TERMenif_make_list2(ErlNifEnv* env, + ERL_NIF_TERMenif_make_list2(ErlNifEnv* env, ERL_NIF_TERM e1, ERL_NIF_TERM e2) - ERL_NIF_TERMenif_make_list3(ErlNifEnv* env, + ERL_NIF_TERMenif_make_list3(ErlNifEnv* env, ERL_NIF_TERM e1, ERL_NIF_TERM e2, ERL_NIF_TERM e3) - ERL_NIF_TERMenif_make_list4(ErlNifEnv* env, + ERL_NIF_TERMenif_make_list4(ErlNifEnv* env, ERL_NIF_TERM e1, ..., ERL_NIF_TERM e4) - ERL_NIF_TERMenif_make_list5(ErlNifEnv* env, + ERL_NIF_TERMenif_make_list5(ErlNifEnv* env, ERL_NIF_TERM e1, ..., ERL_NIF_TERM e5) - ERL_NIF_TERMenif_make_list6(ErlNifEnv* env, + ERL_NIF_TERMenif_make_list6(ErlNifEnv* env, ERL_NIF_TERM e1, ..., ERL_NIF_TERM e6) - ERL_NIF_TERMenif_make_list7(ErlNifEnv* env, + ERL_NIF_TERMenif_make_list7(ErlNifEnv* env, ERL_NIF_TERM e1, ..., ERL_NIF_TERM e7) - ERL_NIF_TERMenif_make_list8(ErlNifEnv* env, + ERL_NIF_TERMenif_make_list8(ErlNifEnv* env, ERL_NIF_TERM e1, ..., ERL_NIF_TERM e8) - ERL_NIF_TERMenif_make_list9(ErlNifEnv* env, + ERL_NIF_TERMenif_make_list9(ErlNifEnv* env, ERL_NIF_TERM e1, ..., ERL_NIF_TERM e9) Create a list term. @@ -2135,7 +2135,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - ERL_NIF_TERM + ERL_NIF_TERM enif_make_list_from_array(ErlNifEnv* env, const ERL_NIF_TERM arr[], unsigned cnt) Create a list term from an array. @@ -2147,7 +2147,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - ERL_NIF_TERM + ERL_NIF_TERM enif_make_long(ErlNifEnv* env, long int i) Create an integer term from a long int. @@ -2156,7 +2156,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - intenif_make_map_put(ErlNifEnv* env, + intenif_make_map_put(ErlNifEnv* env, ERL_NIF_TERM map_in, ERL_NIF_TERM key, ERL_NIF_TERM value, ERL_NIF_TERM* map_out) Insert key-value pair in map. @@ -2172,7 +2172,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - intenif_make_map_remove(ErlNifEnv* env, + intenif_make_map_remove(ErlNifEnv* env, ERL_NIF_TERM map_in, ERL_NIF_TERM key, ERL_NIF_TERM* map_out) Remove key from map. @@ -2188,7 +2188,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - intenif_make_map_update(ErlNifEnv* env, + intenif_make_map_update(ErlNifEnv* env, ERL_NIF_TERM map_in, ERL_NIF_TERM key, ERL_NIF_TERM new_value, ERL_NIF_TERM* map_out) Replace value for key in map. @@ -2203,7 +2203,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - int + int enif_make_map_from_arrays(ErlNifEnv* env, ERL_NIF_TERM keys[], ERL_NIF_TERM values[], size_t cnt, ERL_NIF_TERM *map_out) Make map term from the given keys and values. @@ -2217,7 +2217,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - unsigned char *enif_make_new_binary(ErlNifEnv* + unsigned char *enif_make_new_binary(ErlNifEnv* env, size_t size, ERL_NIF_TERM* termp) Allocate and create a new binary term. @@ -2233,7 +2233,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - ERL_NIF_TERM + ERL_NIF_TERM enif_make_new_map(ErlNifEnv* env) Make an empty map term. @@ -2242,7 +2242,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - ERL_NIF_TERM + ERL_NIF_TERM enif_make_pid(ErlNifEnv* env, const ErlNifPid* pid) Make a pid term. @@ -2252,7 +2252,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - ERL_NIF_TERM + ERL_NIF_TERM enif_make_ref(ErlNifEnv* env) Create a reference. @@ -2262,7 +2262,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - ERL_NIF_TERM + ERL_NIF_TERM enif_make_resource(ErlNifEnv* env, void* obj) Create an opaque handle to a resource object. @@ -2310,7 +2310,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - ERL_NIF_TERM + ERL_NIF_TERM enif_make_resource_binary(ErlNifEnv* env, void* obj, const void* data, size_t size) Create a custom binary term. @@ -2336,7 +2336,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - int + int enif_make_reverse_list(ErlNifEnv* env, ERL_NIF_TERM list_in, ERL_NIF_TERM *list_out) Create the reverse of a list. @@ -2363,7 +2363,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - ERL_NIF_TERMenif_make_string_len(ErlNifEnv* + ERL_NIF_TERMenif_make_string_len(ErlNifEnv* env, const char* string, size_t len, ErlNifCharEncoding encoding) Create a string. @@ -2376,7 +2376,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - ERL_NIF_TERMenif_make_sub_binary(ErlNifEnv* + ERL_NIF_TERMenif_make_sub_binary(ErlNifEnv* env, ERL_NIF_TERM bin_term, size_t pos, size_t size) Make a subbinary term. @@ -2399,23 +2399,23 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - ERL_NIF_TERMenif_make_tuple1(ErlNifEnv* env, + ERL_NIF_TERMenif_make_tuple1(ErlNifEnv* env, ERL_NIF_TERM e1) - ERL_NIF_TERMenif_make_tuple2(ErlNifEnv* env, + ERL_NIF_TERMenif_make_tuple2(ErlNifEnv* env, ERL_NIF_TERM e1, ERL_NIF_TERM e2) - ERL_NIF_TERMenif_make_tuple3(ErlNifEnv* env, + ERL_NIF_TERMenif_make_tuple3(ErlNifEnv* env, ERL_NIF_TERM e1, ERL_NIF_TERM e2, ERL_NIF_TERM e3) - ERL_NIF_TERMenif_make_tuple4(ErlNifEnv* env, + ERL_NIF_TERMenif_make_tuple4(ErlNifEnv* env, ERL_NIF_TERM e1, ..., ERL_NIF_TERM e4) - ERL_NIF_TERMenif_make_tuple5(ErlNifEnv* env, + ERL_NIF_TERMenif_make_tuple5(ErlNifEnv* env, ERL_NIF_TERM e1, ..., ERL_NIF_TERM e5) - ERL_NIF_TERMenif_make_tuple6(ErlNifEnv* env, + ERL_NIF_TERMenif_make_tuple6(ErlNifEnv* env, ERL_NIF_TERM e1, ..., ERL_NIF_TERM e6) - ERL_NIF_TERMenif_make_tuple7(ErlNifEnv* env, + ERL_NIF_TERMenif_make_tuple7(ErlNifEnv* env, ERL_NIF_TERM e1, ..., ERL_NIF_TERM e7) - ERL_NIF_TERMenif_make_tuple8(ErlNifEnv* env, + ERL_NIF_TERMenif_make_tuple8(ErlNifEnv* env, ERL_NIF_TERM e1, ..., ERL_NIF_TERM e8) - ERL_NIF_TERMenif_make_tuple9(ErlNifEnv* env, + ERL_NIF_TERMenif_make_tuple9(ErlNifEnv* env, ERL_NIF_TERM e1, ..., ERL_NIF_TERM e9) Create a tuple term. @@ -2427,7 +2427,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - ERL_NIF_TERM + ERL_NIF_TERM enif_make_tuple_from_array(ErlNifEnv* env, const ERL_NIF_TERM arr[], unsigned cnt) Create a tuple term from an array. @@ -2438,7 +2438,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - ERL_NIF_TERM + ERL_NIF_TERM enif_make_uint(ErlNifEnv* env, unsigned int i) Create an unsigned integer term. @@ -2448,7 +2448,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - ERL_NIF_TERM + ERL_NIF_TERM enif_make_uint64(ErlNifEnv* env, ErlNifUInt64 i) Create an unsigned integer term. @@ -2468,7 +2468,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - ERL_NIF_TERMenif_make_unique_integer(ErlNifEnv + ERL_NIF_TERMenif_make_unique_integer(ErlNifEnv *env, ErlNifUniqueInteger properties) @@ -2486,7 +2486,7 @@ enif_inspect_iovec(env, max_elements, term, &tail, &iovec); - intenif_map_iterator_create(ErlNifEnv *env, + intenif_map_iterator_create(ErlNifEnv *env, ERL_NIF_TERM map, ErlNifMapIterator *iter, ErlNifMapIteratorEntry entry) Create a map iterator. @@ -2521,7 +2521,7 @@ enif_map_iterator_destroy(env, &iter); - voidenif_map_iterator_destroy(ErlNifEnv *env, + voidenif_map_iterator_destroy(ErlNifEnv *env, ErlNifMapIterator *iter) Destroy a map iterator. @@ -2532,7 +2532,7 @@ enif_map_iterator_destroy(env, &iter); - intenif_map_iterator_get_pair(ErlNifEnv *env, + intenif_map_iterator_get_pair(ErlNifEnv *env, ErlNifMapIterator *iter, ERL_NIF_TERM *key, ERL_NIF_TERM *value) Get key and value at current map iterator position. @@ -2545,7 +2545,7 @@ enif_map_iterator_destroy(env, &iter); - intenif_map_iterator_is_head(ErlNifEnv *env, + intenif_map_iterator_is_head(ErlNifEnv *env, ErlNifMapIterator *iter) Check if map iterator is positioned before first. @@ -2555,7 +2555,7 @@ enif_map_iterator_destroy(env, &iter); - intenif_map_iterator_is_tail(ErlNifEnv *env, + intenif_map_iterator_is_tail(ErlNifEnv *env, ErlNifMapIterator *iter) Check if map iterator is positioned after last. @@ -2565,7 +2565,7 @@ enif_map_iterator_destroy(env, &iter); - intenif_map_iterator_next(ErlNifEnv *env, + intenif_map_iterator_next(ErlNifEnv *env, ErlNifMapIterator *iter) Increment map iterator to point to next entry. @@ -2577,7 +2577,7 @@ enif_map_iterator_destroy(env, &iter); - intenif_map_iterator_prev(ErlNifEnv *env, + intenif_map_iterator_prev(ErlNifEnv *env, ErlNifMapIterator *iter) Decrement map iterator to point to previous entry. @@ -2589,8 +2589,8 @@ enif_map_iterator_destroy(env, &iter); - intenif_monitor_process(ErlNifEnv* caller_env, void* obj, - const ErlNifPid* target_pid, ErlNifMonitor* mon) + intenif_monitor_process(ErlNifEnv* caller_env, + void* obj, const ErlNifPid* target_pid, ErlNifMonitor* mon) Monitor a process from a resource. @@ -2621,7 +2621,7 @@ enif_map_iterator_destroy(env, &iter); - ErlNifTime + ErlNifTime enif_monotonic_time(ErlNifTimeUnit time_unit) Get Erlang monotonic time. @@ -2642,7 +2642,7 @@ enif_map_iterator_destroy(env, &iter); - ErlNifMutex * + ErlNifMutex * enif_mutex_create(char *name) @@ -2652,7 +2652,7 @@ enif_map_iterator_destroy(env, &iter); - void + void enif_mutex_destroy(ErlNifMutex *mtx) @@ -2662,7 +2662,7 @@ enif_map_iterator_destroy(env, &iter); - void + void enif_mutex_lock(ErlNifMutex *mtx) @@ -2672,7 +2672,7 @@ enif_map_iterator_destroy(env, &iter); - char* + char* enif_mutex_name(ErlNifMutex* mtx) @@ -2682,7 +2682,7 @@ enif_map_iterator_destroy(env, &iter); - int + int enif_mutex_trylock(ErlNifMutex *mtx) @@ -2692,7 +2692,7 @@ enif_map_iterator_destroy(env, &iter); - void + void enif_mutex_unlock(ErlNifMutex *mtx) @@ -2702,7 +2702,7 @@ enif_map_iterator_destroy(env, &iter); - ERL_NIF_TERM + ERL_NIF_TERM enif_now_time(ErlNifEnv *env) @@ -2713,7 +2713,7 @@ enif_map_iterator_destroy(env, &iter); - ErlNifResourceType * + ErlNifResourceType * enif_open_resource_type(ErlNifEnv* env, const char* module_str, const char* name, ErlNifResourceDtor* dtor, ErlNifResourceFlags flags, ErlNifResourceFlags* tried) @@ -2752,7 +2752,7 @@ enif_map_iterator_destroy(env, &iter); - ErlNifResourceType * + ErlNifResourceType * enif_open_resource_type_x(ErlNifEnv* env, const char* name, const ErlNifResourceTypeInit* init, ErlNifResourceFlags flags, ErlNifResourceFlags* tried) @@ -2771,7 +2771,7 @@ enif_map_iterator_destroy(env, &iter); - intenif_port_command(ErlNifEnv* env, const + intenif_port_command(ErlNifEnv* env, const ErlNifPort* to_port, ErlNifEnv *msg_env, ERL_NIF_TERM msg) Send a port_command to to_port. @@ -2814,7 +2814,7 @@ enif_map_iterator_destroy(env, &iter); - void * + void * enif_priv_data(ErlNifEnv* env) Get the private data of a NIF library. @@ -2825,7 +2825,7 @@ enif_map_iterator_destroy(env, &iter); - ERL_NIF_TERMenif_raise_exception(ErlNifEnv* + ERL_NIF_TERMenif_raise_exception(ErlNifEnv* env, ERL_NIF_TERM reason) Raise a NIF error exception. @@ -2848,7 +2848,7 @@ enif_map_iterator_destroy(env, &iter); - void * + void * enif_realloc(void* ptr, size_t size) Reallocate dynamic memory. @@ -2862,7 +2862,7 @@ enif_map_iterator_destroy(env, &iter); - int + int enif_realloc_binary(ErlNifBinary* bin, size_t size) Change the size of a binary. @@ -2887,7 +2887,7 @@ enif_map_iterator_destroy(env, &iter); - void + void enif_release_resource(void* obj) Release a resource object. @@ -2906,7 +2906,7 @@ enif_map_iterator_destroy(env, &iter); - ErlNifRWLock * + ErlNifRWLock * enif_rwlock_create(char *name) @@ -2916,7 +2916,7 @@ enif_map_iterator_destroy(env, &iter); - void + void enif_rwlock_destroy(ErlNifRWLock *rwlck) @@ -2926,7 +2926,7 @@ enif_map_iterator_destroy(env, &iter); - char* + char* enif_rwlock_name(ErlNifRWLock* rwlck) @@ -2936,7 +2936,7 @@ enif_map_iterator_destroy(env, &iter); - void + void enif_rwlock_rlock(ErlNifRWLock *rwlck) @@ -2946,7 +2946,7 @@ enif_map_iterator_destroy(env, &iter); - void + void enif_rwlock_runlock(ErlNifRWLock *rwlck) @@ -2956,7 +2956,7 @@ enif_map_iterator_destroy(env, &iter); - void + void enif_rwlock_rwlock(ErlNifRWLock *rwlck) @@ -2966,7 +2966,7 @@ enif_map_iterator_destroy(env, &iter); - void + void enif_rwlock_rwunlock(ErlNifRWLock *rwlck) @@ -2976,7 +2976,7 @@ enif_map_iterator_destroy(env, &iter); - int + int enif_rwlock_tryrlock(ErlNifRWLock *rwlck) @@ -2986,7 +2986,7 @@ enif_map_iterator_destroy(env, &iter); - int + int enif_rwlock_tryrwlock(ErlNifRWLock *rwlck) @@ -2996,7 +2996,7 @@ enif_map_iterator_destroy(env, &iter); - ERL_NIF_TERMenif_schedule_nif(ErlNifEnv* env, + ERL_NIF_TERMenif_schedule_nif(ErlNifEnv* env, const char* fun_name, int flags, ERL_NIF_TERM (*fp)(ErlNifEnv* env, int argc, const ERL_NIF_TERM argv[]), int argc, const ERL_NIF_TERM argv[]) @@ -3041,7 +3041,7 @@ enif_map_iterator_destroy(env, &iter); - int + int enif_select(ErlNifEnv* env, ErlNifEvent event, enum ErlNifSelectFlags mode, void* obj, const ErlNifPid* pid, ERL_NIF_TERM ref) @@ -3135,7 +3135,7 @@ if (retval & ERL_NIF_SELECT_STOP_CALLED) { - ErlNifPid * + ErlNifPid * enif_self(ErlNifEnv* caller_env, ErlNifPid* pid) Get the pid of the calling process. @@ -3148,8 +3148,8 @@ if (retval & ERL_NIF_SELECT_STOP_CALLED) { - intenif_send(ErlNifEnv* caller_env, ErlNifPid* to_pid, - ErlNifEnv* msg_env, ERL_NIF_TERM msg) + intenif_send(ErlNifEnv* caller_env, + ErlNifPid* to_pid, ErlNifEnv* msg_env, ERL_NIF_TERM msg) Send a message to a process.

Sends a message to a process.

@@ -3195,7 +3195,7 @@ if (retval & ERL_NIF_SELECT_STOP_CALLED) { - unsigned + unsigned enif_sizeof_resource(void* obj) Get the byte size of a resource object. @@ -3206,7 +3206,7 @@ if (retval & ERL_NIF_SELECT_STOP_CALLED) { - intenif_snprintf(char *str, size_t size, const + intenif_snprintf(char *str, size_t size, const char *format, ...) Format strings and Erlang terms. @@ -3220,7 +3220,7 @@ if (retval & ERL_NIF_SELECT_STOP_CALLED) { - voidenif_system_info(ErlNifSysInfo + voidenif_system_info(ErlNifSysInfo *sys_info_ptr, size_t size) Get information about the Erlang runtime system. @@ -3230,7 +3230,7 @@ if (retval & ERL_NIF_SELECT_STOP_CALLED) { - intenif_term_to_binary(ErlNifEnv *env, + intenif_term_to_binary(ErlNifEnv *env, ERL_NIF_TERM term, ErlNifBinary *bin) Convert a term to the external format. @@ -3247,7 +3247,7 @@ if (retval & ERL_NIF_SELECT_STOP_CALLED) { - int + int enif_thread_create(char *name,ErlNifTid *tid,void * (*func)(void *),void *args,ErlNifThreadOpts *opts) @@ -3259,7 +3259,7 @@ if (retval & ERL_NIF_SELECT_STOP_CALLED) { - void + void enif_thread_exit(void *resp) @@ -3269,7 +3269,7 @@ if (retval & ERL_NIF_SELECT_STOP_CALLED) { - int + int enif_thread_join(ErlNifTid, void **respp) @@ -3279,7 +3279,7 @@ if (retval & ERL_NIF_SELECT_STOP_CALLED) { - char* + char* enif_thread_name(ErlNifTid tid) Thread name @@ -3289,7 +3289,7 @@ if (retval & ERL_NIF_SELECT_STOP_CALLED) { - ErlNifThreadOpts * + ErlNifThreadOpts * enif_thread_opts_create(char *name) @@ -3299,7 +3299,7 @@ if (retval & ERL_NIF_SELECT_STOP_CALLED) { - void + void enif_thread_opts_destroy(ErlNifThreadOpts *opts) @@ -3310,7 +3310,7 @@ if (retval & ERL_NIF_SELECT_STOP_CALLED) { - ErlNifTid + ErlNifTid enif_thread_self(void) @@ -3320,7 +3320,7 @@ if (retval & ERL_NIF_SELECT_STOP_CALLED) { - int + int enif_thread_type(void) Determine type of current thread @@ -3342,7 +3342,7 @@ if (retval & ERL_NIF_SELECT_STOP_CALLED) { - ErlNifTime + ErlNifTime enif_time_offset(ErlNifTimeUnit time_unit) Get current time offset. @@ -3364,7 +3364,7 @@ if (retval & ERL_NIF_SELECT_STOP_CALLED) { - void * + void * enif_tsd_get(ErlNifTSDKey key) @@ -3374,7 +3374,7 @@ if (retval & ERL_NIF_SELECT_STOP_CALLED) { - int + int enif_tsd_key_create(char *name, ErlNifTSDKey *key) @@ -3385,7 +3385,7 @@ if (retval & ERL_NIF_SELECT_STOP_CALLED) { - void + void enif_tsd_key_destroy(ErlNifTSDKey key) @@ -3395,7 +3395,7 @@ if (retval & ERL_NIF_SELECT_STOP_CALLED) { - void + void enif_tsd_set(ErlNifTSDKey key, void *data) @@ -3405,7 +3405,7 @@ if (retval & ERL_NIF_SELECT_STOP_CALLED) { - int + int enif_vfprintf(FILE *stream, const char *format, va_list ap) Format strings and Erlang terms. @@ -3417,7 +3417,7 @@ if (retval & ERL_NIF_SELECT_STOP_CALLED) { - int + int enif_vsnprintf(char *str, size_t size, const char *format, va_list ap) Format strings and Erlang terms. @@ -3429,7 +3429,7 @@ if (retval & ERL_NIF_SELECT_STOP_CALLED) { - int + int enif_whereis_pid(ErlNifEnv *env, ERL_NIF_TERM name, ErlNifPid *pid) Looks up a process by its registered name. @@ -3457,7 +3457,7 @@ if (retval & ERL_NIF_SELECT_STOP_CALLED) { - int + int enif_whereis_port(ErlNifEnv *env, ERL_NIF_TERM name, ErlNifPort *port) Looks up a port by its registered name. diff --git a/erts/doc/src/erl_prim_loader.xml b/erts/doc/src/erl_prim_loader.xml index 286bac6c93..560510e9ad 100644 --- a/erts/doc/src/erl_prim_loader.xml +++ b/erts/doc/src/erl_prim_loader.xml @@ -114,7 +114,7 @@ - + Get information about a link or file.

Works like diff --git a/erts/doc/src/erl_tracer.xml b/erts/doc/src/erl_tracer.xml index fd3c17f337..fa4717bc2f 100644 --- a/erts/doc/src/erl_tracer.xml +++ b/erts/doc/src/erl_tracer.xml @@ -28,7 +28,7 @@ - erl_tracer + erl_tracer Erlang tracer behavior.

This behavior module implements the back end of the Erlang @@ -195,7 +195,7 @@ - Module:enabled(TraceTag, TracerState, Tracee) -> Result + Module:enabled(TraceTag, TracerState, Tracee) -> Result Check if a trace event is to be generated. TraceTag = @@ -224,7 +224,7 @@ - Module:enabled_call(TraceTag, TracerState, Tracee) -> Result + Module:enabled_call(TraceTag, TracerState, Tracee) -> Result Check if a trace event is to be generated. TraceTag = @@ -244,7 +244,7 @@ - Module:enabled_garbage_collection(TraceTag, TracerState, Tracee) -> Result + Module:enabled_garbage_collection(TraceTag, TracerState, Tracee) -> Result Check if a trace event is to be generated. TraceTag = @@ -264,7 +264,7 @@ - Module:enabled_ports(TraceTag, TracerState, Tracee) -> Result + Module:enabled_ports(TraceTag, TracerState, Tracee) -> Result Check if a trace event is to be generated. TraceTag = @@ -284,7 +284,7 @@ - Module:enabled_procs(TraceTag, TracerState, Tracee) -> Result + Module:enabled_procs(TraceTag, TracerState, Tracee) -> Result Check if a trace event is to be generated. TraceTag = @@ -304,7 +304,7 @@ - Module:enabled_receive(TraceTag, TracerState, Tracee) -> Result + Module:enabled_receive(TraceTag, TracerState, Tracee) -> Result Check if a trace event is to be generated. @@ -325,7 +325,7 @@ - Module:enabled_running_ports(TraceTag, TracerState, Tracee) -> + Module:enabled_running_ports(TraceTag, TracerState, Tracee) -> Result Check if a trace event is to be generated. @@ -346,7 +346,7 @@ - Module:enabled_running_procs(TraceTag, TracerState, Tracee) -> + Module:enabled_running_procs(TraceTag, TracerState, Tracee) -> Result Check if a trace event is to be generated. @@ -368,7 +368,7 @@ - Module:enabled_send(TraceTag, TracerState, Tracee) -> Result + Module:enabled_send(TraceTag, TracerState, Tracee) -> Result Check if a trace event is to be generated. TraceTag = @@ -388,7 +388,7 @@ - Module:trace(TraceTag, TracerState, Tracee, TraceTerm, + Module:trace(TraceTag, TracerState, Tracee, TraceTerm, Opts) -> Result Check if a trace event is to be generated. @@ -417,7 +417,7 @@ - Module:trace(seq_trace, TracerState, Label, + Module:trace(seq_trace, TracerState, Label, SeqTraceInfo, Opts) -> Result Check if a sequence trace event is to be generated. @@ -439,7 +439,7 @@ - Module:trace_call(TraceTag, TracerState, Tracee, TraceTerm, + Module:trace_call(TraceTag, TracerState, Tracee, TraceTerm, Opts) -> Result Check if a trace event is to be generated. @@ -463,7 +463,7 @@ - Module:trace_garbage_collection(TraceTag, TracerState, Tracee, + Module:trace_garbage_collection(TraceTag, TracerState, Tracee, TraceTerm, Opts) -> Result Check if a trace event is to be generated. @@ -487,7 +487,7 @@ - Module:trace_ports(TraceTag, TracerState, Tracee, TraceTerm, + Module:trace_ports(TraceTag, TracerState, Tracee, TraceTerm, Opts) -> Result Check if a trace event is to be generated. @@ -511,7 +511,7 @@ - Module:trace_procs(TraceTag, TracerState, Tracee, TraceTerm, + Module:trace_procs(TraceTag, TracerState, Tracee, TraceTerm, Opts) -> Result Check if a trace event is to be generated. @@ -535,7 +535,7 @@ - Module:trace_receive(TraceTag, TracerState, Tracee, TraceTerm, + Module:trace_receive(TraceTag, TracerState, Tracee, TraceTerm, Opts) -> Result Check if a trace event is to be generated. @@ -559,7 +559,7 @@ - Module:trace_running_ports(TraceTag, TracerState, Tracee, + Module:trace_running_ports(TraceTag, TracerState, Tracee, TraceTerm, Opts) -> Result Check if a trace event is to be generated. @@ -583,7 +583,7 @@ - Module:trace_running_procs(TraceTag, TracerState, Tracee, + Module:trace_running_procs(TraceTag, TracerState, Tracee, TraceTerm, Opts) -> Result Check if a trace event is to be generated. @@ -607,7 +607,7 @@ - Module:trace_send(TraceTag, TracerState, Tracee, TraceTerm, + Module:trace_send(TraceTag, TracerState, Tracee, TraceTerm, Opts) -> Result Check if a trace event is to be generated. diff --git a/erts/doc/src/erlang.xml b/erts/doc/src/erlang.xml index 8e014c3010..e498825ba4 100644 --- a/erts/doc/src/erlang.xml +++ b/erts/doc/src/erlang.xml @@ -374,7 +374,7 @@ Z = erlang:adler32_combine(X,Y,iolist_size(Data2)). - + Extract a part of a binary.

Extracts the part of the binary described by @@ -399,7 +399,7 @@ Z = erlang:adler32_combine(X,Y,iolist_size(Data2)). - + Extract a part of a binary.

The same as binary_part(Subject, @@ -459,7 +459,7 @@ Z = erlang:adler32_combine(X,Y,iolist_size(Data2)). - + Convert from text representation to a float.

Returns the float whose text representation is @@ -473,7 +473,7 @@ Z = erlang:adler32_combine(X,Y,iolist_size(Data2)). - + Convert from text representation to an integer.

Returns an integer whose text representation is @@ -487,7 +487,7 @@ Z = erlang:adler32_combine(X,Y,iolist_size(Data2)). - + Convert from text representation to an integer.

Returns an integer whose text representation in base @@ -559,7 +559,7 @@ hello - + Decode an Erlang external term format binary.

As binary_to_term/1, but takes these options:

@@ -684,7 +684,7 @@ hello - + Cancel a timer.

Cancels a timer that has been created by @@ -766,7 +766,7 @@ hello - + Returns the smallest integer not less than the argument

Returns the smallest integer not less than @@ -779,7 +779,7 @@ hello - + Check if a module has old code.

Returns true if Module has old code, @@ -801,7 +801,7 @@ hello - + Check if a process executes old code for a module.

Checks if the node local process identified by @@ -904,7 +904,7 @@ hello - + Convert time unit of a time value.

Converts the Time value of time unit @@ -1090,7 +1090,7 @@ Z = erlang:crc32_combine(X,Y,iolist_size(Data2)). - + Delete element at index in a tuple. 1..tuple_size(Tuple1) @@ -1257,7 +1257,7 @@ end - + Get distribution channel data to pass to another node.

@@ -1290,7 +1290,7 @@ end - + Request notification about available outgoing distribution channel data.

@@ -1326,7 +1326,7 @@ end - + Register distribution channel input handler process.

@@ -1359,7 +1359,7 @@ end - + Pass data into the VM from a distribution channel.

@@ -1531,7 +1531,7 @@ b - + Calculate the maximum size for a term encoded in the Erlang external term format. @@ -1550,7 +1550,7 @@ erlang:external_size(Term, []) - + Calculate the maximum size for a term encoded in the Erlang external term format. @@ -1592,7 +1592,7 @@ true - + Text representation of a float.

The same as @@ -1601,7 +1601,7 @@ true - + Text representation of a float formatted using specified options. @@ -1628,7 +1628,7 @@ true - + Text representation of a float formatted using specified options. @@ -1664,7 +1664,7 @@ true - + Returns the largest integer not greater than the argument

Returns the largest integer not greater than @@ -1850,7 +1850,7 @@ true - + Garbage collect a process.

Garbage collects the node local process identified by @@ -1955,7 +1955,7 @@ true - + Return a list of all keys from the process dictionary. @@ -2117,7 +2117,7 @@ os_prompt% - + Halt the Erlang runtime system.

Status must be a non-negative integer, a string, @@ -2215,7 +2215,7 @@ os_prompt% - + Insert an element at index in a tuple. 1..tuple_size(Tuple1) + 1 @@ -2233,7 +2233,7 @@ os_prompt% - + Text representation of an integer.

Returns a binary corresponding to the text @@ -2245,7 +2245,7 @@ os_prompt% - + Text representation of an integer.

Returns a binary corresponding to the text @@ -2314,7 +2314,7 @@ os_prompt% - + Converts an iolist to a iovec.

Returns an iovec that is made from the integers and binaries in @@ -2438,7 +2438,7 @@ os_prompt% - + Check whether a term is a map.

Returns true if Term is a map, @@ -2448,7 +2448,7 @@ os_prompt% - +

Returns true if map Map contains @@ -2750,7 +2750,7 @@ false - + Convert from text representation to a port.

Returns a port identifier whose text representation is a @@ -2768,7 +2768,7 @@ false - + Convert from text representation to a ref.

Returns a reference whose text representation is a @@ -3001,7 +3001,7 @@ false - + Extract a value from a map

Returns value Value associated with @@ -3020,7 +3020,7 @@ false - + Return the size of a map.

Returns an integer, which is the number of key-value pairs @@ -3033,7 +3033,7 @@ false - + Test that a match specification works.

Tests a match specification used in calls to @@ -3562,7 +3562,7 @@ RealSystem = system + MissedSystem - + Current Erlang monotonic time.

Returns the current @@ -3596,7 +3596,7 @@ RealSystem = system + MissedSystem - + Current Erlang monotonic time.

Returns the current @@ -3614,7 +3614,7 @@ RealSystem = system + MissedSystem - + Stop execution with a specified reason.

Works exactly like @@ -3627,7 +3627,7 @@ RealSystem = system + MissedSystem - + Stop execution with a specified reason.

Works exactly like @@ -5560,7 +5560,7 @@ RealSystem = system + MissedSystem - + Read the state of a timer.

Reads the state of a timer that has been created by either @@ -5801,7 +5801,7 @@ true - + Start a timer.

Starts a timer. When the timer expires, the message @@ -6340,7 +6340,7 @@ true - + Start a timer.

Starts a timer. When the timer expires, the message @@ -9363,7 +9363,7 @@ ok - + Current Erlang system time.

Returns current @@ -9385,7 +9385,7 @@ ok - + Current Erlang system time.

Returns current @@ -9527,7 +9527,7 @@ hello - + Current time offset.

Returns the current time offset between @@ -9559,7 +9559,7 @@ hello - + Current time offset.

Returns the current time offset between @@ -9578,7 +9578,7 @@ hello - + Current Erlang System time. @@ -10870,7 +10870,7 @@ timestamp() -> - + Get a unique integer value.

Generates and returns an @@ -10883,7 +10883,7 @@ timestamp() -> - + Get a unique integer value.

Generates and returns an diff --git a/erts/doc/src/persistent_term.xml b/erts/doc/src/persistent_term.xml index 29a6c67051..1eda7f8d76 100644 --- a/erts/doc/src/persistent_term.xml +++ b/erts/doc/src/persistent_term.xml @@ -29,7 +29,7 @@ persistent_term.xml - persistent_term + persistent_term Persistent terms.

This module is similar to - + Erase the name for a persistent term.

Erase the name for the persistent term with key @@ -229,7 +229,7 @@ will be slower as the number of persistent terms increases. - + Get all persistent terms.

Retrieve the keys and values for all persistent terms. @@ -239,7 +239,7 @@ will be slower as the number of persistent terms increases. - + Get the value for a persistent term.

Retrieve the value for the persistent term associated with @@ -256,7 +256,7 @@ will be slower as the number of persistent terms increases. - + Get information about persistent terms.

Return information about persistent terms in a map. The map @@ -272,7 +272,7 @@ will be slower as the number of persistent terms increases. - + Store a term.

Store the value Value as a persistent term and diff --git a/erts/doc/src/zlib.xml b/erts/doc/src/zlib.xml index 6f4c42da27..c8f164933c 100644 --- a/erts/doc/src/zlib.xml +++ b/erts/doc/src/zlib.xml @@ -502,7 +502,7 @@ list_to_binary([B1,B2]) - + Decompress data.

Decompresses as much data as possible. It can introduce some output @@ -524,7 +524,7 @@ list_to_binary([B1,B2]) - + Read next uncompressed chunk. @@ -540,7 +540,7 @@ list_to_binary([B1,B2]) - + Decompress data with limited output size. @@ -595,7 +595,7 @@ loop(Z, Handler, Uncompressed) -> - + Return the decompression dictionary.

Returns the decompression dictionary currently in use @@ -696,7 +696,7 @@ new_unpack(Z, Compressed, Dict) -> - + Decompress data with limited output size.

Like inflate/2, @@ -745,7 +745,7 @@ loop(Z, Handler, {finished, Output}) -> - + Transfers ownership of a zlib stream.

Changes the controlling process of Z to 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