Bug#1042428: qa.debian.org: Missing description for lintian warning tags (https://udd.debian.org/lintian/?packages=)
On 7/28/23 09:09, Christian Buhtz wrote:
To less experienced users it is not clear what this tags do mean. The
explanation should be linked somehow.
You can get the tag description from lintian-explain-tags:
$ lintian-explain-tags -t groff-message
N:
W: groff-message
N:
N: A manual page provoked warnings or errors from the man program.
Here are some common ones:
N:
N: "cannot adjust" or "can't break" are issues with paragraph filling.
They are usually related to long lines. Justifying text on the left hand
side can help with adjustments. Hyphenation can help with breaks.
N:
N: For more information, please see "Manipulating Filling and
Adjusting" and "Manipulating Hyphenation" in the Groff manual (see info
groff).
N:
N: "can't find numbered character" usually means that the input was in
a national legacy encoding. The warning means that some characters were
dropped. Please use escapes such as \[:a] as described on the groff_char
manual page.
N:
N: Other common warnings are formatting typos. String arguments to .IP
require quotes. Usually, some text is lost or mangled. See the groff_man
(or groff_mdoc if using mdoc) manual page for details on macros.
N:
N: The check for manual pages uses the --warnings option to man to
catch common problems, like a . or a ' at the beginning of a line as
literal text. They are interpreted as Groff commands. Just reformat the
paragraph so the
N: characters are not at the beginning of a line. You can also add a
zero-width space (\&) in front of them.
N:
N: Aside from overrides, warnings can be disabled with the .warn
directive. Please see "Debugging" in the Groff manual.
N:
N: You can see the warnings yourself by running the command used by
Lintian:
N:
N: LC_ALL=C.UTF-8 MANROFFSEQ='' MANWIDTH=80 \
N: man --warnings -E UTF-8 -l -Tutf8 -Z <file> >/dev/null
N:
N: Please refer to the groff_man(7) manual page and the groff_mdoc(7)
manual page for details.
N:
N: Visibility: warning
N: Show-Always: no
N: Check: documentation/manual
N: Renamed from: manpage-has-errors-from-man
N:
Kind Regards,
Bas
--
GPG Key ID: 4096R/6750F10AE88D4AF1
Fingerprint: 8182 DE41 7056 408D 6146 50D1 6750 F10A E88D 4AF1
Reply to: