From 5de2c218a397d4243cdb0ec08cf300b2c12bf1aa Mon Sep 17 00:00:00 2001 From: Hans Bolinder Date: Wed, 14 Oct 2015 13:56:12 +0200 Subject: [eunit] Correct documentation Fix mistakes found by 'xmllint'. --- lib/eunit/doc/overview.edoc | 2 -- 1 file changed, 2 deletions(-) (limited to 'lib') diff --git a/lib/eunit/doc/overview.edoc b/lib/eunit/doc/overview.edoc index 2789a05792..12ea02f442 100644 --- a/lib/eunit/doc/overview.edoc +++ b/lib/eunit/doc/overview.edoc @@ -907,7 +907,6 @@ the test set is finished, regardless of the outcome (success, failures, timeouts, etc.). To make the descriptions simpler, we first list some definitions: -
@@ -928,7 +927,6 @@ To make the descriptions simpler, we first list some definitions:
`Setup'`() -> (R::any())'`Where'`local | spawn | {spawn, Node::atom()}'
-
(these are explained in more detail further below.) The following representations specify fixture handling for test sets: -- cgit v1.2.3 From 7e6fc9adad9ceeda10b10f7b140702f097e5e6e4 Mon Sep 17 00:00:00 2001 From: Hans Bolinder Date: Tue, 13 Oct 2015 14:02:27 +0200 Subject: [snmp] Correct documentation Fix mistakes found by 'xmllint'. --- lib/snmp/doc/src/snmp_agent_netif.xml | 3 +- lib/snmp/doc/src/snmp_app.xml | 276 +++++++++++++++---------------- lib/snmp/doc/src/snmp_config.xml | 280 ++++++++++++++++---------------- lib/snmp/doc/src/snmp_manager_netif.xml | 3 +- lib/snmp/doc/src/snmpa.xml | 4 +- lib/snmp/doc/src/snmpm.xml | 8 +- 6 files changed, 288 insertions(+), 286 deletions(-) (limited to 'lib') diff --git a/lib/snmp/doc/src/snmp_agent_netif.xml b/lib/snmp/doc/src/snmp_agent_netif.xml index 769fd23115..9583f1f521 100644 --- a/lib/snmp/doc/src/snmp_agent_netif.xml +++ b/lib/snmp/doc/src/snmp_agent_netif.xml @@ -76,8 +76,7 @@ {Domain, Addr} tuple where Domain is transportDomainUdpIpv4 or transportDomainUdpIpv4, and Addr is an - {IpAddr, - IpPort} tuple.

+ {IpAddr,IpPort} tuple.

diff --git a/lib/snmp/doc/src/snmp_app.xml b/lib/snmp/doc/src/snmp_app.xml index 234a076eda..39aac8e7d7 100644 --- a/lib/snmp/doc/src/snmp_app.xml +++ b/lib/snmp/doc/src/snmp_app.xml @@ -135,16 +135,16 @@

Agent specific config options and types:

- - ]]> + + ]]>

If master, one master agent is started. Otherwise, no agents are started.

Default is master.

 - - ]]> + + ]]>

agent_discovery_opt() = {terminating, agent_terminating_discovery_opts()} | @@ -156,8 +156,8 @@

For defaults see the options in agent_discovery_opt().

 - - ]]> + + ]]>

agent_terminating_discovery_opt() = {enable, boolean()} | @@ -174,8 +174,8 @@ - - ]]> + + ]]>

agent_originating_discovery_opt() = {enable, boolean()}

@@ -188,38 +188,39 @@ - - ]]> + + ]]>

If true, the agent is multi-threaded, with one thread for each get request.

Default is false.

 - - ]]> + + ]]>

Defines where the SNMP agent internal db files are stored.

 - - ]]> + + + ]]>

Defines the maximum number of varbinds allowed in a Get-BULK response.

Default is 1000.

 - - ]]> + + ]]>

local_db_opt() = {repair, agent_repair()} | {auto_save, agent_auto_save()} | {verbosity, verbosity()}

Defines options specific for the SNMP agent local database.

For defaults see the options in local_db_opt().

 - - ]]> + + ]]>

When starting snmpa_local_db it always tries to open an existing database. If false, and some errors occur, a new @@ -229,16 +230,16 @@

Default is true.

 - - ]]> + + ]]>

The auto save interval. The table is flushed to disk whenever not accessed for this amount of time.

Default is 5000.

 - - ]]> + + ]]>

agent_net_if_opt() = {module, agent_net_if_module()} | {verbosity, verbosity()} | {options, agent_net_if_options()}

Defines options specific for the SNMP agent network interface @@ -246,8 +247,8 @@

For defaults see the options in agent_net_if_opt().

 - - ]]> + + ]]>

Module which handles the network interface part for the SNMP agent. Must implement the @@ -255,8 +256,8 @@

Default is snmpa_net_if.

 - - ]]> + + ]]>

agent_net_if_option() = {bind_to, bind_to()} | {sndbuf, sndbuf()} | @@ -270,15 +271,15 @@

For defaults see the options in agent_net_if_option().

 - - ]]> + + ]]>

Max number of simultaneous requests handled by the agent.

Default is infinity.

 - - ]]> + + ]]>

agent_net_if_filter_option() = {module, agent_net_if_filter_module()}

These options are actually specific to the used module. @@ -288,8 +289,8 @@ agent_net_if_filter_option().

 - - ]]> + + ]]>

Module which handles the network interface filter part for the SNMP agent. Must implement the @@ -297,8 +298,8 @@

Default is snmpa_net_if_filter.

 - - ]]> + + ]]>

Specifies a list of MIBs (including path) that defines which MIBs are initially loaded into the SNMP master agent.

@@ -312,8 +313,8 @@

Default is [].

 - - ]]> + + ]]>

mib_storage_opt() = {module, mib_storage_module()} | {options, mib_storage_options()}

This option specifies how basic mib data is stored. @@ -322,8 +323,8 @@

Default is [{module, snmpa_mib_storage_ets}].

- - + +

Defines the mib storage module of the SNMP agent as defined by the snmpa_mib_storage @@ -337,8 +338,8 @@

Default module is snmpa_mib_storage_ets.

- - ]]> + + ]]>

This is implementattion depended. That is, it depends on the module. For each module a specific set of options are valid. @@ -427,16 +428,16 @@ - - ]]> + + ]]>

mib_server_opt() = {mibentry_override, mibentry_override()} | {trapentry_override, trapentry_override()} | {verbosity, verbosity()} | {cache, mibs_cache()} | {data_module, mib_server_data_module()}

Defines options specific for the SNMP agent mib server.

For defaults see the options in mib_server_opt().

 - - ]]> + + ]]>

If this value is false, then when loading a mib each mib- entry is checked prior to installation of the mib. @@ -445,8 +446,8 @@

Default is false.

 - - ]]> + + ]]>

If this value is false, then when loading a mib each trap is checked prior to installation of the mib. @@ -455,11 +456,12 @@

Default is false.

 - - ]]> + + ]]>

Defines the backend data module of the SNMP agent mib-server as defined by the @@ -476,24 +478,24 @@

Default module is snmpa_mib_data_tttn.

- - ]]> + + ]]>

Shall the agent utilize the mib server lookup cache or not.

Default is true (in which case the mibs_cache_opts() default values apply).

 - - ]]> + + ]]>

mibs_cache_opt() = {autogc, mibs_cache_autogc()} | {gclimit, mibs_cache_gclimit()} | {age, mibs_cache_age()}

Defines options specific for the SNMP agent mib server cache.

For defaults see the options in mibs_cache_opt().

 - - ]]> + + ]]>

Defines if the mib server shall perform cache gc automatically or leave it to the user (see @@ -501,8 +503,8 @@

Default is true.

 - - 0 ]]> + + 0 ]]>

Defines how old the entries in the cache will be allowed to become before they are GC'ed (assuming GC is performed). @@ -511,8 +513,8 @@

Default is 10 timutes.

 - - 0 | infinity ]]> + + 0 | infinity ]]>

When performing a GC, this is the max number of cache entries that will be deleted from the cache.

@@ -522,8 +524,8 @@

Default is 100.

 - - ]]> + + ]]>

Defines an error report module, implementing the snmpa_error_report @@ -532,38 +534,38 @@

Default is snmpa_error_logger.

 - - symbolic_store() = [symbolic_store_opt()] + + symbolic_store() = [symbolic_store_opt()]

symbolic_store_opt() = {verbosity, verbosity()}

Defines options specific for the SNMP agent symbolic store.

For defaults see the options in symbolic_store_opt().

 - - target_cache() = [target_cache_opt()] + + target_cache() = [target_cache_opt()]

target_cache_opt() = {verbosity, verbosity()}

Defines options specific for the SNMP agent target cache.

For defaults see the options in target_cache_opt().

 - - ]]> + + ]]>

agent_config_opt() = {dir, agent_config_dir()} | {force_load, force_load()} | {verbosity, verbosity()}

Defines specific config related options for the SNMP agent.

For defaults see the options in agent_config_opt().

 - - ]]> + + ]]>

Defines where the SNMP agent configuration files are stored.

 - - ]]> + + ]]>

If true the configuration files are re-read during start-up, and the contents of the configuration @@ -577,16 +579,16 @@

Manager specific config options and types:

- - ]]> + + ]]>

server_opt() = {timeout, server_timeout()} | {verbosity, verbosity()}

Specifies the options for the manager server process.

Default is silence.

 - - ]]> + + ]]>

Asynchronous request cleanup time. For every requests, some info is stored internally, in order to be able to @@ -606,44 +608,44 @@

Default is 30000.

 - - ]]> + + ]]>

manager_config_opt() = {dir, manager_config_dir()} | {db_dir, manager_db_dir()} | {db_init_error, db_init_error()} | {repair, manager_repair()} | {auto_save, manager_auto_save()} | {verbosity, verbosity()}

Defines specific config related options for the SNMP manager.

For defaults see the options in manager_config_opt().

 - - ]]> + + ]]>

Defines where the SNMP manager configuration files are stored.

 - - ]]> + + ]]>

Defines where the SNMP manager store persistent data.

 - - ]]> + + ]]>

Defines the repair option for the persistent database (if and how the table is repaired when opened).

Default is true.

 - - ]]> + + ]]>

The auto save interval. The table is flushed to disk whenever not accessed for this amount of time.

Default is 5000.

 - - ]]> + + ]]>

This option defines how the manager will handle the sending of response (acknowledgment) to received inform-requests.

@@ -672,16 +674,16 @@

Default is auto.

 - - ]]> + + ]]>

Specifies a list of MIBs (including path) and defines which MIBs are initially loaded into the SNMP manager.

Default is [].

 - - ]]> + + ]]>

manager_net_if_opt() = {module, manager_net_if_module()} | {verbosity, verbosity()} | @@ -691,8 +693,8 @@

For defaults see the options in manager_net_if_opt().

 - - ]]> + + ]]>

manager_net_if_option() = {bind_to, bind_to()} | {sndbuf, sndbuf()} | @@ -705,8 +707,8 @@

For defaults see the options in manager_net_if_option().

 - - ]]> + + ]]>

The module which handles the network interface part for the SNMP manager. It must implement the @@ -714,8 +716,8 @@

Default is snmpm_net_if.

 - - ]]> + + ]]>

manager_net_if_filter_option() = {module, manager_net_if_filter_module()}

These options are actually specific to the used module. @@ -725,8 +727,8 @@ manager_net_if_filter_option().

 - - ]]> + + ]]>

Module which handles the network interface filter part for the SNMP manager. Must implement the @@ -734,16 +736,16 @@

Default is snmpm_net_if_filter.

 - - ]]> + + ]]>

The module implementing the default user. See the snmpm_user behaviour.

Default is snmpm_user_default.

 - - ]]> + + ]]>

Data for the default user. Passed to the user module when calling the callback functions.

@@ -754,8 +756,8 @@

Common config types:

- - restart_type() = permanent | transient | temporary + + restart_type() = permanent | transient | temporary

See supervisor documentation for more info.

@@ -763,8 +765,8 @@ for the manager.

 - - db_init_error() = terminate | create | create_db_and_dir + + db_init_error() = terminate | create | create_db_and_dir

Defines what to do if the agent or manager is unable to open an existing database file. terminate means that the @@ -776,31 +778,31 @@

Default is terminate.

 - - ]]> + + ]]>

Defines the Erlang priority for all SNMP processes.

Default is normal.

 - - ]]> + + ]]>

version() = v1 | v2 | v3

Which SNMP versions shall be accepted/used.

Default is [v1,v2,v3].

 - - ]]> + + ]]>

Verbosity for a SNMP process. This specifies now much debug info is printed.

Default is silence.

 - - ]]> + + ]]>

If true, net_if binds to the IP address. If false, net_if listens on any IP address on the host @@ -808,8 +810,8 @@

Default is false.

 - - ]]> + + ]]>

If true, net_if does not specify that the IP and port address should be reusable. If false, @@ -817,30 +819,30 @@

Default is false.

 - - ]]> + + ]]>

Receive buffer size.

Default value is defined by gen_udp.

 - - ]]> + + ]]>

Send buffer size.

Default value is defined by gen_udp.

 - - ]]> + + ]]>

note_store_opt() = {timeout, note_store_timeout()} | {verbosity, verbosity()}

Specifies the start-up verbosity for the SNMP note store.

For defaults see the options in note_store_opt().

 - - ]]> + + ]]>

Note cleanup time. When storing a note in the note store, each note is given lifetime. Every timeout the note_store @@ -850,8 +852,8 @@ - - ]]> + + ]]>

audit_trail_log_opt() = {type, atl_type()} | {dir, atl_dir()} | {size, atl_size()} | {repair, atl_repair()} | {seqno, atl_seqno()}

If present, this option specifies the options for the @@ -861,8 +863,8 @@

If not present, audit trail logging is not used.

 - - ]]> + + ]]>

Specifies what type of an audit trail log should be used. The effect of the type is actually different for the the agent @@ -883,16 +885,16 @@

Default is read_write.

 - - ]]> + + ]]>

Specifies where the audit trail log should be stored.

If audit_trail_log specifies that logging should take place, this parameter must be defined.

 - - ]]> + + ]]>

Specifies the size of the audit trail log. This parameter is sent to disk_log.

@@ -900,8 +902,8 @@ take place, this parameter must be defined.

 - - ]]> + + ]]>

Specifies if and how the audit trail log shall be repaired when opened. Unless this parameter has the value snmp_repair @@ -913,8 +915,8 @@

Default is true.

 - - ]]> + + ]]>

Specifies if the audit trail log entries will be (sequence) numbered or not. The range of the sequence numbers are according diff --git a/lib/snmp/doc/src/snmp_config.xml b/lib/snmp/doc/src/snmp_config.xml index f10574a2a9..a085252d90 100644 --- a/lib/snmp/doc/src/snmp_config.xml +++ b/lib/snmp/doc/src/snmp_config.xml @@ -130,16 +130,16 @@

Agent specific config options and types:

- - ]]> + + ]]>

If master, one master agent is started. Otherwise, no agents are started.

Default is master.

 - - ]]> + + ]]>

agent_discovery_opt() = {terminating, agent_terminating_discovery_opts()} | @@ -151,8 +151,8 @@

For defaults see the options in agent_discovery_opt().

 - - ]]> + + ]]>

agent_terminating_discovery_opt() = {enable, boolean()} | @@ -169,8 +169,8 @@ - - ]]> + + ]]>

agent_originating_discovery_opt() = {enable, boolean()}

@@ -183,38 +183,38 @@ - - ]]> + + ]]>

If true, the agent is multi-threaded, with one thread for each get request.

Default is false.

 - - ]]> + + ]]>

Defines where the SNMP agent internal db files are stored.

 - - ]]> + + ]]>

Defines the maximum number of varbinds allowed in a Get-BULK response.

Default is 1000.

 - - ]]> + + ]]>

local_db_opt() = {repair, agent_repair()} | {auto_save, agent_auto_save()} | {verbosity, verbosity()}

Defines options specific for the SNMP agent local database.

For defaults see the options in local_db_opt().

 - - ]]> + + ]]>

When starting snmpa_local_db it always tries to open an existing database. If false, and some errors occur, a new @@ -224,16 +224,16 @@

Default is true.

 - - ]]> + + ]]>

The auto save interval. The table is flushed to disk whenever not accessed for this amount of time.

Default is 5000.

 - - ]]> + + ]]>

agent_net_if_option() = {module, agent_net_if_module()} | {verbosity, verbosity()} | @@ -243,8 +243,8 @@

For defaults see the options in agent_net_if_opt().

 - - ]]> + + ]]>

Module which handles the network interface part for the SNMP agent. Must implement the @@ -252,8 +252,8 @@

Default is snmpa_net_if.

 - - ]]> + + ]]>

agent_net_if_option() = {bind_to, bind_to()} | {sndbuf, sndbuf()} | @@ -267,15 +267,15 @@

For defaults see the options in agent_net_if_option().

 - - ]]> + + ]]>

Max number of simultaneous requests handled by the agent.

Default is infinity.

 - - ]]> + + ]]>

These options are actually specific to the used module. @@ -284,8 +284,8 @@

For defaults see the options in agent_net_if_filter_option().

 - - ]]> + + ]]>

Module which handles the network interface filter part for the SNMP agent. Must implement the @@ -294,8 +294,8 @@

Default is snmpa_net_if_filter.

 - - ]]> + + ]]>

Specifies a list of MIBs (including path) that defines which MIBs are initially loaded into the SNMP master agent.

@@ -309,8 +309,8 @@

Default is [].

 - - ]]> + + ]]>

mib_storage_opt() = {module, mib_storage_module()} | {options, mib_storage_options()}

This option specifies how basic mib data is stored. @@ -319,8 +319,8 @@

Default is [{module, snmpa_mib_storage_ets}].

- - + +

Defines the mib storage module of the SNMP agent as defined by the snmpa_mib_storage @@ -334,8 +334,8 @@

Default module is snmpa_mib_storage_ets.

- - ]]> + + ]]>

This is implementattion depended. That is, it depends on the module. For each module a specific set of options are valid. @@ -429,8 +429,8 @@ This is the old format which is "supported", but not documented, in so far as it will be converted to the new format if found. - - ]]> + + ]]>

Specifies how info retrieved from the mibs will be stored.

If mib_storage is {ets, Dir}, the table will also be @@ -456,16 +456,16 @@ in so far as it will be converted to the new format if found. --> - - ]]> + + ]]>

mib_server_opt() = {mibentry_override, mibentry_override()} | {trapentry_override, trapentry_override()} | {verbosity, verbosity()} | {cache, mibs_cache()} | {data_module, mib_server_data_module()}

Defines options specific for the SNMP agent mib server.

For defaults see the options in mib_server_opt().

 - - ]]> + + ]]>

If this value is false, then when loading a mib each mib- entry is checked prior to installation of the mib. @@ -474,8 +474,8 @@ in so far as it will be converted to the new format if found.

Default is false.

 - - ]]> + + ]]>

If this value is false, then when loading a mib each trap is checked prior to installation of the mib. @@ -484,11 +484,13 @@ in so far as it will be converted to the new format if found.

Default is false.

 - + - ]]> + + ]]>

Defines the backend data module of the SNMP agent mib-server as defined by the @@ -505,24 +507,24 @@ in so far as it will be converted to the new format if found.

Default module is snmpa_mib_data_tttn.

- - ]]> + + ]]>

Shall the agent utilize the mib server lookup cache or not.

Default is true (in which case the mibs_cache_opts() default values apply).

 - - ]]> + + ]]>

mibs_cache_opt() = {autogc, mibs_cache_autogc()} | {gclimit, mibs_cache_gclimit()} | {age, mibs_cache_age()}

Defines options specific for the SNMP agent mib server cache.

For defaults see the options in mibs_cache_opt().

 - - ]]> + + ]]>

Defines if the mib server shall perform cache gc automatically or leave it to the user (see @@ -530,8 +532,8 @@ in so far as it will be converted to the new format if found.

Default is true.

 - - 0 ]]> + + 0 ]]>

Defines how old the entries in the cache will be allowed to become before they are GC'ed (assuming GC is performed). @@ -540,8 +542,8 @@ in so far as it will be converted to the new format if found.

Default is 10 timutes.

 - - 0 | infinity ]]> + + 0 | infinity ]]>

When performing a GC, this is the max number of cache entries that will be deleted from the cache.

@@ -551,8 +553,8 @@ in so far as it will be converted to the new format if found.

Default is 100.

 - - ]]> + + ]]>

Defines an error report module, implementing the snmpa_error_report @@ -561,38 +563,38 @@ in so far as it will be converted to the new format if found.

Default is snmpa_error_logger.

 - - symbolic_store() = [symbolic_store_opt()] + + symbolic_store() = [symbolic_store_opt()]

symbolic_store_opt() = {verbosity, verbosity()}

Defines options specific for the SNMP agent symbolic store.

For defaults see the options in symbolic_store_opt().

 - - target_cache() = [target_cache_opt()] + + target_cache() = [target_cache_opt()]

target_cache_opt() = {verbosity, verbosity()}

Defines options specific for the SNMP agent target cache.

For defaults see the options in target_cache_opt().

 - - ]]> + + ]]>

agent_config_opt() = {dir, agent_config_dir()} | {force_load, force_load()} | {verbosity, verbosity()}

Defines specific config related options for the SNMP agent.

For defaults see the options in agent_config_opt().

 - - ]]> + + ]]>

Defines where the SNMP agent configuration files are stored.

 - - ]]> + + ]]>

If true the configuration files are re-read during start-up, and the contents of the configuration @@ -606,16 +608,16 @@ in so far as it will be converted to the new format if found.

Manager specific config options and types:

- - ]]> + + ]]>

server_opt() = {timeout, server_timeout()} | {verbosity, verbosity()}

Specifies the options for the manager server process.

Default is silence.

 - - ]]> + + ]]>

Asynchronous request cleanup time. For every requests, some info is stored internally, in order to be able to @@ -635,44 +637,44 @@ in so far as it will be converted to the new format if found.

Default is 30000.

 - - ]]> + + ]]>

manager_config_opt() = {dir, manager_config_dir()} | {db_dir, manager_db_dir()} | {db_init_error, db_init_error()} | {repair, manager_repair()} | {auto_save, manager_auto_save()} | {verbosity, verbosity()}

Defines specific config related options for the SNMP manager.

For defaults see the options in manager_config_opt().

 - - ]]> + + ]]>

Defines where the SNMP manager configuration files are stored.

 - - ]]> + + ]]>

Defines where the SNMP manager store persistent data.

 - - ]]> + + ]]>

Defines the repair option for the persistent database (if and how the table is repaired when opened).

Default is true.

 - - ]]> + + ]]>

The auto save interval. The table is flushed to disk whenever not accessed for this amount of time.

Default is 5000.

 - - ]]> + + ]]>

This option defines how the manager will handle the sending of response (acknowledgment) to received inform-requests.

@@ -701,16 +703,16 @@ in so far as it will be converted to the new format if found.

Default is auto.

 - - ]]> + + ]]>

Specifies a list of MIBs (including path) and defines which MIBs are initially loaded into the SNMP manager.

Default is [].

 - - ]]> + + ]]>

manager_net_if_opt() = {module, manager_net_if_module()} | {verbosity, verbosity()} | @@ -720,8 +722,8 @@ in so far as it will be converted to the new format if found.

For defaults see the options in manager_net_if_opt().

 - - ]]> + + ]]>

manager_net_if_option() = {bind_to, bind_to()} | {sndbuf, sndbuf()} | @@ -734,8 +736,8 @@ in so far as it will be converted to the new format if found.

For defaults see the options in manager_net_if_option().

 - - ]]> + + ]]>

The module which handles the network interface part for the SNMP manager. It must implement the @@ -743,8 +745,8 @@ in so far as it will be converted to the new format if found.

Default is snmpm_net_if.

- - ]]> + + ]]>

manager_net_if_filter_option() = {module, manager_net_if_filter_module()}

These options are actually specific to the used module. @@ -754,8 +756,8 @@ in so far as it will be converted to the new format if found. manager_net_if_filter_option().

 - - ]]> + + ]]>

Module which handles the network interface filter part for the SNMP manager. Must implement the @@ -763,16 +765,16 @@ in so far as it will be converted to the new format if found.

Default is snmpm_net_if_filter.

 - - ]]> + + ]]>

The module implementing the default user. See the snmpm_user behaviour.

Default is snmpm_user_default.

 - - ]]> + + ]]>

Data for the default user. Passed to the user when calling the callback functions.

@@ -783,8 +785,8 @@ in so far as it will be converted to the new format if found.

Common config types:

- - restart_type() = permanent | transient | temporary + + restart_type() = permanent | transient | temporary

See supervisor documentation for more info.

@@ -792,8 +794,8 @@ in so far as it will be converted to the new format if found. for the manager.

 - - db_init_error() = terminate | create | create_db_and_dir + + db_init_error() = terminate | create | create_db_and_dir

Defines what to do if the agent is unable to open an existing database file. terminate means that the @@ -805,31 +807,31 @@ in so far as it will be converted to the new format if found.

Default is terminate.

 - - ]]> + + ]]>

Defines the Erlang priority for all SNMP processes.

Default is normal.

 - - ]]> + + ]]>

version() = v1 | v2 | v3

Which SNMP versions shall be accepted/used.

Default is [v1,v2,v3].

 - - ]]> + + ]]>

Verbosity for a SNMP process. This specifies now much debug info is printed.

Default is silence.

 - - ]]> + + ]]>

If true, net_if binds to the IP address. If false, net_if listens on any IP address on the host @@ -837,8 +839,8 @@ in so far as it will be converted to the new format if found.

Default is false.

 - - ]]> + + ]]>

If true, net_if does not specify that the IP and port address should be reusable. If false, @@ -846,30 +848,30 @@ in so far as it will be converted to the new format if found.

Default is false.

 - - ]]> + + ]]>

Receive buffer size.

Default value is defined by gen_udp.

 - - ]]> + + ]]>

Send buffer size.

Default value is defined by gen_udp.

 - - ]]> + + ]]>

note_store_opt() = {timeout, note_store_timeout()} | {verbosity, verbosity()}

Specifies the options for the SNMP note store.

For defaults see the options in note_store_opt().

 - - ]]> + + ]]>

Note cleanup time. When storing a note in the note store, each note is given lifetime. Every timeout the note_store @@ -878,8 +880,8 @@ in so far as it will be converted to the new format if found.

Default is 30000.

 - - ]]> + + ]]>

audit_trail_log_opt() = {type, atl_type()} | {dir, atl_dir()} | {size, atl_size()} | {repair, atl_repair()} | {seqno, atl_seqno()}

If present, this option specifies the options for the @@ -889,8 +891,8 @@ in so far as it will be converted to the new format if found.

If not present, audit trail logging is not used.

 - - ]]> + + ]]>

Specifies what type of an audit trail log should be used. The effect of the type is actually different for the the agent @@ -911,16 +913,16 @@ in so far as it will be converted to the new format if found.

Default is read_write.

 - - ]]> + + ]]>

Specifies where the audit trail log should be stored.

If audit_trail_log specifies that logging should take place, this parameter must be defined.

 - - ]]> + + ]]>

Specifies the size of the audit trail log. This parameter is sent to disk_log.

@@ -928,8 +930,8 @@ in so far as it will be converted to the new format if found. take place, this parameter must be defined.

 - - ]]> + + ]]>

Specifies if and how the audit trail log shall be repaired when opened. Unless this parameter has the value snmp_repair @@ -941,8 +943,8 @@ in so far as it will be converted to the new format if found.

Default is true.

 - - ]]> + + ]]>

Specifies if the audit trail log entries will be (sequence) numbered or not. The range of the sequence numbers are according diff --git a/lib/snmp/doc/src/snmp_manager_netif.xml b/lib/snmp/doc/src/snmp_manager_netif.xml index 8454d03b17..98d4e7fd96 100644 --- a/lib/snmp/doc/src/snmp_manager_netif.xml +++ b/lib/snmp/doc/src/snmp_manager_netif.xml @@ -75,8 +75,7 @@

In this section a Domain field is the transport domain i.e one of transportDomainUdpIpv4 or transportDomainUdpIpv6, and an Addr field is an - {IpAddr, - IpPort} tuple.

+ {IpAddr,IpPort} tuple.

Net if must send the following message when it receives an SNMP PDU from the network that is aimed for the MasterAgent: diff --git a/lib/snmp/doc/src/snmpa.xml b/lib/snmp/doc/src/snmpa.xml index f205af6e88..c84eeec524 100644 --- a/lib/snmp/doc/src/snmpa.xml +++ b/lib/snmp/doc/src/snmpa.xml @@ -622,12 +622,12 @@ notification_delivery_info() = #snmpa_notification_delivery_info{}

Converts an Audit Trail Log to a readable format and prints it on stdio. LogName defaults to "snmpa_log". - LogFile defaults to "snmpa.log". + LogFile defaults to "snmpa.log".

The Block option indicates if the log should be blocked during conversion. This could be usefull when converting large logs (when otherwise the log could wrap during conversion). Defaults to true.

- See snmp:log_to_io +

See snmp:log_to_io for more info.

diff --git a/lib/snmp/doc/src/snmpm.xml b/lib/snmp/doc/src/snmpm.xml index b14c0e6afd..ab288fd020 100644 --- a/lib/snmp/doc/src/snmpm.xml +++ b/lib/snmp/doc/src/snmpm.xml @@ -1241,12 +1241,12 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1

Converts an Audit Trail Log to a readable text file. OutFile defaults to "./snmpm_log.txt". LogName defaults to "snmpm_log". - LogFile defaults to "snmpm.log". + LogFile defaults to "snmpm.log".

The Block argument indicates if the log should be blocked during conversion. This could be usefull when converting large logs (when otherwise the log could wrap during conversion). Defaults to true.

- See snmp:log_to_txt +

See snmp:log_to_txt for more info.

@@ -1280,12 +1280,12 @@ priv_key = [integer()] (length is 16 if priv = usmDESPrivProtocol | usmAesCfb1

Converts an Audit Trail Log to a readable format and prints it on stdio. LogName defaults to "snmpm_log". - LogFile defaults to "snmpm.log". + LogFile defaults to "snmpm.log".

The Block argument indicates if the log should be blocked during conversion. This could be usefull when converting large logs (when otherwise the log could wrap during conversion). Defaults to true.

- See snmp:log_to_io +

See snmp:log_to_io for more info.

-- cgit v1.2.3 From f5427a21fdcaebe6144e02c1771609595fa07e7a Mon Sep 17 00:00:00 2001 From: Hans Bolinder Date: Tue, 13 Oct 2015 14:02:17 +0200 Subject: [ssh] Correct documentation Fix mistakes found by 'xmllint'. --- lib/ssh/doc/src/notes.xml | 10 +++++----- lib/ssh/doc/src/using_ssh.xml | 4 ++-- 2 files changed, 7 insertions(+), 7 deletions(-) (limited to 'lib') diff --git a/lib/ssh/doc/src/notes.xml b/lib/ssh/doc/src/notes.xml index bb111c8e0e..012d7051eb 100644 --- a/lib/ssh/doc/src/notes.xml +++ b/lib/ssh/doc/src/notes.xml @@ -4,7 +4,7 @@
- 20042014 + 20042015 Ericsson AB. All Rights Reserved. @@ -216,9 +216,9 @@

Thanks to Simon Cornish

- Own Id: OTP-12760 Aux Id: pull req - 715

+ 715

@@ -384,13 +384,13 @@

- Made Codenomicon Defensics test suite pass: + Made Codenomicon Defensics test suite pass:

limit number of algorithms in kexinit message check 'e' and 'f' parameters in kexdh implement 'keyboard-interactive' user authentication on server side return plain text message to bad version exchange message -

+

Own Id: OTP-12784

 diff --git a/lib/ssh/doc/src/using_ssh.xml b/lib/ssh/doc/src/using_ssh.xml index 91185a0f6e..2d045fdb60 100644 --- a/lib/ssh/doc/src/using_ssh.xml +++ b/lib/ssh/doc/src/using_ssh.xml @@ -234,7 +234,7 @@ SFTP Client with TAR Compression and Encryption

Example of writing and then reading a tar file follows:

- + {ok,HandleWrite} = ssh_sftp:open_tar(ChannelPid, ?tar_file_name, [write]), ok = erl_tar:add(HandleWrite, .... ), ok = erl_tar:add(HandleWrite, .... ), @@ -249,7 +249,7 @@

The previous write and read example can be extended with encryption and decryption as follows:

- + %% First three parameters depending on which crypto type we select: Key = <<"This is a 256 bit key. abcdefghi">>, Ivec0 = crypto:rand_bytes(16), -- cgit v1.2.3 From 6f50633829adc53d20a2c2aee454aef8caece907 Mon Sep 17 00:00:00 2001 From: Hans Bolinder Date: Tue, 13 Oct 2015 14:01:18 +0200 Subject: [compiler] Correct documentation Fix mistakes found by 'xmllint'. --- lib/compiler/doc/src/notes.xml | 26 ++++++++++++++++---------- 1 file changed, 16 insertions(+), 10 deletions(-) (limited to 'lib') diff --git a/lib/compiler/doc/src/notes.xml b/lib/compiler/doc/src/notes.xml index bd85f22462..daf3bd3af9 100644 --- a/lib/compiler/doc/src/notes.xml +++ b/lib/compiler/doc/src/notes.xml @@ -458,22 +458,28 @@

EEP43: New data type - Maps

- With Maps you may for instance: M0 = - #{ a => 1, b => 2}, % create - associations M1 = M0#{ a := 10 }, % - update values M2 = M1#{ "hi" => - "hello"}, % add new associations #{ - "hi" := V1, a := V2, b := V3} = M2. % match keys with - values

+ With Maps you may for instance:

+ + M0 = #{ a => 1, b => 2}, % create + associations + M1 = M0#{ a := 10 }, % update values + M2 = M1#{ "hi" => + "hello"}, % add new associations + #{ "hi" := V1, a := V2, b := V3} = M2. + % match keys with values +

For information on how to use Maps please see Map Expressions in the Reference Manual.

The current implementation is without the following - features: No variable keys - No single value access No map - comprehensions

+ features:

+ + No variable keys + No single value access + No map comprehensions +

Note that Maps is experimental during OTP 17.0.

-- cgit v1.2.3 From ea4114d5d4156bae207788e5be7d0157e32adfe9 Mon Sep 17 00:00:00 2001 From: Hans Bolinder Date: Tue, 13 Oct 2015 14:01:30 +0200 Subject: [crypto] Correct documentation Fix mistakes found by 'xmllint'. --- lib/crypto/doc/src/crypto.xml | 84 +++++++++++++++++++++---------------------- 1 file changed, 42 insertions(+), 42 deletions(-) (limited to 'lib') diff --git a/lib/crypto/doc/src/crypto.xml b/lib/crypto/doc/src/crypto.xml index 291a5145e4..8d082bf3fe 100644 --- a/lib/crypto/doc/src/crypto.xml +++ b/lib/crypto/doc/src/crypto.xml @@ -66,29 +66,29 @@

DATA TYPES -

key_value() = integer() | binary()

+ key_value() = integer() | binary()

Always binary() when used as return value

-

rsa_public() = [key_value()] = [E, N]

+ rsa_public() = [key_value()] = [E, N]

Where E is the public exponent and N is public modulus.

-

rsa_private() = [key_value()] = [E, N, D] | [E, N, D, P1, P2, E1, E2, C]

+ rsa_private() = [key_value()] = [E, N, D] | [E, N, D, P1, P2, E1, E2, C]

Where E is the public exponent, N is public modulus and D is the private exponent.The longer key format contains redundant information that will make the calculation faster. P1,P2 are first and second prime factors. E1,E2 are first and second exponents. C is the CRT coefficient. Terminology is taken from RFC 3447.

-

dss_public() = [key_value()] = [P, Q, G, Y]

+ dss_public() = [key_value()] = [P, Q, G, Y]

Where P, Q and G are the dss parameters and Y is the public key.

-

dss_private() = [key_value()] = [P, Q, G, X]

+ dss_private() = [key_value()] = [P, Q, G, X]

Where P, Q and G are the dss parameters and X is the private key.

-

srp_public() = key_value()

+ srp_public() = key_value()

Where is A or B from SRP design

-

srp_private() = key_value()

+ srp_private() = key_value()

Where is a or b from SRP design

Where Verifier is v, Generator is g and Prime is N, DerivedKey is X, and Scrambler is @@ -96,29 +96,29 @@ Version = '3' | '6' | '6a'

-

dh_public() = key_value()

+ dh_public() = key_value() -

dh_private() = key_value()

+ dh_private() = key_value() -

dh_params() = [key_value()] = [P, G]

+ dh_params() = [key_value()] = [P, G] -

ecdh_public() = key_value()

+ ecdh_public() = key_value() -

ecdh_private() = key_value()

+ ecdh_private() = key_value() -

ecdh_params() = ec_named_curve() | ec_explicit_curve()

+ ecdh_params() = ec_named_curve() | ec_explicit_curve() -

ec_explicit_curve() = - {ec_field(), Prime :: key_value(), Point :: key_value(), Order :: integer(), CoFactor :: none | integer()}

+ ec_explicit_curve() = + {ec_field(), Prime :: key_value(), Point :: key_value(), Order :: integer(), CoFactor :: none | integer()} -

ec_field() = {prime_field, Prime :: integer()} | - {characteristic_two_field, M :: integer(), Basis :: ec_basis()}

+ ec_field() = {prime_field, Prime :: integer()} | + {characteristic_two_field, M :: integer(), Basis :: ec_basis()} -

ec_basis() = {tpbasis, K :: non_neg_integer()} | + ec_basis() = {tpbasis, K :: non_neg_integer()} | {ppbasis, K1 :: non_neg_integer(), K2 :: non_neg_integer(), K3 :: non_neg_integer()} | - onbasis

+ onbasis -

ec_named_curve() -> + ec_named_curve() -> sect571r1| sect571k1| sect409r1| sect409k1| secp521r1| secp384r1| secp224r1| secp224k1| secp192k1| secp160r2| secp128r2| secp128r1| sect233r1| sect233k1| sect193r2| sect193r1| sect131r2| sect131r1| sect283r1| sect283k1| sect163r2| secp256k1| secp160k1| secp160r1| @@ -128,42 +128,42 @@ brainpoolP224t1| brainpoolP256r1| brainpoolP256t1| brainpoolP320r1| brainpoolP320t1| brainpoolP384r1| brainpoolP384t1| brainpoolP512r1| brainpoolP512t1 - Note that the sect curves are GF2m (characteristic two) curves and are only supported if the +

Note that the sect curves are GF2m (characteristic two) curves and are only supported if the underlying OpenSSL has support for them. See also crypto:supports/0

-

stream_cipher() = rc4 | aes_ctr

+ stream_cipher() = rc4 | aes_ctr -

block_cipher() = aes_cbc128 | aes_cfb8 | aes_cfb128 | aes_ige256 | blowfish_cbc | + block_cipher() = aes_cbc128 | aes_cfb8 | aes_cfb128 | aes_ige256 | blowfish_cbc | blowfish_cfb64 | des_cbc | des_cfb | des3_cbc | des3_cbf - | des_ede3 | rc2_cbc

+ | des_ede3 | rc2_cbc -

aead_cipher() = aes_gcm | chacha20_poly1305

+ aead_cipher() = aes_gcm | chacha20_poly1305 -

stream_key() = aes_key() | rc4_key()

+ stream_key() = aes_key() | rc4_key() -

block_key() = aes_key() | blowfish_key() | des_key()| des3_key()

+ block_key() = aes_key() | blowfish_key() | des_key()| des3_key() -

aes_key() = iodata() Key length is 128, 192 or 256 bits

+ aes_key() = iodata()

Key length is 128, 192 or 256 bits

-

rc4_key() = iodata() Variable key length from 8 bits up to 2048 bits (usually between 40 and 256)

+ rc4_key() = iodata()

Variable key length from 8 bits up to 2048 bits (usually between 40 and 256)

-

blowfish_key() = iodata() Variable key length from 32 bits up to 448 bits

+ blowfish_key() = iodata()

Variable key length from 32 bits up to 448 bits

-

des_key() = iodata() Key length is 64 bits (in CBC mode only 8 bits are used)

+ des_key() = iodata()

Key length is 64 bits (in CBC mode only 8 bits are used)

-

des3_key() = [binary(), binary(), binary()] Each key part is 64 bits (in CBC mode only 8 bits are used)

+ des3_key() = [binary(), binary(), binary()]

Each key part is 64 bits (in CBC mode only 8 bits are used)

-

digest_type() = md5 | sha | sha224 | sha256 | sha384 | sha512

+ digest_type() = md5 | sha | sha224 | sha256 | sha384 | sha512 -

hash_algorithms() = md5 | ripemd160 | sha | sha224 | sha256 | sha384 | sha512 md4 is also supported for hash_init/1 and hash/2. + hash_algorithms() = md5 | ripemd160 | sha | sha224 | sha256 | sha384 | sha512

md4 is also supported for hash_init/1 and hash/2. Note that both md4 and md5 are recommended only for compatibility with existing applications.

-

cipher_algorithms() = des_cbc | des_cfb | des3_cbc | des3_cbf | des_ede3 | - blowfish_cbc | blowfish_cfb64 | aes_cbc128 | aes_cfb8 | aes_cfb128| aes_cbc256 | aes_ige256 | aes_gcm | chacha20_poly1305 | rc2_cbc | aes_ctr| rc4

-

public_key_algorithms() = rsa |dss | ecdsa | dh | ecdh | ec_gf2m - Note that ec_gf2m is not strictly a public key algorithm, but a restriction on what curves are supported + cipher_algorithms() = des_cbc | des_cfb | des3_cbc | des3_cbf | des_ede3 | + blowfish_cbc | blowfish_cfb64 | aes_cbc128 | aes_cfb8 | aes_cfb128| aes_cbc256 | aes_ige256 | aes_gcm | chacha20_poly1305 | rc2_cbc | aes_ctr| rc4 + public_key_algorithms() = rsa |dss | ecdsa | dh | ecdh | ec_gf2m +

Note that ec_gf2m is not strictly a public key algorithm, but a restriction on what curves are supported with ecdsa and ecdh.

@@ -381,8 +381,8 @@

Computes a HMAC of type Type from Data using - Key as the authentication key.

MacLength - will limit the size of the resultant Mac. + Key as the authentication key.

MacLength + will limit the size of the resultant Mac.

 @@ -650,7 +650,7 @@

Creates a digital signature.

Algorithm dss can only be used together with digest type sha.

- See also public_key:sign/3 +

See also public_key:sign/3.

@@ -802,7 +802,7 @@

Algorithm dss can only be used together with digest type sha.

- See also public_key:verify/4 +

See also public_key:verify/4.

-- cgit v1.2.3