[PATCH shepherd] herd: Suggest alternatives when action and service are likely swapped.

Done

Details

4 participants

Oleg Pykhalov
Jonathan Brielmaier
Leo Prikler
Ludovic Courtès

Owner: unassigned

Submitted by: Leo Prikler

Severity: normal

Leo Prikler wrote on 2 Dec 2020 10:21

Recipients:(address . guix-patches@gnu.org)

Message-ID:20201202092106.22770-1-leo.prikler@student.tugraz.at

* modules/shepherd/script/herd.scm (run-command)[reply error]: Report a more
descriptive error if service could reasonably have been an action.
---
 modules/shepherd/scripts/herd.scm | 9 +++++++++
 1 file changed, 9 insertions(+)

Toggle diff (22 lines)diff --git a/modules/shepherd/scripts/herd.scm b/modules/shepherd/scripts/herd.scm
index 106de1e..a178f51 100644
--- a/modules/shepherd/scripts/herd.scm
+++ b/modules/shepherd/scripts/herd.scm
@@ -179,6 +179,15 @@ the daemon via SOCKET-FILE."
                 ('messages messages))
         (for-each display-line messages)
         (report-command-error error)
+        (match (list action service)
+          ((_ (or 'start 'stop 'status 'doc))
+           (report-error (l10n "did you mean 'herd ~a ~a'?")
+                         service action))
+          ((root (or 'help 'halt 'power-off 'load 'eval 'unload 'reload
+                     'daemonize 'persistency 'no-persistency 'cd 'restart))
+           (report-error (l10n "did you mean 'herd ~a ~a'?")
+                         service action))
+          ((_ _) *unspecified*))
         (exit 1))
        ((? eof-object?)
         ;; When stopping shepherd, we may get an EOF in lieu of a real reply,
-- 
2.29.2

Jonathan Brielmaier wrote on 2 Dec 2020 21:03

Recipients:(address . guix-patches@gnu.org)

Message-ID:c7c5ce55-a080-91c6-d29c-bbc0aa181492@web.de

On 02.12.20 10:21, Leo Prikler wrote:

Toggle quote (3 lines)

> * modules/shepherd/script/herd.scm (run-command)[reply error]: Report a more

> descriptive error if service could reasonably have been an action.

I didn't test it, but it sounds like a good idea :)

It reminds me that I should maybe write bash completions files for

shepherd as it annoys me pretty hard ^^

Oleg Pykhalov wrote on 4 Dec 2020 18:18

Recipients:(name . Jonathan Brielmaier)(address . jonathan.brielmaier@web.de)(address . 45004@debbugs.gnu.org)

Message-ID:87a6utqyku.fsf@gmail.com

Jonathan Brielmaier <jonathan.brielmaier@web.de> writes:

[…]

Toggle quote (3 lines)

> It reminds me that I should maybe write bash completions files for

> shepherd as it annoys me pretty hard ^^

You could take my, which probably should be improved before merging to

Shepherd IMHO, e.g. avoid 'awk'.

~/.local/share/bash-completion/completions/herd

_herd_complete_service(){
    local command="${COMP_WORDS[1]}"
    local services="$(sudo herd status | awk '/*/ || /^ +/ || /^ -/ { print $NF }' | sort -u)"
    COMPREPLY=($(compgen -W "$services" -- "${COMP_WORDS[$COMP_CWORD]}"))
}

_herd_is_command ()
{
    local word
    local result="false"
    for word in ${COMP_WORDS[*]}t
    do
	if [ "$word" = "$1" ]
	then
	    result=true
	    break
	fi
    done
    $result
}

_herd_complete()
{
    local word_count=${#COMP_WORDS[*]}
    local word_at_point="${COMP_WORDS[$COMP_CWORD]}"
    case $COMP_CWORD in
        1)
	    if [ -z "$_herd_subcommands" ]
	    then
		# Cache the list of subcommands to speed things up.
		_herd_subcommands="enable disable start status stop"
	    fi
            COMPREPLY=($(compgen -W "$_herd_subcommands" -- "${COMP_WORDS[$COMP_CWORD]}"))
            ;;
        *)
            case $COMP_CWORD in
		2) _herd_complete_service;;
	    esac
            ;;
    esac
}

complete -F _herd_complete herd

Ludovic Courtès wrote on 2 Jun 2023 15:56

Bash completion for ‘herd’

Recipients:(name . Oleg Pykhalov)(address . go.wigust@gmail.com)

Message-ID:87h6rq55ok.fsf_-_@gnu.org

Hi Oleg,

Oleg Pykhalov <go.wigust@gmail.com> skribis:

Toggle quote (49 lines)> You could take my, which probably should be improved before merging to
> Shepherd IMHO, e.g. avoid 'awk'.
>
> ~/.local/share/bash-completion/completions/herd
>
> _herd_complete_service(){
>     local command="${COMP_WORDS[1]}"
>     local services="$(sudo herd status | awk '/*/ || /^ +/ || /^ -/ { print $NF }' | sort -u)"
>     COMPREPLY=($(compgen -W "$services" -- "${COMP_WORDS[$COMP_CWORD]}"))
> }
>
> _herd_is_command ()
> {
>     local word
>     local result="false"
>     for word in ${COMP_WORDS[*]}t
>     do
> 	if [ "$word" = "$1" ]
> 	then
> 	    result=true
> 	    break
> 	fi
>     done
>     $result
> }
>
> _herd_complete()
> {
>     local word_count=${#COMP_WORDS[*]}
>     local word_at_point="${COMP_WORDS[$COMP_CWORD]}"
>     case $COMP_CWORD in
>         1)
> 	    if [ -z "$_herd_subcommands" ]
> 	    then
> 		# Cache the list of subcommands to speed things up.
> 		_herd_subcommands="enable disable start status stop"
> 	    fi
>             COMPREPLY=($(compgen -W "$_herd_subcommands" -- "${COMP_WORDS[$COMP_CWORD]}"))
>             ;;
>         *)
>             case $COMP_CWORD in
> 		2) _herd_complete_service;;
> 	    esac
>             ;;
>     esac
> }
>
> complete -F _herd_complete herd

Would you mind polishing a bit (as you see fit; perhaps use grep/sed
rather than Awk?) and submitting a patch for this?  I’d be happy to
apply it!

Thanks,
Ludo’.

Ludovic Courtès wrote on 2 Jun 2023 16:04

Re: bug#45004: [PATCH shepherd] herd: Suggest alternatives when action and service are likely swapped.

Recipients:(name . Liliana Marie Prikler)(address . liliana.prikler@gmail.com)(address . 45004-done@debbugs.gnu.org)

Message-ID:87cz2e55a9.fsf@gnu.org

Hey Liliana,

Toggle quote (3 lines)

> * modules/shepherd/script/herd.scm (run-command)[reply error]: Report a more

> descriptive error if service could reasonably have been an action.

I found this old patch of yours, which I find very useful. So… finally

applied as Shepherd commit b9b15db9e5bda27287706b6727c462df686e7621!

Thanks,

Ludo’.

Closed

Oleg Pykhalov wrote on 3 Jun 2023 00:23

Re: Bash completion for ‘herd’

Recipients:(name . Ludovic Courtès)(address . ludo@gnu.org)

Message-ID:878rd1cxlv.fsf@gmail.com

Hi Ludovic,

Ludovic Courtès <ludo@gnu.org> writes:

[…]

Toggle quote (4 lines)

> Would you mind polishing a bit (as you see fit; perhaps use grep/sed

> rather than Awk?) and submitting a patch for this? I’d be happy to

> apply it!

Done. Please check the 63860 issue.

Regards,

Oleg.

Your comment

This issue is archived.

To comment on this conversation send an email to 45004@debbugs.gnu.org

is:open	open issues
is:done	closed issues
submitter:<who>	search issue submitter
author:<who>	search by message author
date:yesterday..now	search by issue date
mdate:3m..2d	search by message date