bug#36698: shepherd: list-actions not implemented

bug#36698: shepherd: list-actions not implemented

[Jesse Gibbons]

I am curious about what actions are implemented in the system services
on my GuixSD install. I try something like the following for the
different system services and get an error:

jesse@piranhaplant ~$ sudo herd list-actions term-tty6
Password:
herd: service 'term-tty6' does not have an action 'list-actions'


Based on what the manual says[1], the 'list-actions' action should be a
special action of every service, so I would expect it to at least either
list the default actions status, start, stop, enable, disable, etc. or
display a message that there are no custom actions defined for the
named service.

Surprisingly I could not find anything related to this in the archives.

[1] https://www.gnu.org/software/shepherd/manual/html_node/Jump-Start.html

bug#36698: shepherd: list-actions not implemented

[Brice Waegeneire]

> I am curious about what actions are implemented in the system services
> on my GuixSD install. I try something like the following for the
> different system services and get an error:
> 
> jesse@piranhaplant ~$ sudo herd list-actions term-tty6
> Password:
> herd: service 'term-tty6' does not have an action 'list-actions'

The documentation has been updated in 
d5da712a5605a0cdaa4cf3bd64621a95a54520c0
to clarify the use of 'list-actions' and there is an example on how to 
use it.

# herd doc term-tty6 list-actions
term-tty6 ()
# herd doc root list-actions
root (help status halt power-off load eval unload reload daemonize 
persistency no-persistency cd restart)

This bug should be closed.

bug#36698: shepherd: list-actions not implemented

[Leo Famulari]

[-- Attachment #1: Type: text/plain, Size: 854 bytes --]

On Tue, Mar 31, 2020 at 07:43:36PM +0000, Brice Waegeneire wrote:
> > I am curious about what actions are implemented in the system services
> > on my GuixSD install. I try something like the following for the
> > different system services and get an error:
> > 
> > jesse@piranhaplant ~$ sudo herd list-actions term-tty6
> > Password:
> > herd: service 'term-tty6' does not have an action 'list-actions'
> 
> The documentation has been updated in
> d5da712a5605a0cdaa4cf3bd64621a95a54520c0
> to clarify the use of 'list-actions' and there is an example on how to use
> it.
> 
> # herd doc term-tty6 list-actions
> term-tty6 ()
> # herd doc root list-actions
> root (help status halt power-off load eval unload reload daemonize
> persistency no-persistency cd restart)
> 
> This bug should be closed.

Here is a patch to fix a small typo in that commit.

[-- Attachment #2: 0001-doc-Fix-typo-in-Jump-start.patch --]
[-- Type: text/plain, Size: 1423 bytes --]

From 2b4785716abf2655d5be35679d5e2dfed62d27d7 Mon Sep 17 00:00:00 2001
From: Leo Famulari <leo@famulari.name>
Date: Tue, 31 Mar 2020 16:07:46 -0400
Subject: [PATCH] doc: Fix typo in Jump start.

* doc/shepherd.texi (Jump start): Fix typo in documentation of special action
'doc'.
---
 doc/shepherd.texi | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/doc/shepherd.texi b/doc/shepherd.texi
index 9ecd2ab..39454ba 100644
--- a/doc/shepherd.texi
+++ b/doc/shepherd.texi
@@ -289,11 +289,11 @@ 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}.
+In the same vein the special action @code{doc} describes its 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.
-- 
2.26.0

bug#36698: shepherd: list-actions not implemented

[Leo Famulari]

On Tue, Mar 31, 2020 at 04:09:19PM -0400, Leo Famulari wrote:
> Here is a patch to fix a small typo in that commit.

> From 2b4785716abf2655d5be35679d5e2dfed62d27d7 Mon Sep 17 00:00:00 2001
> From: Leo Famulari <leo@famulari.name>
> Date: Tue, 31 Mar 2020 16:07:46 -0400
> Subject: [PATCH] doc: Fix typo in Jump start.
> 
> * doc/shepherd.texi (Jump start): Fix typo in documentation of special action
> 'doc'.

Pushed as e9f3560414ed9c6ee9afe3a9ab85fd8e114f97cb