From unknown Tue Aug 19 09:32:08 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#39752 <39752@debbugs.gnu.org> To: bug#39752 <39752@debbugs.gnu.org> Subject: Status: [PATCH 0/4 shepherd] Update the doc and an example. Reply-To: bug#39752 <39752@debbugs.gnu.org> Date: Tue, 19 Aug 2025 16:32:08 +0000 retitle 39752 [PATCH 0/4 shepherd] Update the doc and an example. reassign 39752 guix-patches submitter 39752 Brice Waegeneire severity 39752 normal tag 39752 patch thanks From debbugs-submit-bounces@debbugs.gnu.org Sun Feb 23 04:19:11 2020 Received: (at submit) by debbugs.gnu.org; 23 Feb 2020 09:19:11 +0000 Received: from localhost ([127.0.0.1]:50346 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1j5nPr-0007Id-En for submit@debbugs.gnu.org; Sun, 23 Feb 2020 04:19:11 -0500 Received: from lists.gnu.org ([209.51.188.17]:49788) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1j5nPp-0007IW-Q4 for submit@debbugs.gnu.org; Sun, 23 Feb 2020 04:19:10 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:49850) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j5nPo-0003BS-Qb for guix-patches@gnu.org; Sun, 23 Feb 2020 04:19:09 -0500 X-Spam-Checker-Version: SpamAssassin 3.3.2 (2011-06-06) on eggs.gnu.org X-Spam-Level: X-Spam-Status: No, score=0.1 required=5.0 tests=BAYES_50,RCVD_IN_DNSWL_LOW autolearn=disabled version=3.3.2 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j5nPn-00068d-Je for guix-patches@gnu.org; Sun, 23 Feb 2020 04:19:08 -0500 Received: from relay8-d.mail.gandi.net ([217.70.183.201]:41413) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1j5nPn-00066X-EE for guix-patches@gnu.org; Sun, 23 Feb 2020 04:19:07 -0500 X-Originating-IP: 78.237.113.178 Received: from localhost (luy13-1-78-237-113-178.fbx.proxad.net [78.237.113.178]) (Authenticated sender: brice@waegenei.re) by relay8-d.mail.gandi.net (Postfix) with ESMTPSA id 2F6491BF207 for ; Sun, 23 Feb 2020 09:19:02 +0000 (UTC) From: Brice Waegeneire To: guix-patches@gnu.org Subject: [PATCH 0/4 shepherd] Update the doc and an example. Date: Sun, 23 Feb 2020 10:18:59 +0100 Message-Id: <20200223091859.21705-1-brice@waegenei.re> X-Mailer: git-send-email 2.25.0 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 217.70.183.201 X-Spam-Score: -0.0 (/) 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: -1.0 (-) Brice Waegeneire (4): doc: Fix typos. service: Fix typos. doc: Expand the part on special action 'doc'. doc: Fix wolfgangj example. doc/examples/wolfgangj.scm | 4 +++- doc/shepherd.texi | 24 +++++++++++++++++------- modules/shepherd/service.scm | 4 ++-- 3 files changed, 22 insertions(+), 10 deletions(-) -- 2.25.0 From debbugs-submit-bounces@debbugs.gnu.org Sun Feb 23 04:20:55 2020 Received: (at 39752) by debbugs.gnu.org; 23 Feb 2020 09:20:55 +0000 Received: from localhost ([127.0.0.1]:50351 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1j5nRW-0007Lj-Qv for submit@debbugs.gnu.org; Sun, 23 Feb 2020 04:20:54 -0500 Received: from relay11.mail.gandi.net ([217.70.178.231]:36847) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1j5nRV-0007LU-Ie for 39752@debbugs.gnu.org; Sun, 23 Feb 2020 04:20:54 -0500 Received: from localhost (luy13-1-78-237-113-178.fbx.proxad.net [78.237.113.178]) (Authenticated sender: brice@waegenei.re) by relay11.mail.gandi.net (Postfix) with ESMTPSA id ED70C100006 for <39752@debbugs.gnu.org>; Sun, 23 Feb 2020 09:20:46 +0000 (UTC) From: Brice Waegeneire To: 39752@debbugs.gnu.org Subject: [PATCH 1/4] doc: Fix typos. Date: Sun, 23 Feb 2020 10:20:41 +0100 Message-Id: <20200223092044.22834-1-brice@waegenei.re> X-Mailer: git-send-email 2.25.0 In-Reply-To: <20200223091859.21705-1-brice@waegenei.re> References: <20200223091859.21705-1-brice@waegenei.re> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Spam-Score: -0.7 (/) X-Debbugs-Envelope-To: 39752 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: -1.7 (-) * doc/shepherd.texi (Jump start): Lower case after a colon. Remove "the". --- doc/shepherd.texi | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/shepherd.texi b/doc/shepherd.texi index da5718b..834d47a 100644 --- a/doc/shepherd.texi +++ b/doc/shepherd.texi @@ -208,7 +208,7 @@ service, you use the following, probably not very surprising, command: herd stop networking @end example -There are two more actions you can perform on every service: The +There are two more actions you can perform on every service: the actions @code{enable} and @code{disable} are used to prevent and allow starting of the particular service. If a service is intended to be restarted whenever it terminates (how this can be done will not be @@ -248,7 +248,7 @@ be available: herd reload-modules apache @end example -The service-specific actions can only be used when the service is +Service-specific actions can only be used when the service is started, i.e. the only thing you can do to a stopped service is starting it. An exception exists, see below. (If you may at some point find this too restrictive because you want to use variants of -- 2.25.0 From debbugs-submit-bounces@debbugs.gnu.org Sun Feb 23 04:20:58 2020 Received: (at 39752) by debbugs.gnu.org; 23 Feb 2020 09:20:58 +0000 Received: from localhost ([127.0.0.1]:50354 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1j5nRa-0007Lz-1J for submit@debbugs.gnu.org; Sun, 23 Feb 2020 04:20:58 -0500 Received: from relay2-d.mail.gandi.net ([217.70.183.194]:33975) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1j5nRY-0007LX-C3 for 39752@debbugs.gnu.org; Sun, 23 Feb 2020 04:20:56 -0500 X-Originating-IP: 78.237.113.178 Received: from localhost (luy13-1-78-237-113-178.fbx.proxad.net [78.237.113.178]) (Authenticated sender: brice@waegenei.re) by relay2-d.mail.gandi.net (Postfix) with ESMTPSA id C782840003 for <39752@debbugs.gnu.org>; Sun, 23 Feb 2020 09:20:49 +0000 (UTC) From: Brice Waegeneire To: 39752@debbugs.gnu.org Subject: [PATCH 2/4] service: Fix typos. Date: Sun, 23 Feb 2020 10:20:42 +0100 Message-Id: <20200223092044.22834-2-brice@waegenei.re> X-Mailer: git-send-email 2.25.0 In-Reply-To: <20200223091859.21705-1-brice@waegenei.re> References: <20200223091859.21705-1-brice@waegenei.re> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Spam-Score: -0.7 (/) X-Debbugs-Envelope-To: 39752 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: -1.7 (-) * modules/shepherd/service.scm (root-service): Replace "safe" by "save". --- modules/shepherd/service.scm | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/shepherd/service.scm b/modules/shepherd/service.scm index e0772e8..fc82cc4 100644 --- a/modules/shepherd/service.scm +++ b/modules/shepherd/service.scm @@ -1392,7 +1392,7 @@ we want to receive these signals." #t) (primitive-exit 0)))))) (persistency - "Safe the current state of running and non-running services. + "Save the current state of running and non-running services. This status gets written into a file on termination, so that we can restore the status on next startup. Optionally, you can pass a file name as argument that will be used to store the status." @@ -1401,7 +1401,7 @@ name as argument that will be used to store the status." (when file (set! persistency-state-file file)))) (no-persistency - "Don't safe state in a file on exit." + "Don't save state in a file on exit." (lambda (running) (set! persistency #f))) (cd -- 2.25.0 From debbugs-submit-bounces@debbugs.gnu.org Sun Feb 23 04:21:00 2020 Received: (at 39752) by debbugs.gnu.org; 23 Feb 2020 09:21:00 +0000 Received: from localhost ([127.0.0.1]:50357 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1j5nRc-0007MD-7L for submit@debbugs.gnu.org; Sun, 23 Feb 2020 04:21:00 -0500 Received: from relay11.mail.gandi.net ([217.70.178.231]:34855) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1j5nRa-0007Lc-Co for 39752@debbugs.gnu.org; Sun, 23 Feb 2020 04:20:58 -0500 Received: from localhost (luy13-1-78-237-113-178.fbx.proxad.net [78.237.113.178]) (Authenticated sender: brice@waegenei.re) by relay11.mail.gandi.net (Postfix) with ESMTPSA id A6752100009 for <39752@debbugs.gnu.org>; Sun, 23 Feb 2020 09:20:52 +0000 (UTC) From: Brice Waegeneire To: 39752@debbugs.gnu.org Subject: [PATCH 3/4] doc: Expand the part on special action 'doc'. Date: Sun, 23 Feb 2020 10:20:43 +0100 Message-Id: <20200223092044.22834-3-brice@waegenei.re> X-Mailer: git-send-email 2.25.0 In-Reply-To: <20200223091859.21705-1-brice@waegenei.re> References: <20200223091859.21705-1-brice@waegenei.re> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-Spam-Score: -0.7 (/) X-Debbugs-Envelope-To: 39752 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: -1.7 (-) * doc/shepherd.texi (Jump start): Rewrite paragraph about special action 'doc'. --- doc/shepherd.texi | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/doc/shepherd.texi b/doc/shepherd.texi index 834d47a..7c7e5e5 100644 --- a/doc/shepherd.texi +++ b/doc/shepherd.texi @@ -11,6 +11,7 @@ @copying Copyright @copyright{} @value{OLD-YEARS} Wolfgang J@"ahrling@* Copyright @copyright{} @value{NEW-YEARS} Ludovic Courtès +Copyright @copyright{} @value{2020} Brice Waegeneire Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or @@ -273,11 +274,6 @@ about the service, like what it provides, what it depends on and with which other services it conflicts (because they provide a virtual service that is also provided by that particular service). -Another special action is @code{list-actions}, which displays a list -of the additional actions a service provides; obviously, it can also -be called when the service is not running. Services cannot provide -their own implementation of @code{list-actions}. - A special service is @code{root}, which is used for controlling the Shepherd itself. You can also reference to this service as @code{shepherd}. It implements various actions. For example, the @@ -293,6 +289,20 @@ to load arbitrary code into the Shepherd at runtime, like this: herd load shepherd ~/additional-services.scm @end example +In the same vein the special action @code{doc} describes it's service +when called without an argument or describes a service-specific action +when called with the action as the additional arguments. You can even +get the list of the service-specific actions a service provides when +using with the additional argument @code{list-actions}. +@example +$ herd doc root +The root service is used to operate on shepherd itself. +$ herd doc root list-actions +root (help status halt power-off load eval unload reload daemonize persistency no-persistency cd restart) +$ herd doc root action power-off +power-off: Halt the system and turn it off. +@end example + This is enough now about the @command{herd} and @command{shepherd} programs, we will now take a look at how to configure the Shepherd. In the configuration file, we need mainly the definition of services. We can also do -- 2.25.0 From debbugs-submit-bounces@debbugs.gnu.org Sun Feb 23 04:21:04 2020 Received: (at 39752) by debbugs.gnu.org; 23 Feb 2020 09:21:04 +0000 Received: from localhost ([127.0.0.1]:50363 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1j5nRg-0007NY-Fo for submit@debbugs.gnu.org; Sun, 23 Feb 2020 04:21:04 -0500 Received: from relay9-d.mail.gandi.net ([217.70.183.199]:51661) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1j5nRe-0007Ls-Qw for 39752@debbugs.gnu.org; Sun, 23 Feb 2020 04:21:03 -0500 X-Originating-IP: 78.237.113.178 Received: from localhost (luy13-1-78-237-113-178.fbx.proxad.net [78.237.113.178]) (Authenticated sender: brice@waegenei.re) by relay9-d.mail.gandi.net (Postfix) with ESMTPSA id 4A6EEFF807 for <39752@debbugs.gnu.org>; Sun, 23 Feb 2020 09:20:56 +0000 (UTC) From: Brice Waegeneire To: 39752@debbugs.gnu.org Subject: [PATCH 4/4] doc: Fix wolfgangj example. Date: Sun, 23 Feb 2020 10:20:44 +0100 Message-Id: <20200223092044.22834-4-brice@waegenei.re> X-Mailer: git-send-email 2.25.0 In-Reply-To: <20200223091859.21705-1-brice@waegenei.re> References: <20200223091859.21705-1-brice@waegenei.re> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Spam-Score: -0.7 (/) X-Debbugs-Envelope-To: 39752 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: -1.7 (-) * doc/examples/wolfgangj.scm: Use module SRFI-1. Replace "dmd" by "shepherd". --- doc/examples/wolfgangj.scm | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/examples/wolfgangj.scm b/doc/examples/wolfgangj.scm index 0c16108..5fae7c1 100644 --- a/doc/examples/wolfgangj.scm +++ b/doc/examples/wolfgangj.scm @@ -26,6 +26,8 @@ ;; Apache running when I am online, I made Apache conflict with the ;; ISDN setup. +(use-modules (srfi srfi-1)) + ;; Laziness. (define (number->symbol num) (string->symbol (number->string num))) @@ -122,7 +124,7 @@ (loop default-terms)) ;; Go into background. -(action 'dmd 'daemonize) +(action 'shepherd 'daemonize) ;; Setup internet, a mailer and a few terms. (for-each start -- 2.25.0 From debbugs-submit-bounces@debbugs.gnu.org Sun Feb 23 07:49:40 2020 Received: (at 39752) by debbugs.gnu.org; 23 Feb 2020 12:49:40 +0000 Received: from localhost ([127.0.0.1]:50508 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1j5qhY-0008UJ-DM for submit@debbugs.gnu.org; Sun, 23 Feb 2020 07:49:40 -0500 Received: from dd26836.kasserver.com ([85.13.145.193]:38496) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1j5qhW-0008U5-3D for 39752@debbugs.gnu.org; Sun, 23 Feb 2020 07:49:38 -0500 Received: from localhost (unknown [185.17.13.127]) by dd26836.kasserver.com (Postfix) with ESMTPSA id 9738933641B4; Sun, 23 Feb 2020 13:49:36 +0100 (CET) Date: Sun, 23 Feb 2020 13:49:28 +0100 From: Danny Milosavljevic To: Brice Waegeneire Subject: Re: [bug#39752] [PATCH 3/4] doc: Expand the part on special action 'doc'. Message-ID: <20200223134928.5b3cbeca@scratchpost.org> In-Reply-To: <20200223092044.22834-3-brice@waegenei.re> References: <20200223091859.21705-1-brice@waegenei.re> <20200223092044.22834-3-brice@waegenei.re> X-Mailer: Claws Mail 3.17.3 (GTK+ 2.24.32; x86_64-unknown-linux-gnu) MIME-Version: 1.0 Content-Type: multipart/signed; boundary="Sig_/v8Ueb2hzhNGHTer2M5eje.E"; protocol="application/pgp-signature"; micalg=pgp-sha256 X-Spam-Score: -0.7 (/) X-Debbugs-Envelope-To: 39752 Cc: 39752@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: -1.7 (-) --Sig_/v8Ueb2hzhNGHTer2M5eje.E Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: quoted-printable > +In the same vein the special action @code{doc} describes it's service Should be "its" > +when called without an argument or describes a service-specific action > +when called with the action as the additional arguments. You can even > +get the list of the service-specific actions a service provides when > +using with the additional argument @code{list-actions}. Please use two spaces at the beginning of sentences. --Sig_/v8Ueb2hzhNGHTer2M5eje.E Content-Type: application/pgp-signature Content-Description: OpenPGP digital signature -----BEGIN PGP SIGNATURE----- iQEzBAEBCAAdFiEEds7GsXJ0tGXALbPZ5xo1VCwwuqUFAl5SdNgACgkQ5xo1VCww uqVzOwf/Rc53UEwTVnTJO0pZCHmpYdwWG1fx2n9wt4MwGsZbdW0pRbfUcPN5bb5/ ug+F4jmd0QybS+ToQlJGoXWbJvZD5xvwRcDqCafyLjZ+2CGkIrE3GOcUCP5K1Gp3 f5NJaWu1rwgU0ayz6/5xhwnjmNye26KXRg2BA4W4FppFYt3OhGNqoEk5U2VV+AW+ NsDA/lATZOOmI5kh965JHGW9SEgLINE7ZEB8tErXiThXRtu/bOrV0XsRwrKP4Lhy ojL7fKDmrw86Tk2vcn7xiQ/LgHveLEp0dea4jQ9uGf+g7J6X1t/vU9R145zG3c3w 9PCzh49SU1mKWLC1NZWUd8CdrQYJQg== =5bka -----END PGP SIGNATURE----- --Sig_/v8Ueb2hzhNGHTer2M5eje.E-- From debbugs-submit-bounces@debbugs.gnu.org Sun Feb 23 10:40:22 2020 Received: (at 39752) by debbugs.gnu.org; 23 Feb 2020 15:40:22 +0000 Received: from localhost ([127.0.0.1]:51483 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1j5tMk-0006yH-DX for submit@debbugs.gnu.org; Sun, 23 Feb 2020 10:40:22 -0500 Received: from relay2-d.mail.gandi.net ([217.70.183.194]:49049) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1j5tMi-0006y2-Nz for 39752@debbugs.gnu.org; Sun, 23 Feb 2020 10:40:21 -0500 X-Originating-IP: 78.237.113.178 Received: from localhost (luy13-1-78-237-113-178.fbx.proxad.net [78.237.113.178]) (Authenticated sender: brice@waegenei.re) by relay2-d.mail.gandi.net (Postfix) with ESMTPSA id C050540004 for <39752@debbugs.gnu.org>; Sun, 23 Feb 2020 15:40:13 +0000 (UTC) From: Brice Waegeneire To: 39752@debbugs.gnu.org Subject: [PATCH 0/5 shepherd v2] Update the doc and an example. Date: Sun, 23 Feb 2020 16:40:03 +0100 Message-Id: <20200223154008.24888-1-brice@waegenei.re> X-Mailer: git-send-email 2.25.0 In-Reply-To: <20200223091859.21705-1-brice@waegenei.re> References: <20200223091859.21705-1-brice@waegenei.re> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Spam-Score: -0.7 (/) X-Debbugs-Envelope-To: 39752 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: -1.7 (-) Add commit #5 and fix typos in commit #3. Brice Waegeneire (5): doc: Fix typos. service: Fix typos. doc: Expand the part on special action 'doc'. doc: Fix wolfgangj example. .dir-locals.el: End sentence with a double space. .dir-locals.el | 1 + doc/examples/wolfgangj.scm | 4 +++- doc/shepherd.texi | 24 +++++++++++++++++------- modules/shepherd/service.scm | 4 ++-- 4 files changed, 23 insertions(+), 10 deletions(-) -- 2.25.0 From debbugs-submit-bounces@debbugs.gnu.org Sun Feb 23 10:40:25 2020 Received: (at 39752) by debbugs.gnu.org; 23 Feb 2020 15:40:25 +0000 Received: from localhost ([127.0.0.1]:51486 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1j5tMn-0006yb-KN for submit@debbugs.gnu.org; Sun, 23 Feb 2020 10:40:25 -0500 Received: from relay8-d.mail.gandi.net ([217.70.183.201]:59199) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1j5tMl-0006y6-Bj for 39752@debbugs.gnu.org; Sun, 23 Feb 2020 10:40:23 -0500 X-Originating-IP: 78.237.113.178 Received: from localhost (luy13-1-78-237-113-178.fbx.proxad.net [78.237.113.178]) (Authenticated sender: brice@waegenei.re) by relay8-d.mail.gandi.net (Postfix) with ESMTPSA id B3E631BF206 for <39752@debbugs.gnu.org>; Sun, 23 Feb 2020 15:40:16 +0000 (UTC) From: Brice Waegeneire To: 39752@debbugs.gnu.org Subject: [PATCH 1/5] doc: Fix typos. Date: Sun, 23 Feb 2020 16:40:04 +0100 Message-Id: <20200223154008.24888-2-brice@waegenei.re> X-Mailer: git-send-email 2.25.0 In-Reply-To: <20200223154008.24888-1-brice@waegenei.re> References: <20200223091859.21705-1-brice@waegenei.re> <20200223154008.24888-1-brice@waegenei.re> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Spam-Score: -0.7 (/) X-Debbugs-Envelope-To: 39752 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: -1.7 (-) * doc/shepherd.texi (Jump start): Lower case after a colon. Remove "the". --- doc/shepherd.texi | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/shepherd.texi b/doc/shepherd.texi index da5718b..834d47a 100644 --- a/doc/shepherd.texi +++ b/doc/shepherd.texi @@ -208,7 +208,7 @@ service, you use the following, probably not very surprising, command: herd stop networking @end example -There are two more actions you can perform on every service: The +There are two more actions you can perform on every service: the actions @code{enable} and @code{disable} are used to prevent and allow starting of the particular service. If a service is intended to be restarted whenever it terminates (how this can be done will not be @@ -248,7 +248,7 @@ be available: herd reload-modules apache @end example -The service-specific actions can only be used when the service is +Service-specific actions can only be used when the service is started, i.e. the only thing you can do to a stopped service is starting it. An exception exists, see below. (If you may at some point find this too restrictive because you want to use variants of -- 2.25.0 From debbugs-submit-bounces@debbugs.gnu.org Sun Feb 23 10:40:28 2020 Received: (at 39752) by debbugs.gnu.org; 23 Feb 2020 15:40:28 +0000 Received: from localhost ([127.0.0.1]:51489 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1j5tMp-0006yr-SI for submit@debbugs.gnu.org; Sun, 23 Feb 2020 10:40:28 -0500 Received: from relay9-d.mail.gandi.net ([217.70.183.199]:55651) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1j5tMn-0006y9-Qn for 39752@debbugs.gnu.org; Sun, 23 Feb 2020 10:40:26 -0500 X-Originating-IP: 78.237.113.178 Received: from localhost (luy13-1-78-237-113-178.fbx.proxad.net [78.237.113.178]) (Authenticated sender: brice@waegenei.re) by relay9-d.mail.gandi.net (Postfix) with ESMTPSA id 37CDBFF804 for <39752@debbugs.gnu.org>; Sun, 23 Feb 2020 15:40:18 +0000 (UTC) From: Brice Waegeneire To: 39752@debbugs.gnu.org Subject: [PATCH 2/5] service: Fix typos. Date: Sun, 23 Feb 2020 16:40:05 +0100 Message-Id: <20200223154008.24888-3-brice@waegenei.re> X-Mailer: git-send-email 2.25.0 In-Reply-To: <20200223154008.24888-1-brice@waegenei.re> References: <20200223091859.21705-1-brice@waegenei.re> <20200223154008.24888-1-brice@waegenei.re> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Spam-Score: -0.7 (/) X-Debbugs-Envelope-To: 39752 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: -1.7 (-) * modules/shepherd/service.scm (root-service): Replace "safe" by "save". --- modules/shepherd/service.scm | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/shepherd/service.scm b/modules/shepherd/service.scm index e0772e8..fc82cc4 100644 --- a/modules/shepherd/service.scm +++ b/modules/shepherd/service.scm @@ -1392,7 +1392,7 @@ we want to receive these signals." #t) (primitive-exit 0)))))) (persistency - "Safe the current state of running and non-running services. + "Save the current state of running and non-running services. This status gets written into a file on termination, so that we can restore the status on next startup. Optionally, you can pass a file name as argument that will be used to store the status." @@ -1401,7 +1401,7 @@ name as argument that will be used to store the status." (when file (set! persistency-state-file file)))) (no-persistency - "Don't safe state in a file on exit." + "Don't save state in a file on exit." (lambda (running) (set! persistency #f))) (cd -- 2.25.0 From debbugs-submit-bounces@debbugs.gnu.org Sun Feb 23 10:40:31 2020 Received: (at 39752) by debbugs.gnu.org; 23 Feb 2020 15:40:31 +0000 Received: from localhost ([127.0.0.1]:51492 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1j5tMt-0006z7-3P for submit@debbugs.gnu.org; Sun, 23 Feb 2020 10:40:31 -0500 Received: from relay11.mail.gandi.net ([217.70.178.231]:34891) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1j5tMr-0006yP-5c for 39752@debbugs.gnu.org; Sun, 23 Feb 2020 10:40:29 -0500 Received: from localhost (luy13-1-78-237-113-178.fbx.proxad.net [78.237.113.178]) (Authenticated sender: brice@waegenei.re) by relay11.mail.gandi.net (Postfix) with ESMTPSA id 70D2B100009 for <39752@debbugs.gnu.org>; Sun, 23 Feb 2020 15:40:22 +0000 (UTC) From: Brice Waegeneire To: 39752@debbugs.gnu.org Subject: [PATCH 3/5] doc: Expand the part on special action 'doc'. Date: Sun, 23 Feb 2020 16:40:06 +0100 Message-Id: <20200223154008.24888-4-brice@waegenei.re> X-Mailer: git-send-email 2.25.0 In-Reply-To: <20200223154008.24888-1-brice@waegenei.re> References: <20200223091859.21705-1-brice@waegenei.re> <20200223154008.24888-1-brice@waegenei.re> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-Spam-Score: -0.7 (/) X-Debbugs-Envelope-To: 39752 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: -1.7 (-) * doc/shepherd.texi (Jump start): Rewrite paragraph about special action 'doc'. --- doc/shepherd.texi | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/doc/shepherd.texi b/doc/shepherd.texi index 834d47a..fbd1a3f 100644 --- a/doc/shepherd.texi +++ b/doc/shepherd.texi @@ -11,6 +11,7 @@ @copying Copyright @copyright{} @value{OLD-YEARS} Wolfgang J@"ahrling@* Copyright @copyright{} @value{NEW-YEARS} Ludovic Courtès +Copyright @copyright{} @value{2020} Brice Waegeneire Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or @@ -273,11 +274,6 @@ about the service, like what it provides, what it depends on and with which other services it conflicts (because they provide a virtual service that is also provided by that particular service). -Another special action is @code{list-actions}, which displays a list -of the additional actions a service provides; obviously, it can also -be called when the service is not running. Services cannot provide -their own implementation of @code{list-actions}. - A special service is @code{root}, which is used for controlling the Shepherd itself. You can also reference to this service as @code{shepherd}. It implements various actions. For example, the @@ -293,6 +289,20 @@ to load arbitrary code into the Shepherd at runtime, like this: herd load shepherd ~/additional-services.scm @end example +In the same vein the special action @code{doc} describes it service when +called without an argument or describes a service-specific action when +called with the action as the additional arguments. You can even get +the list of the service-specific actions a service provides when using +with the additional argument @code{list-actions}. +@example +$ herd doc root +The root service is used to operate on shepherd itself. +$ herd doc root list-actions +root (help status halt power-off load eval unload reload daemonize persistency no-persistency cd restart) +$ herd doc root action power-off +power-off: Halt the system and turn it off. +@end example + This is enough now about the @command{herd} and @command{shepherd} programs, we will now take a look at how to configure the Shepherd. In the configuration file, we need mainly the definition of services. We can also do -- 2.25.0 From debbugs-submit-bounces@debbugs.gnu.org Sun Feb 23 10:40:34 2020 Received: (at 39752) by debbugs.gnu.org; 23 Feb 2020 15:40:34 +0000 Received: from localhost ([127.0.0.1]:51495 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1j5tMw-0006zO-E2 for submit@debbugs.gnu.org; Sun, 23 Feb 2020 10:40:34 -0500 Received: from relay5-d.mail.gandi.net ([217.70.183.197]:60291) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1j5tMu-0006yp-M4 for 39752@debbugs.gnu.org; Sun, 23 Feb 2020 10:40:33 -0500 X-Originating-IP: 78.237.113.178 Received: from localhost (luy13-1-78-237-113-178.fbx.proxad.net [78.237.113.178]) (Authenticated sender: brice@waegenei.re) by relay5-d.mail.gandi.net (Postfix) with ESMTPSA id 1A3F91C0006 for <39752@debbugs.gnu.org>; Sun, 23 Feb 2020 15:40:25 +0000 (UTC) From: Brice Waegeneire To: 39752@debbugs.gnu.org Subject: [PATCH 4/5] doc: Fix wolfgangj example. Date: Sun, 23 Feb 2020 16:40:07 +0100 Message-Id: <20200223154008.24888-5-brice@waegenei.re> X-Mailer: git-send-email 2.25.0 In-Reply-To: <20200223154008.24888-1-brice@waegenei.re> References: <20200223091859.21705-1-brice@waegenei.re> <20200223154008.24888-1-brice@waegenei.re> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Spam-Score: -0.7 (/) X-Debbugs-Envelope-To: 39752 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: -1.7 (-) * doc/examples/wolfgangj.scm: Use module SRFI-1. Replace "dmd" by "shepherd". --- doc/examples/wolfgangj.scm | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/examples/wolfgangj.scm b/doc/examples/wolfgangj.scm index 0c16108..5fae7c1 100644 --- a/doc/examples/wolfgangj.scm +++ b/doc/examples/wolfgangj.scm @@ -26,6 +26,8 @@ ;; Apache running when I am online, I made Apache conflict with the ;; ISDN setup. +(use-modules (srfi srfi-1)) + ;; Laziness. (define (number->symbol num) (string->symbol (number->string num))) @@ -122,7 +124,7 @@ (loop default-terms)) ;; Go into background. -(action 'dmd 'daemonize) +(action 'shepherd 'daemonize) ;; Setup internet, a mailer and a few terms. (for-each start -- 2.25.0 From debbugs-submit-bounces@debbugs.gnu.org Sun Feb 23 10:40:37 2020 Received: (at 39752) by debbugs.gnu.org; 23 Feb 2020 15:40:37 +0000 Received: from localhost ([127.0.0.1]:51498 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1j5tMz-0006zd-Lf for submit@debbugs.gnu.org; Sun, 23 Feb 2020 10:40:37 -0500 Received: from relay11.mail.gandi.net ([217.70.178.231]:55113) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1j5tMy-0006z6-2V for 39752@debbugs.gnu.org; Sun, 23 Feb 2020 10:40:36 -0500 Received: from localhost (luy13-1-78-237-113-178.fbx.proxad.net [78.237.113.178]) (Authenticated sender: brice@waegenei.re) by relay11.mail.gandi.net (Postfix) with ESMTPSA id 56391100003 for <39752@debbugs.gnu.org>; Sun, 23 Feb 2020 15:40:30 +0000 (UTC) From: Brice Waegeneire To: 39752@debbugs.gnu.org Subject: [PATCH 5/5] .dir-locals.el: End sentence with a double space. Date: Sun, 23 Feb 2020 16:40:08 +0100 Message-Id: <20200223154008.24888-6-brice@waegenei.re> X-Mailer: git-send-email 2.25.0 In-Reply-To: <20200223154008.24888-1-brice@waegenei.re> References: <20200223091859.21705-1-brice@waegenei.re> <20200223154008.24888-1-brice@waegenei.re> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Spam-Score: -0.7 (/) X-Debbugs-Envelope-To: 39752 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: -1.7 (-) * .dir-locals.el (nil): Add variable 'sentence-end-double-space'. --- .dir-locals.el | 1 + 1 file changed, 1 insertion(+) diff --git a/.dir-locals.el b/.dir-locals.el index ff25997..8361cb6 100644 --- a/.dir-locals.el +++ b/.dir-locals.el @@ -3,6 +3,7 @@ ((nil . ((fill-column . 78) (tab-width . 8) + (sentence-end-double-space . t) ;; For use with 'bug-reference-prog-mode'. (bug-reference-url-format . "http://bugs.gnu.org/%s") -- 2.25.0 From debbugs-submit-bounces@debbugs.gnu.org Sun Feb 23 10:43:33 2020 Received: (at 39752) by debbugs.gnu.org; 23 Feb 2020 15:43:33 +0000 Received: from localhost ([127.0.0.1]:51507 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1j5tPp-000751-2K for submit@debbugs.gnu.org; Sun, 23 Feb 2020 10:43:33 -0500 Received: from relay9-d.mail.gandi.net ([217.70.183.199]:49167) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1j5tPn-00074n-5B for 39752@debbugs.gnu.org; Sun, 23 Feb 2020 10:43:31 -0500 Received: from webmail.gandi.net (webmail18.sd4.0x35.net [10.200.201.18]) (Authenticated sender: brice@waegenei.re) by relay9-d.mail.gandi.net (Postfix) with ESMTPA id 58194FF805; Sun, 23 Feb 2020 15:43:25 +0000 (UTC) MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII; format=flowed Content-Transfer-Encoding: 7bit Date: Sun, 23 Feb 2020 15:43:25 +0000 From: Brice Waegeneire To: Danny Milosavljevic Subject: Re: [bug#39752] [PATCH 3/4] doc: Expand the part on special action 'doc'. In-Reply-To: <20200223134928.5b3cbeca@scratchpost.org> References: <20200223091859.21705-1-brice@waegenei.re> <20200223092044.22834-3-brice@waegenei.re> <20200223134928.5b3cbeca@scratchpost.org> Message-ID: X-Sender: brice@waegenei.re User-Agent: Roundcube Webmail/1.3.8 X-Spam-Score: -0.7 (/) X-Debbugs-Envelope-To: 39752 Cc: 39752@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: -1.7 (-) On 2020-02-23 12:49, Danny Milosavljevic wrote: >> +In the same vein the special action @code{doc} describes it's service > > Should be "its" > >> +when called without an argument or describes a service-specific >> action >> +when called with the action as the additional arguments. You can even >> +get the list of the service-specific actions a service provides when >> +using with the additional argument @code{list-actions}. > > Please use two spaces at the beginning of sentences. I have fix these issues in v2. From debbugs-submit-bounces@debbugs.gnu.org Fri Mar 06 08:22:36 2020 Received: (at 39752-done) by debbugs.gnu.org; 6 Mar 2020 13:22:36 +0000 Received: from localhost ([127.0.0.1]:44234 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1jACw0-0006sm-D6 for submit@debbugs.gnu.org; Fri, 06 Mar 2020 08:22:36 -0500 Received: from eggs.gnu.org ([209.51.188.92]:33920) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1jACvy-0006sO-KX for 39752-done@debbugs.gnu.org; Fri, 06 Mar 2020 08:22:34 -0500 Received: from fencepost.gnu.org ([2001:470:142:3::e]:48695) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1jACvs-00036V-9p; Fri, 06 Mar 2020 08:22:28 -0500 Received: from [2001:660:6102:320:e120:2c8f:8909:cdfe] (port=60250 helo=ribbon) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1jACvr-0000cQ-OV; Fri, 06 Mar 2020 08:22:28 -0500 From: =?utf-8?Q?Ludovic_Court=C3=A8s?= To: Brice Waegeneire Subject: Re: [bug#39752] [PATCH 0/5 shepherd v2] Update the doc and an example. References: <20200223091859.21705-1-brice@waegenei.re> <20200223154008.24888-1-brice@waegenei.re> Date: Fri, 06 Mar 2020 14:22:24 +0100 In-Reply-To: <20200223154008.24888-1-brice@waegenei.re> (Brice Waegeneire's message of "Sun, 23 Feb 2020 16:40:03 +0100") Message-ID: <878skdobxr.fsf@gnu.org> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/26.3 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Spam-Score: -0.7 (/) X-Debbugs-Envelope-To: 39752-done Cc: 39752-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: -1.7 (-) Hello, Brice Waegeneire skribis: > Add commit #5 and fix typos in commit #3. > > Brice Waegeneire (5): > doc: Fix typos. > service: Fix typos. > doc: Expand the part on special action 'doc'. > doc: Fix wolfgangj example. > .dir-locals.el: End sentence with a double space. I=E2=80=99ve pushed these patches. Thanks for these improvements Brice, and thanks for the initial review, Danny! Ludo=E2=80=99. From unknown Tue Aug 19 09:32:08 2025 Received: (at fakecontrol) by fakecontrolmessage; To: internal_control@debbugs.gnu.org From: Debbugs Internal Request Subject: Internal Control Message-Id: bug archived. Date: Sat, 04 Apr 2020 11:24:04 +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