From 6d399fa6b09fc620d377b26a48f639cbeaea9d6e Mon Sep 17 00:00:00 2001
From: Richard Carlsson
Date: Wed, 16 Oct 2013 23:59:37 +0200
Subject: Fix confusing documentation about error handlers in SASL
The SASL documentation confusingly talks about a handler 'error_logger_mf_h'
which doesn't actually exist. The handler is named 'log_mf_h', and it and
all other error handlers used by SASL are part of stdlib, not SASL itself.
This patch makes the documentation clearer.
---
lib/sasl/doc/src/sasl_app.xml | 13 ++++++-------
1 file changed, 6 insertions(+), 7 deletions(-)
(limited to 'lib/sasl/doc/src/sasl_app.xml')
diff --git a/lib/sasl/doc/src/sasl_app.xml b/lib/sasl/doc/src/sasl_app.xml
index 446baccb08..af9e73027f 100644
--- a/lib/sasl/doc/src/sasl_app.xml
+++ b/lib/sasl/doc/src/sasl_app.xml
@@ -51,7 +51,7 @@
Error Logger Event Handlers
- The following error logger event handlers are defined in
+
The following error logger event handlers are used by
the SASL application.
sasl_report_tty_h
@@ -62,11 +62,10 @@
-
Formats and writes supervisor reports, crash report and progress report to a single file.
- error_logger_mf_h
+ log_mf_h
-
This error logger writes all events sent to
- the error logger to disk. It installs the log_mf_h
- event handler in the error_logger process.
+ the error logger to disk.
To activate this event handler, the following three sasl
configuration parameters must be set:
error_logger_mf_dir, error_logger_mf_maxbytes
@@ -109,18 +108,18 @@
-
Specifies in which directory the files are stored. If this
parameter is undefined or false,
- the error_logger_mf_h is not installed.
+ the log_mf_h handler is not installed.
]]>
-
Specifies how large each individual file can be. If this
- parameter is undefined, the error_logger_mf_h is not
+ parameter is undefined, the log_mf_h handler is not
installed.
]]>
-
Specifies how many files are used. If this parameter is
- undefined, the error_logger_mf_h is not installed.
+ undefined, the log_mf_h handler is not installed.
0 ]]>
-
--
cgit v1.2.3