summaryrefslogtreecommitdiffstats
path: root/INSTALL
diff options
context:
space:
mode:
authorAlejandro Colomar <alx@kernel.org>2022-11-09 16:01:05 +0100
committerAlejandro Colomar <alx@kernel.org>2022-12-15 20:20:21 +0100
commitb5faeb5405c8a970b05a3941023e7255051b959a (patch)
treeb732c079599aefb5ef5b467ec129e16c22b9e7a0 /INSTALL
parent13bae3d409138c97fbfce82d611d2f74ff1fdcc0 (diff)
INSTALL, Makefile, cmd.mk, lint-man.mk: Lint about '\" t' comment for tbl(1)
This is to make sure that we have correct \" t comments in the pages, which are necessary for the Debian package checker: On 8/19/22 22:21, Jakub Wilk wrote: > * Michael Kerrisk <mtk.manpages@gmail.com>, 2020-07-24 12:13: >> For 15 years or at least, I've not paid any attention to adding the >> 't' comments when I added tables to pages, and I do recall anyone >> reporting ill effects. So, I'm inclined to apply Mike's patch, but >> will hold off a moment, in case there's other feedback. > > I'm a bit late, but... > > Lintian, the Debian package checker, sets the MANROFFSEQ environment > variable to empty string as a speed optimization. This turns off > loading preprocessors that weren't explicitly declared in the source. > The lack of '\" comments can cause false positives (and maybe also > false negatives?) in Lintian. > > The use of $MANROFFSEQ for Lintian was proposed here: > https://bugs.debian.org/677874 > > Beware that the man(1) man page does not correctly explain what > $MANROFFSEQ does: <https://bugs.debian.org/971009> Also update the dependencies list, since now we also need head(1) and tail(1) for linting man(7) source. Link: <https://lore.kernel.org/linux-man/07a7d4e7-79a6-b2c3-6892-1e39a0679f27@gmail.com/T/#mcf36c8a387fd5ff4f800dc220e3dbdd229b556bd> Reported-by: Jakub Wilk <jwilk@jwilk.net> Cc: Mike Frysinger <vapier@gentoo.org> Cc: "G. Branden Robinson" <g.branden.robinson@gmail.com> Cc: Michael Kerrisk <mtk.manpages@gmail.com> Cc: Stefan Puiu <stefan.puiu@gmail.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL2
1 files changed, 2 insertions, 0 deletions
diff --git a/INSTALL b/INSTALL
index eb90c5b30..da1e53e6b 100644
--- a/INSTALL
+++ b/INSTALL
@@ -93,7 +93,9 @@ Description
- For linting man(7) source:
- eqn(1)
- grotty(1)
+ - head(1)
- mkdir(1)
+ - tail(1)
- tbl(1)
- troff(1) >= 1.23.0 - GNU troff is required.