From 92d93f85e88235f3fa757d300628d382d09c6226 Mon Sep 17 00:00:00 2001 From: Siri Hansen Date: Wed, 9 May 2018 14:28:44 +0200 Subject: Fix some link errors in logger documentation --- lib/kernel/doc/src/error_logger.xml | 18 +++++++++++------- lib/kernel/doc/src/kernel_app.xml | 7 +++---- lib/kernel/doc/src/logger_chapter.xml | 10 +++++----- lib/sasl/doc/src/sasl_app.xml | 12 ++++-------- 4 files changed, 23 insertions(+), 24 deletions(-) diff --git a/lib/kernel/doc/src/error_logger.xml b/lib/kernel/doc/src/error_logger.xml index cb6165c73e..c9fe9484e4 100644 --- a/lib/kernel/doc/src/error_logger.xml +++ b/lib/kernel/doc/src/error_logger.xml @@ -181,17 +181,21 @@ ok Get the value of the Kernel application variable - logger_format_depth. + error_logger_format_depth.

Returns max(10, Depth), where Depth is the - value of - - logger_format_depth + value of error_logger_format_depth in the Kernel application, if Depth is an integer. Otherwise, unlimited is returned.

-

For backwards compatibility, the value - of error_logger_format_depth is used - if logger_format_depth is not set.

+ +

The error_logger_format_depth variable + is + deprecated since + the Logger API was + introduced in OTP-21. The variable, and this function, are + kept for backwards compatibility since they still might be + used by legacy report handlers.

+ diff --git a/lib/kernel/doc/src/kernel_app.xml b/lib/kernel/doc/src/kernel_app.xml index ebc7962f29..7cd05dab14 100644 --- a/lib/kernel/doc/src/kernel_app.xml +++ b/lib/kernel/doc/src/kernel_app.xml @@ -181,11 +181,10 @@

This parameter specifies which log levels to log. The specified level, and all levels that are more severe, will be logged.

-

It is possible to change this variable at run-time - using - logger:set_logger_config(#{ level => error }). - .

The default value is info.

+

To change the global log level at run-time, use + + logger:set_logger_config(level, error).

logger_sasl_compatible = boolean() diff --git a/lib/kernel/doc/src/logger_chapter.xml b/lib/kernel/doc/src/logger_chapter.xml index 484358f392..4232429589 100644 --- a/lib/kernel/doc/src/logger_chapter.xml +++ b/lib/kernel/doc/src/logger_chapter.xml @@ -136,7 +136,7 @@

Filters can be set on the logger or on a handler. Logger filters are applied first, and if passed, the handler filters - for each handler are applied. The handler plugin is only + for each handler are applied. The handler callback is only called if all handler filters for the handler in question also pass.

@@ -159,7 +159,7 @@ format(Log,Extra) -> unicode:chardata() -

The formatter plugin is called by each handler, and the +

The formatter callback is called by each handler, and the returned string can be printed to the handler's destination (stdout, file, ...).

 @@ -214,8 +214,8 @@ logger_filters:level/2

This filter provides a way of filtering log events based - on the log level. See - logger_filters:domain/2

+ on the log level. See + logger_filters:level/2

 logger_filters:progress/2 @@ -518,7 +518,7 @@ error_logger:add_report_handler/1,2. handler named sasl_h.

All SASL reports have a metadata field domain=>[beam,erlang,otp,sasl], which can be - used, for example, by filters to to stop or allow the + used, for example, by filters to stop or allow the events.

diff --git a/lib/sasl/doc/src/sasl_app.xml b/lib/sasl/doc/src/sasl_app.xml index 48b0b8eafb..8f92a22cf7 100644 --- a/lib/sasl/doc/src/sasl_app.xml +++ b/lib/sasl/doc/src/sasl_app.xml @@ -119,22 +119,18 @@

Formats and writes supervisor reports, crash reports, and progress reports to stdio. This error logger event handler uses - logger_format_depth + error_logger_format_depth in the Kernel application to limit how much detail is printed - in crash and supervisor reports. If logger_format_depth - is not set, it uses the old error_logger_format_depth - instead.

+ in crash and supervisor reports.

sasl_report_file_h

Formats and writes supervisor reports, crash report, and progress report to a single file. This error logger event handler uses - logger_format_depth + error_logger_format_depth in the Kernel application to limit the details printed in - crash and supervisor reports. If logger_format_depth is - not set, it uses the old error_logger_format_depth - instead.

+ crash and supervisor reports.

A similar behaviour, but still using the new logger API, can be -- cgit v1.2.3