From ad6e765bcd4f35a282ef00e38ed9129f3a5c1d83 Mon Sep 17 00:00:00 2001 From: Hans Bolinder Date: Thu, 1 Sep 2016 14:32:27 +0200 Subject: doc: Correct errors introduced by Editorial changes Fix some older errors as well. --- lib/sasl/doc/src/alarm_handler.xml | 4 ++-- lib/sasl/doc/src/appup.xml | 10 +++++----- lib/sasl/doc/src/error_logging.xml | 18 +++++++++--------- lib/sasl/doc/src/notes.xml | 2 +- lib/sasl/doc/src/part.xml | 2 +- lib/sasl/doc/src/rb.xml | 6 +++--- lib/sasl/doc/src/ref_man.xml | 2 +- lib/sasl/doc/src/rel.xml | 6 +++--- lib/sasl/doc/src/release_handler.xml | 20 ++++++++++---------- lib/sasl/doc/src/sasl_app.xml | 24 ++++++++++++------------ lib/sasl/doc/src/sasl_intro.xml | 2 +- lib/sasl/doc/src/systools.xml | 6 +++--- 12 files changed, 51 insertions(+), 51 deletions(-) (limited to 'lib/sasl/doc') diff --git a/lib/sasl/doc/src/alarm_handler.xml b/lib/sasl/doc/src/alarm_handler.xml index 8550a88b28..4160757164 100644 --- a/lib/sasl/doc/src/alarm_handler.xml +++ b/lib/sasl/doc/src/alarm_handler.xml @@ -54,7 +54,7 @@ format is defined by the user. For example, an event handler for SNMP can be defined, together with an alarm Management Information Base (MIB).

-

The alarm handler is part of the SASL application.

+

The alarm handler is part of the SASL application.

When writing new event handlers for the alarm handler, the following events must be handled:

@@ -76,7 +76,7 @@ {NewHandler, Args}). NewHandler:init({Args, {alarm_handler, Alarms}}) is called. For more details, see gen_event(3) - in STDLIB.

+ in STDLIB.

diff --git a/lib/sasl/doc/src/appup.xml b/lib/sasl/doc/src/appup.xml index 6fbdcb9f5b..a43a966dcb 100644 --- a/lib/sasl/doc/src/appup.xml +++ b/lib/sasl/doc/src/appup.xml @@ -362,12 +362,12 @@ point_of_no_return system is restarted.

 restart_new_emulator
-

This instruction is used when the application ERTS, - Kernel, STDLIB, or SASL is +

This instruction is used when the application ERTS, + Kernel, STDLIB, or SASL is upgraded. It shuts down the current emulator and starts a new one. All processes are terminated gracefully, and the new - version of ERTS, Kernel, STDLIB, and - SASL are used when the emulator restarts. + version of ERTS, Kernel, STDLIB, and + SASL are used when the emulator restarts. Only one restart_new_emulator instruction is allowed in the relup file, and it must be placed first. systools:make_relup/3,4 @@ -385,7 +385,7 @@ restart_new_emulator

As stated earlier, instruction restart_new_emulator causes the emulator to be restarted with new versions of - ERTS, Kernel, STDLIB, and SASL. + ERTS>, Kernel, STDLIB, and SASL. However, all other applications do at startup run their old versions in this new emulator. This is usually no problem, but every now and then incompatible changes occur to the diff --git a/lib/sasl/doc/src/error_logging.xml b/lib/sasl/doc/src/error_logging.xml index 8464a41ff9..4b2c960bbb 100644 --- a/lib/sasl/doc/src/error_logging.xml +++ b/lib/sasl/doc/src/error_logging.xml @@ -32,20 +32,20 @@ B error_logging.xml -

The SASL application introduces three types of reports:

+

The SASL application introduces three types of reports:

Supervisor report Progress report Crash report -

When the SASL application is started, it adds a handler that +

When the SASL application is started, it adds a handler that formats and writes these reports, as specified in the configuration - parameters for SASL, that is, the environment variables - in the SASL application specification, which is found in the - .app file of SASL. For details, see the + parameters for SASL, that is, the environment variables + in the SASL application specification, which is found in the + .app file of SASL. For details, see the sasl(6) application in the Reference Manual and the app(4) - file in the Kernel Reference Manual.

+ file in the Kernel Reference Manual.

Supervisor Report @@ -180,14 +180,14 @@

The report browser is used to browse and format error reports written by the error logger handler log_mf_h - defined in STDLIB.

+ defined in STDLIB.

The log_mf_h handler writes all reports to a report logging directory, which is specified when - configuring the SASL application.

+ configuring the SASL application.

If the report browser is used offline, the reports can be copied to another directory specified when starting the browser. If no such directory - is specified, the browser reads reports from the SASL + is specified, the browser reads reports from the SASL error_logger_mf_dir.

