diff options
author | Ingo Schwarze <schwarze@openbsd.org> | 2018-12-20 18:24:12 +0000 |
---|---|---|
committer | Ingo Schwarze <schwarze@openbsd.org> | 2018-12-20 18:24:12 +0000 |
commit | 6d8b57c2bf0f2a068fd3afcf726ac347de200de5 (patch) | |
tree | 228266dff1f20b33768ea58488e099c920f71887 | |
parent | 7555290d19eb4ba2c9ccec884db5c224fa97c98d (diff) | |
download | mandoc-6d8b57c2bf0f2a068fd3afcf726ac347de200de5.tar.gz |
Explain what the fields in mandoc messages mean,
rather than merely specifying the message syntax.
Gap in documentation found while looking at a bug
report from Raf Czlonka <rczlonka at gmail dot com>.
-rw-r--r-- | mandoc.1 | 22 |
1 files changed, 19 insertions, 3 deletions
@@ -714,13 +714,29 @@ Messages displayed by follow this format: .Bd -ragged -offset indent .Nm : -.Ar file : Ns Ar line : Ns Ar column : level : message : macro args +.Ar file : Ns Ar line : Ns Ar column : level : message : macro arguments .Pq Ar os .Ed .Pp -Line and column numbers start at 1. +The first three fields identify the +.Ar file +name, +.Ar line +number, and +.Ar column +number of the input file where the message was triggered. +The line and column numbers start at 1. Both are omitted for messages referring to an input file as a whole. -Macro names and arguments are omitted where meaningless. +All +.Ar level +and +.Ar message +strings are explained below. +The name of the +.Ar macro +triggering the message and its +.Ar arguments +are omitted where meaningless. The .Ar os operating system specifier is omitted for messages that are relevant |