summaryrefslogtreecommitdiffstats
path: root/mandoc.3
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@openbsd.org>2017-01-09 01:37:03 +0000
committerIngo Schwarze <schwarze@openbsd.org>2017-01-09 01:37:03 +0000
commit6769f9615389aedbeaaf3a3c3153aec49c88954c (patch)
tree2c7cd176802f9d756266208308bdd826d26a0e86 /mandoc.3
parent84899683ac7364eaba7f2fbd1ff194612d1a7db0 (diff)
downloadmandoc-6769f9615389aedbeaaf3a3c3153aec49c88954c.tar.gz
Warnings and errors that occur during mdoc_validate()
or during man_validate() have to affect the mandoc(1) EXIT STATUS. Many thanks to <Yuri dot Pankov at gmail dot com> (illumos developer) for reporting this regression.
Diffstat (limited to 'mandoc.3')
-rw-r--r--mandoc.329
1 files changed, 27 insertions, 2 deletions
diff --git a/mandoc.3 b/mandoc.3
index d1471c97..9485c554 100644
--- a/mandoc.3
+++ b/mandoc.3
@@ -1,7 +1,7 @@
.\" $Id$
.\"
.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
-.\" Copyright (c) 2010-2016 Ingo Schwarze <schwarze@openbsd.org>
+.\" Copyright (c) 2010-2017 Ingo Schwarze <schwarze@openbsd.org>
.\"
.\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
@@ -34,7 +34,8 @@
.Nm mparse_reset ,
.Nm mparse_result ,
.Nm mparse_strerror ,
-.Nm mparse_strlevel
+.Nm mparse_strlevel ,
+.Nm mparse_updaterc
.Nd mandoc macro compiler library
.Sh SYNOPSIS
.In sys/types.h
@@ -100,6 +101,11 @@
.Fo mparse_strlevel
.Fa "enum mandoclevel"
.Fc
+.Ft void
+.Fo mparse_updaterc
+.Fa "struct mparse *parse"
+.Fa "enum mandoclevel *rc"
+.Fc
.In roff.h
.Ft void
.Fo deroff
@@ -181,6 +187,9 @@ or
.Fn man_validate ,
respectively;
.It
+if information about the validity of the input is needed, fetch it with
+.Fn mparse_updaterc ;
+.It
iterate over parse nodes with starting from the
.Fa first
member of the returned
@@ -416,6 +425,22 @@ Declared in
.In mandoc.h ,
implemented in
.Pa read.c .
+.It Fn mparse_updaterc
+If the highest warning or error level that occurred during the current
+.Fa parse
+is higher than
+.Pf * Fa rc ,
+update
+.Pf * Fa rc
+accordingly.
+This is useful after calling
+.Fn mdoc_validate
+or
+.Fn man_validate .
+Declared in
+.In mandoc.h ,
+implemented in
+.Pa read.c .
.El
.Ss Variables
.Bl -ohang