aboutsummaryrefslogtreecommitdiffstatshomepage
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
commit2dfd3c7a70b99f3bd8219bc8a8365900a9bf0673 (patch)
treea2c0e50579858e887f6a5ec45081a2b6289cc721
parent6a839304b76d9277a3ad6e29ba1ca510c3c69ad3 (diff)
downloadmandoc-2dfd3c7a70b99f3bd8219bc8a8365900a9bf0673.tar.gz
mandoc-2dfd3c7a70b99f3bd8219bc8a8365900a9bf0673.tar.zst
mandoc-2dfd3c7a70b99f3bd8219bc8a8365900a9bf0673.zip
Radically simplify the definitions what the message levels ERROR
and WARNING mean: minus 20 lines of mdoc source. OK jmc@.
-rw-r--r--mandoc.135
1 files changed, 8 insertions, 27 deletions
diff --git a/mandoc.1 b/mandoc.1
index bc46def0..88ea880f 100644
--- a/mandoc.1
+++ b/mandoc.1
@@ -1,4 +1,4 @@
-.\" $Id: mandoc.1,v 1.215 2017/07/06 22:59:48 schwarze Exp $
+.\" $Id: mandoc.1,v 1.216 2017/07/07 16:20:30 schwarze Exp $
.\"
.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
.\" Copyright (c) 2012, 2014-2017 Ingo Schwarze <schwarze@openbsd.org>
@@ -15,7 +15,7 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: July 6 2017 $
+.Dd $Mdocdate: July 7 2017 $
.Dt MANDOC 1
.Os
.Sh NAME
@@ -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