From unknown Sat Jun 21 10:27:48 2025 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-Mailer: MIME-tools 5.509 (Entity 5.509) Content-Type: text/plain; charset=utf-8 From: bug#77860 <77860@debbugs.gnu.org> To: bug#77860 <77860@debbugs.gnu.org> Subject: Status: [PATCH] Shepherd: build: Improve man-page NAME whatis string for *.8. Reply-To: bug#77860 <77860@debbugs.gnu.org> Date: Sat, 21 Jun 2025 17:27:48 +0000 retitle 77860 [PATCH] Shepherd: build: Improve man-page NAME whatis string = for *.8. reassign 77860 guix-patches submitter 77860 Simon Josefsson severity 77860 normal tag 77860 patch thanks From debbugs-submit-bounces@debbugs.gnu.org Thu Apr 17 05:45:07 2025 Received: (at submit) by debbugs.gnu.org; 17 Apr 2025 09:45:08 +0000 Received: from localhost ([127.0.0.1]:45827 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1u5Lnv-0003nS-9Q for submit@debbugs.gnu.org; Thu, 17 Apr 2025 05:45:07 -0400 Received: from lists.gnu.org ([2001:470:142::17]:42126) by debbugs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.84_2) (envelope-from ) id 1u5Lnr-0003lx-Rw for submit@debbugs.gnu.org; Thu, 17 Apr 2025 05:45:05 -0400 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 ) id 1u5LnW-00031X-Cz for guix-patches@gnu.org; Thu, 17 Apr 2025 05:44:50 -0400 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 ) id 1u5LnT-0008NP-38 for guix-patches@gnu.org; Thu, 17 Apr 2025 05:44:42 -0400 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=9TUyLsEin50Lc2/w5lLVXaJUFWih7r7I6m9ixuyS6mk=; t=1744883070; x=1746092670; b=CoHiVyUs6tRpx3DOaAjZ1pnJQaZ/Tc4qf9eQKf7rWB76VnG DX672llP17EnXC+Y6dJQKZUsxoK1Y7XvUOJ2yAw==; 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=9TUyLsEin50Lc2/w5lLVXaJUFWih7r7I6m9ixuyS6mk=; t=1744883070; x=1746092670; b=w3ZP4OA3XDQiUhuKQM5QuxCoMI+N9HlzU6pKQjYvKvbAXSs RKEq/+uOlX5VcHKHgSa8dvcKtthpo/PqZ2MqxHw3/c2ETIcNyFFopE/SiQRYrAYy+fys+rZedm2/P 94WlrLHYHhk7NHPC2OXajCyxRMceaQ5BAsHuo+lDnBH4hjzlqoTP82N8+jir/U8KSEqLK6abCHx1y Znwcg9lxTz6L3uTyfhd8pwh7bW11+RqXDpADJsQ4eBJ7k3jIlE971xjnMziZi+4ew1+7/HL3BMDKw GeM82/hNaz06TS1Z/Zn1lhQ0K+AbmPhMUxkStr1ASIEflBffhNCOfK6mpkAjbNGkij18TidTSSLrr yYZxHOi0IbJ2W5Y02mqDB8sDRfdXtkrTd0flb8AijUYppJrn64LdXAxjNpT0gsFA3nIJXXLxqVqS/ +XeOw7Y9I5955+Lc/dhPgwap; Received: from h-155-4-221-32.na.cust.bahnhof.se ([155.4.221.32]:57444 helo=kaka) by uggla.sjd.se with esmtpsa (TLS1.3) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.95) (envelope-from ) id 1u5LnH-005WQ9-An for guix-patches@gnu.org; Thu, 17 Apr 2025 09:44:27 +0000 From: Simon Josefsson To: guix-patches@gnu.org Subject: [PATCH] Shepherd: build: Improve man-page NAME whatis string for *.8. OpenPGP: id=B1D2BD1375BECB784CF4F8C4D73CF638C53C06BE; url=https://josefsson.org/key-20190320.txt X-Hashcash: 1:23:250417:guix-patches@gnu.org::Wm/GhSos21aIILKC:1Kdsx Date: Thu, 17 Apr 2025 11:42:45 +0200 Message-ID: <87tt6nunsa.fsf@josefsson.org> 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@josefsson.org; 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@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -0.1 (/) --==-=-= Content-Type: multipart/mixed; boundary="=-=-=" --=-=-= Content-Type: text/plain Content-Transfer-Encoding: quoted-printable Hi, Thanks for 1.0.4! Frequent releases helps to iterate on small improvements that I'm reminded of when a new release happens. The Debian packages now puts halt and reboot below /usr/libexec/shepherd/ like this: jas@kaka:~/src/shepherd$ ls -la /usr/libexec/shepherd/sbin/ totalt 16 drwxr-xr-x 2 root root 4096 17 apr 10.54 . drwxr-xr-x 3 root root 4096 19 mar 13.43 .. =2Drwxr-xr-x 1 root root 288 17 apr 09.24 halt =2Drwxr-xr-x 1 root root 290 17 apr 09.24 reboot lrwxrwxrwx 1 root root 4 17 apr 09.24 shutdown -> halt jas@kaka:~/src/shepherd$=20 This allows someone to use `PATH=3D/usr/libexec/shepherd/sbin:$PATH` to use Shepherd's halt and reboot commands. It is unclear to me why anyone would want that, but it seems conceviable, and I recall hearing from people who managed to use Shepherd as pid 1 on a Debian system. Man pages for these commands are installed as shepherd-halt.8 and shepherd-reboot.8 to not conflict with Debian's halt(8) and reboot(8). Maybe there is a better way to deal with that, but it seems better to ship them under another name than to not ship them at all, pending some better approach. The QA tooling complained about these manpages: W: shepherd: useless-whatis-entry [usr/share/man/man8/shepherd-halt.8.gz] N:=20 N: The whatis entry for this manual page (the brief description found in = the N: NAME section) is of the form: N:=20=20=20 N: program - manual page for program N:=20=20=20 N: This conveys no information about what the program is for and is N: repetitive. The short description should contain brief information abo= ut N: what the program is for to aid in searching with apropos and similar N: programs. N:=20=20=20 N: If this manual page was generated by help2man, use the -n option to N: provide a more meaningful description. That is the same as for shepherd.1 and herd.1 that you patched earlier: https://issues.guix.gnu.org/76435 The attached patch solves the same issue but for halt.8 and reboot.8. This uses help2man's --include-opt instead which I think is a better mechanism (and allows the relevant SEE ALSO). What do you think? If this approach seems right, I may propose a patch to create doc/shepherd.1.h2m and doc/herd.1.h2m too, cleaning up Makefile.am slightly. /Simon --=-=-= Content-Type: text/x-diff Content-Disposition: inline; filename=0001-build-Improve-man-page-NAME-whatis-string-for-.8.patch Content-Transfer-Encoding: quoted-printable From=20d97e2485ca700162474d40ffde0b53a06e358ee6 Mon Sep 17 00:00:00 2001 From: Simon Josefsson Date: Thu, 17 Apr 2025 11:13:14 +0200 Subject: [PATCH] build: Improve man-page NAME whatis string for *.8. * Makefile.am (%.8): Pass --include-opt. doc/halt.8.h2m: Add. doc/reboot.8.h2m: Add. Makefile.am (EXTRA_DIST): Add doc/*.h2m's. =2D-- Makefile.am | 3 +++ doc/halt.8.h2m | 4 ++++ doc/reboot.8.h2m | 4 ++++ 3 files changed, 11 insertions(+) create mode 100644 doc/halt.8.h2m create mode 100644 doc/reboot.8.h2m diff --git a/Makefile.am b/Makefile.am index a61b403..bdb1909 100644 =2D-- a/Makefile.am +++ b/Makefile.am @@ -143,8 +143,11 @@ doc/herd.1: modules/shepherd/scripts/herd.scm configur= e.ac =20 doc/%.8: modules/shepherd/scripts/%.scm configure.ac $(gen_man) --section=3D8 --output=3D"$@" \ + --include=3D$(srcdir)/$@.h2m \ "$(top_builddir)/`basename "$@" .8`" =20 +EXTRA_DIST +=3D doc/halt.8.h2m doc/reboot.8.h2m + dist_man1_MANS =3D doc/shepherd.1 doc/herd.1 dist_man8_MANS =3D doc/halt.8 doc/reboot.8 =20 diff --git a/doc/halt.8.h2m b/doc/halt.8.h2m new file mode 100644 index 0000000..b6162d8 =2D-- /dev/null +++ b/doc/halt.8.h2m @@ -0,0 +1,4 @@ +[NAME] +halt \- tell Shepherd to stop services and turn off system +[SEE ALSO] +shepherd(1), herd(1), reboot(8) diff --git a/doc/reboot.8.h2m b/doc/reboot.8.h2m new file mode 100644 index 0000000..4480ba7 =2D-- /dev/null +++ b/doc/reboot.8.h2m @@ -0,0 +1,4 @@ +[NAME] +reboot \- tell Shepherd to stop services and reboot system +[SEE ALSO] +shepherd(1), herd(1), halt(8) =2D-=20 2.49.0 --=-=-=-- --==-=-= Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQNoBAEWCAMQFiEEo8ychwudMQq61M8vUXIrCP5HRaIFAmgAzRUUHHNpbW9uQGpv c2Vmc3Nvbi5vcmfCHCYAmDMEXJLOtBYJKwYBBAHaRw8BAQdACIcrZIvhrxDBkK9f V+QlTmXxo2naObDuGtw58YaxlOu0JVNpbW9uIEpvc2Vmc3NvbiA8c2ltb25Aam9z ZWZzc29uLm9yZz6IlgQTFggAPgIbAwULCQgHAgYVCAkKCwIEFgIDAQIeAQIXgBYh BLHSvRN1vst4TPT4xNc89jjFPAa+BQJn0XQkBQkNZGbwAAoJENc89jjFPAa+BtIA /iR73CfBurG9y8pASh3cbGOMHpDZfMAtosu6jbpO69GHAP4p7l57d+iVty2VQMsx +3TCSAvZkpr4P/FuTzZ8JZe8BrgzBFySz4EWCSsGAQQB2kcPAQEHQOxTCIOaeXAx I2hIX4HK9bQTpNVei708oNr1Klm8qCGKiPUEGBYIACYCGwIWIQSx0r0Tdb7LeEz0 +MTXPPY4xTwGvgUCZ9F0SgUJDWRmSQCBdiAEGRYIAB0WIQSjzJyHC50xCrrUzy9R cisI/kdFogUCXJLPgQAKCRBRcisI/kdFoqdMAQCgH45aseZgIrwKOvUOA9QfsmeE 8GZHYNuFHmM9FEQS6AD6A4x5aYvoY6lo98pgtw2HPDhmcCXFItjXCrV4A0GmJA4J ENc89jjFPAa+wUUBAO64fbZek6FPlRK0DrlWsrjCXuLi6PUxyzCAY6lG2nhUAQC6 qobB9mkZlZ0qihy1x4JRtflqFcqqT9n7iUZkCDIiDbg4BFySz2oSCisGAQQBl1UB BQEBB0AxlRumDW6nZY7A+VCfek9VpEx6PJmdJyYPt3lNHMd6HAMBCAeIfgQYFggA JgIbDBYhBLHSvRN1vst4TPT4xNc89jjFPAa+BQJn0XTSBQkNZGboAAoJENc89jjF PAa+0M0BAPPRq73kLnHYNDMniVBOzUdi2XeF32idjEWWfjvyIJUOAP4wZ+ALxIeh is3Uw2BzGZE6ttXQ2Q+DeCJO3TPpIqaXDAAKCRBRcisI/kdFoiXkAQDNcwVXWk3t YLbrKHh4E7JUJZyTGMo5o996IdpBjUqtSQD+J6oOiw/eA3l4uryt80PKWVinqlH1 aMwJ9V1P7+3+ngg= =5hu7 -----END PGP SIGNATURE----- --==-=-=-- From debbugs-submit-bounces@debbugs.gnu.org Mon May 12 04:54:47 2025 Received: (at 77860-done) by debbugs.gnu.org; 12 May 2025 08:54:47 +0000 Received: from localhost ([127.0.0.1]:50065 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1uEOvv-0003uP-En for submit@debbugs.gnu.org; Mon, 12 May 2025 04:54:47 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:36534) by debbugs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.84_2) (envelope-from ) id 1uEOvs-0003tp-PH for 77860-done@debbugs.gnu.org; Mon, 12 May 2025 04:54:45 -0400 Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1uEOvl-00032o-S3; Mon, 12 May 2025 04:54:37 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=MIME-Version:Date:References:In-Reply-To:Subject:To: From; bh=sSq0juhO9aWc1LhKqqExVSc8BxlgxZtUKQXR7jWB/4g=; b=aE6tzJipJdDJy4LYyi4H Xa/Vd0IYwGNpl3XKSYwL4/VCZWcPL16iU4YH0aVWlJqDFoyK7oP0IsphpcnP60Y97kUCoZsNchzXQ RZPlzerH44Hw9lHBKcmJXLChBsztSDydSZKELDB6QsL5KcxQV/veC1i4IweJlD6on2zfrnZGz1Koh BGtH9YQjB3z5Hs5/68NbpytJAL/PB77vUvqR1+P+IyOAwnM4IOtqyBnoxp3C3FpTfrPkfXmkDxDIV 0B/jQVYGhEPNuR/jXIcENkDJKLYqp+V65bJiMsit9YVheGcNC2JoI+UZl3+Mdj3wY3a4BJ9AUZvcW i40qUx7XhEdYgA==; From: =?utf-8?Q?Ludovic_Court=C3=A8s?= To: Simon Josefsson Subject: Re: [bug#77860] [PATCH] Shepherd: build: Improve man-page NAME whatis string for *.8., [PATCH] build: Improve man-page NAME whatis string for *.8. In-Reply-To: <87tt6nunsa.fsf@josefsson.org> (Simon Josefsson's message of "Thu, 17 Apr 2025 11:42:45 +0200") References: <87tt6nunsa.fsf@josefsson.org> Date: Mon, 12 May 2025 10:36:24 +0200 Message-ID: <871psu5ipj.fsf@gnu.org> User-Agent: Gnus/5.13 (Gnus v5.13) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Spam-Score: -2.3 (--) X-Debbugs-Envelope-To: 77860-done Cc: 77860-done@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -3.3 (---) Hi Simon, Simon Josefsson writes: > The attached patch solves the same issue but for halt.8 and reboot.8. > > This uses help2man's --include-opt instead which I think is a better > mechanism (and allows the relevant SEE ALSO). > > What do you think? I don=E2=80=99t know, no strong preference here, but consistency may be a g= ood thing. > From d97e2485ca700162474d40ffde0b53a06e358ee6 Mon Sep 17 00:00:00 2001 > From: Simon Josefsson > Date: Thu, 17 Apr 2025 11:13:14 +0200 > Subject: [PATCH] build: Improve man-page NAME whatis string for *.8. > > * Makefile.am (%.8): Pass --include-opt. > doc/halt.8.h2m: Add. > doc/reboot.8.h2m: Add. > Makefile.am (EXTRA_DIST): Add doc/*.h2m's. Applied, thanks! Ludo=E2=80=99. From unknown Sat Jun 21 10:27:48 2025 Received: (at fakecontrol) by fakecontrolmessage; To: internal_control@debbugs.gnu.org From: Debbugs Internal Request Subject: Internal Control Message-Id: bug archived. Date: Mon, 09 Jun 2025 11:24:10 +0000 User-Agent: Fakemail v42.6.9 # This is a fake control message. # # The action: # bug archived. thanks # This fakemail brought to you by your local debbugs # administrator