GNU bug report logs - #76435
[PATCH] Shepherd: build: Improve man-page synopsis.

Message received at submit <at> debbugs.gnu.org:

Received: (at submit) by debbugs.gnu.org; 20 Feb 2025 07:48:49 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Thu Feb 20 02:48:49 2025
Received: from localhost ([127.0.0.1]:59163 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1tl1Id-0006bJ-Uv
	for submit <at> debbugs.gnu.org; Thu, 20 Feb 2025 02:48:48 -0500
Received: from lists.gnu.org ([2001:470:142::17]:34214)
 by debbugs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.84_2) (envelope-from <simon@HIDDEN>)
 id 1tl1Ia-0006aN-KW
 for submit <at> debbugs.gnu.org; Thu, 20 Feb 2025 02:48:45 -0500
Received: from eggs.gnu.org ([2001:470:142:3::10])
 by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.90_1) (envelope-from <simon@HIDDEN>)
 id 1tl1IU-0001bu-St
 for guix-patches@HIDDEN; Thu, 20 Feb 2025 02:48:38 -0500
Received: from uggla.sjd.se ([2001:9b1:8633::107])
 by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.90_1) (envelope-from <simon@HIDDEN>)
 id 1tl1IR-0002SX-DQ
 for guix-patches@HIDDEN; Thu, 20 Feb 2025 02:48:38 -0500
DKIM-Signature: v=1; a=ed25519-sha256; q=dns/txt; c=relaxed/relaxed;
 d=josefsson.org; s=ed2303; h=Content-Type:MIME-Version:Message-ID:Date:
 Subject:To:From:Sender:Reply-To:Cc:Content-Transfer-Encoding:Content-ID:
 Content-Description; bh=cFiH75vO4kUyzkz3iv5ZAmbQN27WbqG0K00lRyIyRyE=;
 t=1740037698; x=1741247298; b=xTK6k8JNQnh4I/TX1AaPVSP8rsnzENuWLMpINKSGH9fD/Kx
 uQvqoKvc7XMBikcwtY67OduEHujlUeIYE2pE9DA==;
DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed;
 d=josefsson.org; s=rsa2303; h=Content-Type:MIME-Version:Message-ID:Date:
 Subject:To:From:Sender:Reply-To:Cc:Content-Transfer-Encoding:Content-ID:
 Content-Description; bh=cFiH75vO4kUyzkz3iv5ZAmbQN27WbqG0K00lRyIyRyE=;
 t=1740037698; x=1741247298; b=UeAnBfXmRm4RjKe8UOV70a57NJ8LnSaT9dxifCesWLXgUkD
 9upDACMxkSFmPMteaUIv39VxhBaZghnapM8LEUQpy9LKV/uxOQMXEZWMaaHy4Sbk0h65oT5zL8jhF
 IeN1GlbRCNCgmNmM+0wNGVeHNpm5qotPtPrzFY1FNR0gHk7GyYl38hCR8n9HzIJ6BzMXHNVDDy3LS
 DTmYF/pgvIfdU3teTnc8vXE4AqJ4HJ8bH30Ttk3xzGBHQw4SAldcggm03AAfcPeTd7It6DgDCtCI+
 LV18uCrztg5uRryhAArIIj0pjltCPOqtc5rmXHRatKsyRT4DrAGU5yR/YTqH99jqahusV56q6HwVS
 +bObTvjE+D/GbnYJE6mKq4fsxrPyluH1sx5lpdX7JD0eyOPgh1uaKgjhUFRKXdn24K0iYvyoLVlr4
 MofvRzzBhPgQ+XI0FPOTh11D;
Received: from h-178-174-130-130.a498.priv.bahnhof.se ([178.174.130.130]:48200
 helo=kaka) by uggla.sjd.se with esmtpsa (TLS1.3) tls
 TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.95)
 (envelope-from <simon@HIDDEN>) id 1tl1I6-0006G1-4K
 for guix-patches@HIDDEN; Thu, 20 Feb 2025 07:48:14 +0000
From: Simon Josefsson <simon@HIDDEN>
To: guix-patches@HIDDEN
Subject: [PATCH] Shepherd: build: Improve man-page synopsis.
OpenPGP: id=B1D2BD1375BECB784CF4F8C4D73CF638C53C06BE;
 url=https://josefsson.org/key-20190320.txt
X-Hashcash: 1:23:250220:guix-patches@HIDDEN::mom21V+YP8/HI0ub:6K3g
Date: Thu, 20 Feb 2025 08:48:19 +0100
Message-ID: <87ikp5xdj0.fsf@HIDDEN>
User-Agent: Gnus/5.13 (Gnus v5.13)
MIME-Version: 1.0
Content-Type: multipart/signed; boundary="==-=-=";
 micalg=pgp-sha256; protocol="application/pgp-signature"
Received-SPF: pass client-ip=2001:9b1:8633::107;
 envelope-from=simon@HIDDEN; helo=uggla.sjd.se
X-Spam_score_int: -43
X-Spam_score: -4.4
X-Spam_bar: ----
X-Spam_report: (-4.4 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1,
 DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1,
 RCVD_IN_DNSWL_MED=-2.3, SPF_HELO_PASS=-0.001,
 SPF_PASS=-0.001 autolearn=ham autolearn_force=no
X-Spam_action: no action
X-Spam-Score: 0.9 (/)
X-Debbugs-Envelope-To: submit
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -0.1 (/)

--==-=-=
Content-Type: multipart/mixed; boundary="=-=-="

--=-=-=
Content-Type: text/plain

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

--=-=-=
Content-Type: text/x-diff
Content-Disposition: inline;
 filename=0001-build-Improve-man-page-NAME-whatis-string.patch
Content-Transfer-Encoding: quoted-printable

From=2079e829e239f8a00cdbc32db43392385b09e43461 Mon Sep 17 00:00:00 2001
From: Simon Josefsson <simon@HIDDEN>
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.
=2D--
 Makefile.am | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/Makefile.am b/Makefile.am
index 79de974..afad8ba 100644
=2D-- a/Makefile.am
+++ b/Makefile.am
@@ -132,10 +132,12 @@ HELP2MANFLAGS =3D --source=3DGNU --info-page=3D$(PACK=
AGE_TARNAME)
 gen_man =3D $(AM_V_HELP2MAN)LANGUAGE=3D $(HELP2MAN) $(HELP2MANFLAGS)
=20
 doc/shepherd.1: modules/shepherd.scm configure.ac
=2D	$(gen_man) --output=3D"$@" "$(top_builddir)/`basename "$@" .1`"
+	$(gen_man) --name=3D"Service manager for the GNU system" \
+	--output=3D"$@" "$(top_builddir)/`basename "$@" .1`"
=20
=2Ddoc/%.1: modules/shepherd/scripts/%.scm configure.ac
=2D	$(gen_man) --output=3D"$@" "$(top_builddir)/`basename "$@" .1`"
+doc/herd.1: modules/shepherd/scripts/herd.scm configure.ac
+	$(gen_man) --name=3D"Control the shepherd(1) service manager" \
+	--output=3D"$@" "$(top_builddir)/`basename "$@" .1`"
=20
 doc/%.8: modules/shepherd/scripts/%.scm configure.ac
 	$(gen_man) --section=3D8 --output=3D"$@"	\
=2D-=20
2.48.1


--=-=-=--

--==-=-=
Content-Type: application/pgp-signature; name="signature.asc"

-----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-----
--==-=-=--