diff options
author | Ingo Schwarze <schwarze@openbsd.org> | 2014-07-01 22:37:15 +0000 |
---|---|---|
committer | Ingo Schwarze <schwarze@openbsd.org> | 2014-07-01 22:37:15 +0000 |
commit | 86806389168051f6ba486c442c442708d5e0fa73 (patch) | |
tree | fa81b7694359c83543eac5fab8d4ea9300896de1 /read.c | |
parent | 9e7d8bcb8352801ba998920b086e93c8dcad70b3 (diff) | |
download | mandoc-86806389168051f6ba486c442c442708d5e0fa73.tar.gz |
Clean up the warnings related to document structure.
* Hierarchical naming of the related enum mandocerr items.
* Mention the offending macro, section title, or string.
While here, improve some wordings:
* Descriptive instead of imperative style.
* Uniform style for "missing" and "skipping".
* Where applicable, mention the fallback used.
Diffstat (limited to 'read.c')
-rw-r--r-- | read.c | 20 |
1 files changed, 10 insertions, 10 deletions
@@ -93,26 +93,26 @@ static const char * const mandocerrs[MANDOCERR_MAX] = { "generic warning", /* related to the prologue */ - "no TH macro in document", - "document title should be all caps", + "missing .TH macro, using \"unknown 1\"", + "lower case character in document title", "unknown manual section", "unknown manual volume or arch", - "date missing, using today's date", + "missing date, using today's date", "cannot parse date, using it verbatim", "prologue macros out of order", "duplicate prologue macro", - "macro not allowed in prologue", - "macro not allowed in body", + "incomplete prologue, terminated by", + "skipping prologue macro in body", /* related to document structure */ ".so is fragile, better use ln(1)", "no document body", - "content before the first section header", - "NAME section must come first", + "content before first section header", + "first section is not \"NAME\"", "bad NAME section contents", "sections out of conventional order", - "duplicate section name", - "section header suited to sections 2, 3, and 9 only", + "duplicate section title", + "unexpected section", /* related to macros and nesting */ "skipping obsolete macro", @@ -176,7 +176,7 @@ static const char * const mandocerrs[MANDOCERR_MAX] = { "skipping bad character", "escaped character not allowed in a name", "manual name not yet set", - "skipping text before the first section header", + "skipping text before first section header", "skipping unknown macro", "NOT IMPLEMENTED, please use groff: skipping request", "argument count wrong", |