Simon Josefsson wrote 3 weeks ago
(address . guix-patches@gnu.org)
87ikp5xdj0.fsf@josefsson.org
Hi,
Shepherd's shepherd.1 and herd.1 man pages does not include any
explanation of what the tools do. This makes Debian's QA tools
complain. The attached patch fixes this.
I changed the catch-all %.1 rule into herd.1 because it was the only
match right now. I think it is better if rules are added per man page
going forward to make sure that "--name" is passed properly.
An alternative solution would be to use a help2man --include parameter
and a separate herd.h2m and shepherd.h2m file that include the relevant
text, but it felt more complex than what was needed to resolve the
original problem.
/Simon
From 79e829e239f8a00cdbc32db43392385b09e43461 Mon Sep 17 00:00:00 2001
From: Simon Josefsson <simon@josefsson.org>
Date: Thu, 20 Feb 2025 08:41:57 +0100
Subject: [PATCH] build: Improve man-page NAME whatis string.
* Makefile.am (shepherd.1): Add --name.
(%.1, herd.1): Rename to add --name.
---
Makefile.am | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
Toggle diff (22 lines)
diff --git a/Makefile.am b/Makefile.am
index 79de974..afad8ba 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -132,10 +132,12 @@ HELP2MANFLAGS = --source=GNU --info-page=$(PACKAGE_TARNAME)
gen_man = $(AM_V_HELP2MAN)LANGUAGE= $(HELP2MAN) $(HELP2MANFLAGS)
doc/shepherd.1: modules/shepherd.scm configure.ac
- $(gen_man) --output="$@" "$(top_builddir)/`basename "$@" .1`"
+ $(gen_man) --name="Service manager for the GNU system" \
+ --output="$@" "$(top_builddir)/`basename "$@" .1`"
-doc/%.1: modules/shepherd/scripts/%.scm configure.ac
- $(gen_man) --output="$@" "$(top_builddir)/`basename "$@" .1`"
+doc/herd.1: modules/shepherd/scripts/herd.scm configure.ac
+ $(gen_man) --name="Control the shepherd(1) service manager" \
+ --output="$@" "$(top_builddir)/`basename "$@" .1`"
doc/%.8: modules/shepherd/scripts/%.scm configure.ac
$(gen_man) --section=8 --output="$@" \
--
2.48.1
-----BEGIN PGP SIGNATURE-----
iQNoBAEWCAMQFiEEo8ychwudMQq61M8vUXIrCP5HRaIFAme23kMUHHNpbW9uQGpv
c2Vmc3Nvbi5vcmfCHCYAmDMEXJLOtBYJKwYBBAHaRw8BAQdACIcrZIvhrxDBkK9f
V+QlTmXxo2naObDuGtw58YaxlOu0JVNpbW9uIEpvc2Vmc3NvbiA8c2ltb25Aam9z
ZWZzc29uLm9yZz6IlgQTFggAPgIbAwULCQgHAgYVCAkKCwIEFgIDAQIeAQIXgBYh
BLHSvRN1vst4TPT4xNc89jjFPAa+BQJl/YgIBQkLehFUAAoJENc89jjFPAa+CboA
+wUa06RD5e5VTCxvSWtPS75Wq2qBeYGZnf0jvUMxa2n4AP4xkUeAPPnNuMsTm2fs
FCDIGaEM2Yn6Vb2huzzT1Fw/BLgzBFySz4EWCSsGAQQB2kcPAQEHQOxTCIOaeXAx
I2hIX4HK9bQTpNVei708oNr1Klm8qCGKiPUEGBYIACYCGwIWIQSx0r0Tdb7LeEz0
+MTXPPY4xTwGvgUCZf2IKwUJC3oQqgCBdiAEGRYIAB0WIQSjzJyHC50xCrrUzy9R
cisI/kdFogUCXJLPgQAKCRBRcisI/kdFoqdMAQCgH45aseZgIrwKOvUOA9QfsmeE
8GZHYNuFHmM9FEQS6AD6A4x5aYvoY6lo98pgtw2HPDhmcCXFItjXCrV4A0GmJA4J
ENc89jjFPAa+GcYA/26YQY05bLtnXiIjTiAzrGQrRXxTHPA8Av7TDFHvIetWAP9s
HSoU8OfTwmTiEnGwLlsV7QJclZg3YNz/Ypcp9TqQBrg4BFySz2oSCisGAQQBl1UB
BQEBB0AxlRumDW6nZY7A+VCfek9VpEx6PJmdJyYPt3lNHMd6HAMBCAeIfgQYFggA
JgIbDBYhBLHSvRN1vst4TPT4xNc89jjFPAa+BQJl/YgwBQkLehDGAAoJENc89jjF
PAa+phoA/jrDqIrl/55vUMBhIQv+TP635d2iCTEnyFmbUcP9+gh6APoDsXalVd2c
OGxQtSC+TF8PkZMn1TLkJKAjVxr+xx40AgAKCRBRcisI/kdFooNXAP9tgpbI4NO7
9A1+rjp3gIUZKLEfucmahnTFnhYZfpkoyAD+JreuUvapGhQtTbXyT87qL96mYppc
t6i3EigwRXfkGAI=
=VhaV
-----END PGP SIGNATURE-----