summaryrefslogtreecommitdiff
path: root/docs/modules
diff options
context:
space:
mode:
authorDan Allen <dan.j.allen@gmail.com>2021-11-10 23:52:21 -0700
committerDan Allen <dan.j.allen@gmail.com>2021-11-11 00:17:59 -0700
commit210efb65b3b7c984aa399ec22c61fec2e01a6edd (patch)
tree008900558da3360f04e99b994a57eca94657d7cd /docs/modules
parent843d8bde649ea10d33270e4925d87a0786815aac (diff)
revise errors and warnings page for accuracy
- add mention of debug level - highlight aliases for level labels - change fail to fatal
Diffstat (limited to 'docs/modules')
-rw-r--r--docs/modules/ROOT/pages/errors-and-warnings.adoc21
1 files changed, 15 insertions, 6 deletions
diff --git a/docs/modules/ROOT/pages/errors-and-warnings.adoc b/docs/modules/ROOT/pages/errors-and-warnings.adoc
index 4d9e1613..624d4641 100644
--- a/docs/modules/ROOT/pages/errors-and-warnings.adoc
+++ b/docs/modules/ROOT/pages/errors-and-warnings.adoc
@@ -1,21 +1,30 @@
= Errors and Warnings
-All application messages (i.e., info, warning, error, or failure) emitted by Asciidoctor are written to the logger.
+All application messages (i.e., debug, info, warning, error, or fatal) emitted by Asciidoctor are written to the logger.
+By default, only warning, error, and fatal messages are logged.
When using the CLI, the logger routes messages to the console via stderr (i.e., standard error).
== Notification types
+DEBUG::
+Debug messages provide insight into what the software is doing and can be useful for tracking down problems or unexpected behavior.
+Currently, Asciidoctor does not log any messages at this level.
+However, extensions may do so.
+
<<info,INFO>>::
Info messages do not stop conversion, but they indicate possible problems, and the output may not be what you were expecting.
-<<warning,WARNING>>::
+<<warning,WARN>> (WARNING)::
Warnings do not stop conversion, but they indicate likely problems, and the output probably won't be what you were expecting.
+In the CLI output, Asciidoctor labels these messages as `WARNING` rather than `WARN`.
<<error,ERROR>>::
Errors do not stop conversion, but the output document will almost certainly be wrong.
-<<fail,FAILED>>::
+<<fatal,FATAL>> (FAILED)::
Failures are fatal; no output document will be produced.
+If the `--trace` CLI option is specified, the message may be accompanied by a stacktrace.
+In the CLI output, Asciidoctor labels these messages as `FAILED` rather than `FATAL`.
The messages listed in the following sections may contain some of the following representative placeholders:
@@ -198,14 +207,14 @@ Check section levels.
|Check for missing cell separator characters at the start of the line.
|===
-[#fail]
-== Failure messages
+[#fatal]
+== Fatal messages
[cols=2*]
|===
|Message |Troubleshooting
-|missing converter for backend '<x>'. Processing aborted. (RuntimeError)
+|missing converter for backend '<x>'. Processing aborted.
|You used -b with an invalid or missing backend.
//|Failed to load AsciiDoc document - undefined method `convert' for nil:NilClass