summaryrefslogtreecommitdiffstats
path: root/mandoc.1
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@openbsd.org>2017-07-07 16:20:30 +0000
committerIngo Schwarze <schwarze@openbsd.org>2017-07-07 16:20:30 +0000
commit7231369b8878630439e1847ae7436d3e65c686f4 (patch)
tree903bef965728bf3aea3a55f406427feb14eb3348 /mandoc.1
parent4d46f5a0e2832b020c0352d54dcaad3bf87e0f0e (diff)
downloadmandoc-7231369b8878630439e1847ae7436d3e65c686f4.tar.gz
Radically simplify the definitions what the message levels ERROR
and WARNING mean: minus 20 lines of mdoc source. OK jmc@.
Diffstat (limited to 'mandoc.1')
-rw-r--r--mandoc.131
1 files changed, 6 insertions, 25 deletions
diff --git a/mandoc.1 b/mandoc.1
index e738ddfd..138628a7 100644
--- a/mandoc.1
+++ b/mandoc.1
@@ -719,32 +719,13 @@ so using GNU troff instead of
.Nm
to process the file may be preferable.
.It Cm error
-An input file contains invalid syntax that cannot be safely interpreted.
-By discarding part of the input or inserting missing tokens,
-the parser is able to continue, and the error does not prevent
-generation of formatted output, but typically, preparing that
-output involves information loss, broken document structure
-or unintended formatting, no matter whether
-.Nm
-or GNU troff is used.
-In many cases, the output of
-.Nm
-and GNU troff is identical, but in some,
-.Nm
-is more resilient than GNU troff with respect to malformed input.
-.Pp
-Non-existent or unreadable input files are also reported on the
-.Cm error
-level.
-In that case, the parser cannot even be started and no output
-is produced from those input files.
+Indicates a risk of information loss or severe misformatting,
+in most cases caused by serious syntax errors.
.It Cm warning
-An input file uses obsolete, discouraged or non-portable syntax.
-All the same, the meaning of the input is unambiguous and a correct
-rendering can be produced.
-Documents causing warnings may render poorly when using other
-formatting tools instead of
-.Nm .
+Indicates a risk that the information shown or its formatting
+may mismatch the author's intent in minor ways.
+Additionally, syntax errors are classified at least as warnings,
+even if they do not usually cause misformatting.
.It Cm style
An input file uses dubious or discouraged style.
This is not a complaint about the syntax, and probably neither