diff --git a/lib/sasl/doc/src/notes.xml b/lib/sasl/doc/src/notes.xml index dae73f8b23..bd713af932 100644 --- a/lib/sasl/doc/src/notes.xml +++ b/lib/sasl/doc/src/notes.xml @@ -824,7 +824,7 @@

Use an infinity timeout in all calls to - gen_server:call() in the sasl + gen_server:call() in the SASL application.

Own Id: OTP-8506 Aux Id: seq11509

diff --git a/lib/sasl/doc/src/part.xml b/lib/sasl/doc/src/part.xml index f531ed2dea..659710487e 100644 --- a/lib/sasl/doc/src/part.xml +++ b/lib/sasl/doc/src/part.xml @@ -30,7 +30,7 @@ part.xml -

The System Architecture Support Libraries SASL application +

The System Architecture Support Libraries SASL application provides support for alarm handling, release handling, and related functions.

 diff --git a/lib/sasl/doc/src/rb.xml b/lib/sasl/doc/src/rb.xml index 1ce19046eb..d5df4fd345 100644 --- a/lib/sasl/doc/src/rb.xml +++ b/lib/sasl/doc/src/rb.xml @@ -38,7 +38,7 @@

The Report Browser (RB) tool is used to browse and format error reports written by the error logger handler log_mf_h - in STDLIB.

+ in STDLIB.

@@ -62,7 +62,7 @@ reports that match that filter.

The reports are matched using the proplists - module in STDLIB. The report must be a proplist + module in STDLIB. The report must be a proplist to be matched against any of the filters.

If the filter has the form {Key, RegExp, re}, the report must contain an element with key equal to Key and @@ -102,7 +102,7 @@

For a definition of valid regular expressions and options, see the re module in - STDLIB and in particular function re:run/3.

+ STDLIB and in particular function re:run/3.

For details about data type mp(), see re:mp().

diff --git a/lib/sasl/doc/src/ref_man.xml b/lib/sasl/doc/src/ref_man.xml index 42045df5ec..78cf1eb26e 100644 --- a/lib/sasl/doc/src/ref_man.xml +++ b/lib/sasl/doc/src/ref_man.xml @@ -30,7 +30,7 @@ application.xml -

The SASL application provides support for alarm handling, +

The SASL application provides support for alarm handling, release handling, and related functions.

 diff --git a/lib/sasl/doc/src/rel.xml b/lib/sasl/doc/src/rel.xml index d6558c06b4..9356b2cd47 100644 --- a/lib/sasl/doc/src/rel.xml +++ b/lib/sasl/doc/src/rel.xml @@ -59,7 +59,7 @@ Vsn = string()

Release version.

 EVsn = string() -

ERTS version the release is intended for.

 +

ERTS version the release is intended for.

 Application = atom()

Name of an application included in the release.

 AppVsn = string() @@ -82,8 +82,8 @@ to the same value as in the application resource file.

 -

The list of applications must contain the Kernel and - STDLIB applications.

+

The list of applications must contain the Kernel and + STDLIB applications.
diff --git a/lib/sasl/doc/src/release_handler.xml b/lib/sasl/doc/src/release_handler.xml index bcbc5f5339..8f073807fb 100644 --- a/lib/sasl/doc/src/release_handler.xml +++ b/lib/sasl/doc/src/release_handler.xml @@ -31,7 +31,7 @@ release_handler Unpacking and Installation of Release Packages -

The release handler process belongs to the SASL +

The release handler process belongs to the SASL application, which is responsible for release handling, that is, unpacking, installation, and removal of release packages.

An introduction to release handling and an example is provided in @@ -44,7 +44,7 @@ directory of the previous version of the release, where $ROOT is the installation root directory, code:root_dir(). - Another releases directory can be specified using the SASL + Another releases directory can be specified using the SASL configuration parameter releases_dir or the OS environment variable RELDIR. The release handler must have write access to this directory to install the new release. @@ -56,7 +56,7 @@ A boot script, Name.boot

The .rel file contains information about the release: its name, - version, and which ERTS and application versions it uses.

+ version, and which ERTS and application versions it uses.

A release package can also contain:

A release upgrade file, relup @@ -115,7 +115,7 @@ System Documentation. In this case, the system configuration file sys.config is mandatory.

The installation of a new release can restart the system. Which - program to use is specified by the SASL configuration + program to use is specified by the SASL configuration parameter start_prg, which defaults to $ROOT/bin/start.

The emulator restart on Windows NT expects that the system is @@ -132,7 +132,7 @@ is made permanent.

