From patchwork Thu Feb 20 07:48:19 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Simon Josefsson X-Patchwork-Id: 38863 Return-Path: X-Original-To: patchwork@mira.cbaines.net Delivered-To: patchwork@mira.cbaines.net Received: by mira.cbaines.net (Postfix, from userid 113) id CAF4A27BBE9; Thu, 20 Feb 2025 07:49:26 +0000 (GMT) X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-6.4 required=5.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,MAILING_LIST_MULTI,RCVD_IN_DNSWL_BLOCKED, RCVD_IN_VALIDITY_CERTIFIED,RCVD_IN_VALIDITY_RPBL,RCVD_IN_VALIDITY_SAFE, SPF_HELO_PASS,URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.6 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mira.cbaines.net (Postfix) with ESMTPS id 323E027BBE2 for ; Thu, 20 Feb 2025 07:49:23 +0000 (GMT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tl1Iv-0001eO-Lz; Thu, 20 Feb 2025 02:49:05 -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 ) id 1tl1It-0001du-HC for guix-patches@gnu.org; Thu, 20 Feb 2025 02:49:03 -0500 Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1tl1Is-0002WK-NS for guix-patches@gnu.org; Thu, 20 Feb 2025 02:49:02 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=debbugs.gnu.org; s=debbugs-gnu-org; h=MIME-Version:Date:From:To:Subject; bh=cFiH75vO4kUyzkz3iv5ZAmbQN27WbqG0K00lRyIyRyE=; b=HWoI2Vqgx1p46AFkraAmT6Y2oWZo5L+giQqWT04/J84OpKD1dJ+4rsazQvEvFMNB4YTPhf9NpDu72gYQWMQADbqcG2uIt9d6DQlcdhm3S1KTMSnjvtav5RdTmyaVL5jB/vc4Pd+nr3kSqc02CrD0EFs3Jyg9qjDu0Ihohtid93QssUxfCouWqjCLGJ3Jqo0s6Z5JfcDLtJu2mAsyGnJ+rl47dzFAF5cZl5o1T6By4VadV5mJm/3Uh++6w+rt9kqwgMi/aw0pGOUo3iyPdhtB3rFLWCNiYQeJy8d6lxZ0xGfeUhhDezgGACk0E7UjsswyOolKi+7AgBWP5DRSJZ4fRg==; Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1tl1Is-0006cm-H8 for guix-patches@gnu.org; Thu, 20 Feb 2025 02:49:02 -0500 X-Loop: help-debbugs@gnu.org Subject: [bug#76435] [PATCH] Shepherd: build: Improve man-page synopsis. Resent-From: Simon Josefsson Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Thu, 20 Feb 2025 07:49:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 76435 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 76435@debbugs.gnu.org X-Debbugs-Original-To: guix-patches@gnu.org Received: via spool by submit@debbugs.gnu.org id=B.174003772925391 (code B ref -1); Thu, 20 Feb 2025 07:49:02 +0000 Received: (at submit) by debbugs.gnu.org; 20 Feb 2025 07:48:49 +0000 Received: from localhost ([127.0.0.1]:59163 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1tl1Id-0006bJ-Uv for submit@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 ) id 1tl1Ia-0006aN-KW for submit@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 ) id 1tl1IU-0001bu-St for guix-patches@gnu.org; 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 ) id 1tl1IR-0002SX-DQ for guix-patches@gnu.org; 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 ) id 1tl1I6-0006G1-4K for guix-patches@gnu.org; Thu, 20 Feb 2025 07:48:14 +0000 OpenPGP: id=B1D2BD1375BECB784CF4F8C4D73CF638C53C06BE; url=https://josefsson.org/key-20190320.txt X-Hashcash: 1:23:250220:guix-patches@gnu.org::mom21V+YP8/HI0ub:6K3g Date: Thu, 20 Feb 2025 08:48:19 +0100 Message-ID: <87ikp5xdj0.fsf@josefsson.org> User-Agent: Gnus/5.13 (Gnus v5.13) MIME-Version: 1.0 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-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: guix-patches@gnu.org List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-to: Simon Josefsson X-ACL-Warn: , Simon Josefsson via Guix-patches X-Patchwork-Original-From: Simon Josefsson via Guix-patches via From: Simon Josefsson Errors-To: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org Sender: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org X-getmail-retrieved-from-mailbox: Patches 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 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(-) 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