[bug#35686] doc: Document 'auto-start?' field of'shepherd-service'.
diff mbox series

Message ID 875zqh0yei.fsf@GlaDOS.home
State New
Headers show
Series
  • [bug#35686] doc: Document 'auto-start?' field of'shepherd-service'.
Related show

Checks

Context Check Description
cbaines/applying patch fail Apply failed

Commit Message

Diego Nicola Barbato May 11, 2019, 4:05 p.m. UTC
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

Comments

Ludovic Courtès May 12, 2019, 9:33 p.m. UTC | #1
Hi Diego,

Diego Nicola Barbato <dnbarbato@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’.

Patch
diff mbox series

From 74c8321303d47b7c28f873c4e560b9fbaf136cfb Mon Sep 17 00:00:00 2001
From: Diego Nicola Barbato <dnbarbato@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