The release handler at a node running on a diskless machine, or with a read-only file system, must be configured accordingly - using the following SASL configuration parameters (for + using the following SASL configuration parameters (for details, see sasl(6)):

masters @@ -287,7 +287,7 @@ returned, the emulator is restarted before the upgrade instructions are executed. This occurs if the emulator or any of the applications - Kernel, STDLIB, or SASL + Kernel, STDLIB, or SASL are updated. The new emulator version and these core applications execute after the restart. For all other applications the old versions are @@ -310,13 +310,13 @@ code_change_timeout

Defines the time-out for all calls to - stdlib:sys:change_code. + sys:change_code. If no value is specified or default is specified, the default value defined in sys is used.

 suspend_timeout

Defines the time-out for all calls to - stdlib:sys:suspend. + sys:suspend. If no value is specified, the values defined by the Timeout parameter of the upgrade or suspend instructions are used. If default is specified, the default value defined in @@ -342,7 +342,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]). => {ok,NewVsn}

If NewVsn is installed with option {update_paths,true}, then - kernel:code:lib_dir(myapp) + code:lib_dir(myapp) returns /home/user/myapp-1.0.

 @@ -801,7 +801,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]). is an atom named from the Posix error codes, such as enoent, eacces, or eisdir. See file(3) - in Kernel.

+ in Kernel.

Posix

Some file operation failed, as for the previous item in the list.

 diff --git a/lib/sasl/doc/src/sasl_app.xml b/lib/sasl/doc/src/sasl_app.xml index 52f449c2a8..0576397f9b 100644 --- a/lib/sasl/doc/src/sasl_app.xml +++ b/lib/sasl/doc/src/sasl_app.xml @@ -31,17 +31,17 @@ sasl The SASL application -

The SASL application provides the following services:

+

The SASL application provides the following services:

alarm_handler rb release_handler systools -

The SASL application also includes error_logger event - handlers for formatting SASL error and crash reports.

+

The SASL application also includes error_logger event + handlers for formatting SASL error and crash reports.

-

The SASL application in OTP has nothing to do with +

The SASL application in OTP has nothing to do with "Simple Authentication and Security Layer" (RFC 4422).

 @@ -49,7 +49,7 @@
Error Logger Event Handlers

The following error logger event handlers are used by - the SASL application.

+ the SASL application.

sasl_report_tty_h @@ -57,7 +57,7 @@ reports, and progress reports to stdio. This error logger event handler uses error_logger_format_depth - in the Kernel application to limit how much detail is + in the Kernel application to limit how much detail is printed in crash and supervisor reports.

 sasl_report_file_h @@ -66,7 +66,7 @@ report, and progress report to a single file. This error logger event handler uses error_logger_format_depth - in the Kernel application to limit the details + in the Kernel application to limit the details printed in crash and supervisor reports.

log_mf_h @@ -75,9 +75,9 @@ error logger to disk. Multiple files and log rotation are used. For efficiency reasons, each event is written as a binary. For more information about this handler, - see the STDLIB Reference + see the STDLIB Reference Manual.

-

To activate this event handler, three SASL +

To activate this event handler, three SASL configuration parameters must be set, error_logger_mf_dir, error_logger_mf_maxbytes, and error_logger_mf_maxfiles. The next section provides @@ -88,9 +88,9 @@

Configuration -

The following configuration parameters are defined for the SASL +

The following configuration parameters are defined for the SASL application. For more information about configuration parameters, see - app(4) in Kernel.

+ app(4) in Kernel.

All configuration parameters are optional.

@@ -112,7 +112,7 @@ Use [append] to have the FileName open in append mode. FileName is a string.

false -

No SASL error logger handler is installed.

 +

No SASL error logger handler is installed.

 diff --git a/lib/sasl/doc/src/sasl_intro.xml b/lib/sasl/doc/src/sasl_intro.xml index b71dafb192..f74a7c1db8 100644 --- a/lib/sasl/doc/src/sasl_intro.xml +++ b/lib/sasl/doc/src/sasl_intro.xml @@ -32,7 +32,7 @@
Scope -

The SASL application provides support for:

+

The SASL application provides support for:

Error logging Alarm handling diff --git a/lib/sasl/doc/src/systools.xml b/lib/sasl/doc/src/systools.xml index 7446762de4..fa503fa573 100644 --- a/lib/sasl/doc/src/systools.xml +++ b/lib/sasl/doc/src/systools.xml @@ -85,7 +85,7 @@

If the emulator needs to be restarted after upgrading or - downgrading, that is, if the ERTS version differs + downgrading, that is, if the ERTS version differs between Name.rel and Name2.rel

 @@ -201,10 +201,10 @@ between the applications. Where there are no dependencies, the order in the .rel file is kept.

The function fails if the mandatory - applications Kernel and STDLIB are not + applications Kernel and STDLIB are not included in the .rel file and have start type permanent (which is default).

-

If SASL is not included as an application in +

If SASL is not included as an application in the .rel file, a warning is issued because such a release cannot be used in an upgrade. To turn off this warning, add option no_warn_sasl.

-- cgit v1.2.3