diff options
author | Ingo Schwarze <schwarze@openbsd.org> | 2018-12-14 01:18:25 +0000 |
---|---|---|
committer | Ingo Schwarze <schwarze@openbsd.org> | 2018-12-14 01:18:25 +0000 |
commit | f23ef2791d6fed38e2418e7816d449e955da3808 (patch) | |
tree | a0f0c7d4784735ec3a345d1726ce53d8315ba7d8 /mandoc.3 | |
parent | 89b87d6d86473296fb35daf3da277607a4811967 (diff) | |
download | mandoc-f23ef2791d6fed38e2418e7816d449e955da3808.tar.gz |
Major cleanup; may imply minor changes in edge cases of error reporting.
Finally, drop support for the run-time configurable mandocmsg()
callback. It was over-engineered from the start, never used for
anything in a decade, and repeatedly caused maintenance headaches.
Consolidate reporting infrastructure into two files, mandoc.h and
mandoc_msg.c, mopping up the bits and pieces that were scattered
around main.c, read.c, mandoc_parse.h, libmandoc.h, the prototypes
of four parsing-related functions, and both parser structs.
Diffstat (limited to 'mandoc.3')
-rw-r--r-- | mandoc.3 | 82 |
1 files changed, 3 insertions, 79 deletions
@@ -21,7 +21,6 @@ .Sh NAME .Nm mandoc , .Nm deroff , -.Nm mandocmsg , .Nm man_validate , .Nm mdoc_validate , .Nm mparse_alloc , @@ -30,13 +29,11 @@ .Nm mparse_open , .Nm mparse_readfd , .Nm mparse_reset , -.Nm mparse_result , -.Nm mparse_strerror , -.Nm mparse_strlevel , -.Nm mparse_updaterc +.Nm mparse_result .Nd mandoc macro compiler library .Sh SYNOPSIS .In sys/types.h +.In stdio.h .In mandoc.h .Pp .Fd "#define ASCII_NBRSP" @@ -45,21 +42,10 @@ .Ft struct mparse * .Fo mparse_alloc .Fa "int options" -.Fa "enum mandocerr mmin" -.Fa "mandocmsg mmsg" .Fa "enum mandoc_os oe_e" .Fa "char *os_s" .Fc .Ft void -.Fo (*mandocmsg) -.Fa "enum mandocerr errtype" -.Fa "enum mandoclevel level" -.Fa "const char *file" -.Fa "int line" -.Fa "int col" -.Fa "const char *msg" -.Fc -.Ft void .Fo mparse_free .Fa "struct mparse *parse" .Fc @@ -72,7 +58,7 @@ .Fa "struct mparse *parse" .Fa "const char *fname" .Fc -.Ft "enum mandoclevel" +.Ft void .Fo mparse_readfd .Fa "struct mparse *parse" .Fa "int fd" @@ -88,19 +74,6 @@ .Fa "struct roff_man **man" .Fa "char **sodest" .Fc -.Ft "const char *" -.Fo mparse_strerror -.Fa "enum mandocerr" -.Fc -.Ft "const char *" -.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 @@ -222,9 +195,6 @@ and freed with This may be used across parsed input if .Fn mparse_reset is called between parses. -.It Vt "mandocmsg" -A prototype for a function to handle error and warning -messages emitted by the parser. .El .Ss Functions .Bl -ohang @@ -289,24 +259,6 @@ This is for example useful in .Xr makewhatis 8 .Fl Q to quickly build minimal databases. -.It Ar mmin -Can be set to -.Dv MANDOCERR_BASE , -.Dv MANDOCERR_STYLE , -.Dv MANDOCERR_WARNING , -.Dv MANDOCERR_ERROR , -.Dv MANDOCERR_UNSUPP , -or -.Dv MANDOCERR_MAX . -Messages below the selected level will be suppressed. -.It Ar mmsg -A callback function to handle errors and warnings. -See -.Pa main.c -for an example. -If printing of error messages is not desired, -.Dv NULL -may be passed. .It Ar os_e Operating system to check base system conventions for. If @@ -400,34 +352,6 @@ Declared in .In mandoc.h , implemented in .Pa read.c . -.It Fn mparse_strerror -Return a statically-allocated string representation of an error code. -Declared in -.In mandoc.h , -implemented in -.Pa read.c . -.It Fn mparse_strlevel -Return a statically-allocated string representation of a level code. -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 |