GNU bug report logs - #35686
[PATCH] doc: Document 'auto-start?' field of 'shepherd-service'.

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 35686 in the body.
You can then email your comments to 35686 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Diego Nicola Barbato <dnbarbato <at> posteo.de>
To: guix-patches <at> gnu.org
Subject: [PATCH] doc: Document 'auto-start?' field of 'shepherd-service'.
Date: Sat, 11 May 2019 18:05:41 +0200

[Message part 1 (text/plain, inline)]

Hi Guix,

This patch adds the missing 'auto-start?' field to the documentation of
'shepherd-service'.

I have also noticed that the 'documentation' field is not in the same
position as it is in the source code (the remaining fields are in the
right order).  I did not change this as I was not sure whether it was
done on purpose.

Regards,

Diego

[0001-doc-Document-auto-start-field-of-shepherd-service.patch (text/x-patch, inline)]

From 74c8321303d47b7c28f873c4e560b9fbaf136cfb Mon Sep 17 00:00:00 2001
From: Diego Nicola Barbato <dnbarbato <at> posteo.de>
Date: Sat, 11 May 2019 17:21:18 +0200
Subject: [PATCH] doc: Document 'auto-start?' field of 'shepherd-service'.

* doc/guix.texi (shepherd-service): Document 'auto-start?' field.
---
 doc/guix.texi | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/doc/guix.texi b/doc/guix.texi
index 3f50bf77fe..86ed199aed 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -25312,6 +25312,10 @@ This is a list of @code{shepherd-action} objects (see below) defining
 herd @var{action} @var{service} [@var{arguments}@dots{}]
 @end example
 
+@item @code{auto-start?} (default: @code{#t})
+Whether this service should be started automatically by the Shepherd.  If it
+is @code{#f} the service has to be started manually with @code{herd start}.
+
 @item @code{documentation}
 A documentation string, as shown when running:
 
-- 
2.21.0

Message #10 received at 35686-done <at> debbugs.gnu.org (full text, mbox):

From: Ludovic Courtès <ludo <at> gnu.org>
To: Diego Nicola Barbato <dnbarbato <at> posteo.de>
Cc: 35686-done <at> debbugs.gnu.org
Subject: Re: [bug#35686] [PATCH] doc: Document 'auto-start?' field of
 'shepherd-service'.
Date: Sun, 12 May 2019 23:33:37 +0200

Hi Diego,

Diego Nicola Barbato <dnbarbato <at> posteo.de> skribis:

> This patch adds the missing 'auto-start?' field to the documentation of
> 'shepherd-service'.

Applied!

> I have also noticed that the 'documentation' field is not in the same
> position as it is in the source code (the remaining fields are in the
> right order).  I did not change this as I was not sure whether it was
> done on purpose.

Yeah, it doesn’t matter much.  I try to put “less important” fields
towards the bottom when documenting, but perhaps the relative
importance of these fields wasn’t all that clear.  ;-)

Thanks,
Ludo’.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.