Bug#573837: lintian: [checks/manpages] [PATCH] improved checks/manpages.desc::manpage-has-bad-whatis-entry
Jari Aalto <jari.aalto@cante.net> writes:
> The patch:
Thanks, I've applied a portion of this.
> - Explain TH and NAME problems in more detail (what to look for)
The additional explanation of the syntax restrictions, particularly the
part about spaces, is good. I reworded it a bit and gave an example. The
mention of TH I left out, since TH doesn't have anything to do with this
tag; so far as I can tell, lexgrog doesn't care what you put in the TH
header.
> - Use parentheses to refer to program names: whatis(1). Tools,
> can use the information to manual pgae entries for programs
> from the listing.
This part I've not applied. Lintian tag descriptions are not manual
pages, and adding manpage sections after every mentioned tool just strikes
me as visual clutter. (Even in manpages, I think this convention is
overused.) Lintian already has an explicit way of adding references to
man pages where appropriate, which was already used for lexgrog(1) (which
is where the details for this particular tag are).
--
Russ Allbery (rra@debian.org) <http://www.eyrie.org/~eagle/>
Reply to: