unofficial mirror of guix-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Simon Tournier <zimon.toutoune@gmail.com>
To: Ricardo Wurmus <rekado@elephly.net>, guix-devel@gnu.org
Subject: Re: Unhelpful "--help" output
Date: Tue, 10 Dec 2024 17:44:34 +0100	[thread overview]
Message-ID: <87a5d3xzbh.fsf@gmail.com> (raw)
In-Reply-To: <877c98egqi.fsf@elephly.net>

Hi Ricardo,

On Tue, 12 Nov 2024 at 14:14, Ricardo Wurmus <rekado@elephly.net> wrote:

> Note that this is the same output as for "guix system --help".

Yes, that’s because the command-line parser is poorly implemented. :-)

> - In the case of commands that offer sub-commands, remove *all* the
> options from the help output of the main command (e.g. "guix system
> --help"), and only showing the list of available sub-commands.

Yes.  Well, let start with “guix system”. :-)

> - For "guix [command] [sub-command] --help" show only options to this
>   sub-command.

Yes.

> - optionally, group all generic options (e.g. --system, --help,
>   --version, etc) under a single heading.

Yes.  It appears to me the easiest. ;-)

Cheers,
simon

PS: I think it might be an “easy” contribution for Google Summer of
Code candidate… But maybe it could be nice to improve before the next
round.


  parent reply	other threads:[~2024-12-10 16:50 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-11-12 13:14 Unhelpful "--help" output Ricardo Wurmus
2024-11-12 15:03 ` Suhail Singh
2024-11-12 15:06 ` Luis Felipe
2024-12-10 16:44 ` Simon Tournier [this message]
  -- strict thread matches above, loose matches on Subject: below --
2024-11-12 16:23 Christopher Howard
2024-11-12 16:31 ` indieterminacy
2024-11-12 19:56   ` Christopher Howard
2024-11-13 18:17 ` Ricardo Wurmus
2024-11-13 22:35   ` Christopher Howard
2024-11-14 10:37     ` Ricardo Wurmus

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://guix.gnu.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87a5d3xzbh.fsf@gmail.com \
    --to=zimon.toutoune@gmail.com \
    --cc=guix-devel@gnu.org \
    --cc=rekado@elephly.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/guix.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).