From: "Ludovic Courtès" <ludo@gnu.org>
To: 43159@debbugs.gnu.org
Cc: "Ludovic Courtès" <ludo@gnu.org>
Subject: [bug#43159] [PATCH 0/2] Make 'guix help' helpful
Date: Tue, 1 Sep 2020 22:35:20 +0200 [thread overview]
Message-ID: <20200901203520.21103-1-ludo@gnu.org> (raw)
Hey Guix!
Here’s another long-overdue change that was brought to my
attention: making ‘guix help’ show a synopsis of each command.
While at it, it also groups them in categories (I more or
less followed the manual, but there’s prolly room for
improvement, like a ‘packaging’ category maybe?):
--8<---------------cut here---------------start------------->8---
$ ./pre-inst-env guix help
Usage: guix COMMAND ARGS...
Run COMMAND with ARGS.
COMMAND must be one of the sub-commands listed below:
main commands:
deploy deploy operating systems on a set of machines
describe describe the channel revisions currently used
gc invoke the garbage collector
install install packages
package manage packages and profiles
pull pull the latest revision of Guix
remove removed installed packages
search search for packages
show show information about packages
system build and deploy full operating systems
time-machine run commands from a different revision
upgrade upgrade packages to their latest version
weather report on the available of pre-built package binaries
commands for developers:
build build packages or derivations without installing them
container run code in containers created by 'guix environment -C'
edit view and edit package definitions
environment spawn one-off software environments
import import a package definition from an external repository
pack create application bundles
refresh update existing package definitions
advanced usage:
archive manipulate, export, and import normalized archives (nars)
challenge challenge substitute servers, comparing their binaries
copy copy store items remotely over SSH
download download a file to the store and print its hash
git operate on Git repositories
graph view and query package dependency graphs
hash compute the cryptographic hash of a file
lint validate package definitions
offload set up and operate build offloading
processes list currently running sessions
publish publish build results over HTTP
repl read-eval-print loop (REPL) for interactive programming
size profile the on-disk size of packages
Report bugs to: bug-guix@gnu.org.
GNU Guix home page: <https://www.gnu.org/software/guix/>
General help using Guix and GNU software: <https://guix.gnu.org/help/>
--8<---------------cut here---------------end--------------->8---
Much more… helpful than what we currently have, no? :-)
This works by introducing a new ‘define-command’ macro that each
command now uses and where it defines its synopsis. ‘guix help’
actually reads files in search of ‘define-command’, which is cheaper
than loading each module and doing some sort of introspection.
The URL shown at the end (“General help”) is also changed, as was
rightfully suggested by zimoun a while back.
Thoughts?
Ludo’.
PS: We can talk about categories, but make sure to turn on the
bikeshedding limitation mode of your mail client. :-)
Ludovic Courtès (2):
scripts: Use 'define-command' and have 'guix help' use that.
ui: '--help' output links to <https://guix.gnu.org/help/>.
guix/scripts.scm | 29 ++++++++++-
guix/scripts/archive.scm | 5 +-
guix/scripts/authenticate.scm | 8 ++-
guix/scripts/build.scm | 5 +-
guix/scripts/challenge.scm | 5 +-
guix/scripts/container.scm | 6 ++-
guix/scripts/copy.scm | 5 +-
guix/scripts/deploy.scm | 3 +-
guix/scripts/describe.scm | 3 +-
guix/scripts/download.scm | 5 +-
guix/scripts/edit.scm | 7 ++-
guix/scripts/environment.scm | 5 +-
guix/scripts/gc.scm | 4 +-
guix/scripts/git.scm | 6 ++-
guix/scripts/graph.scm | 5 +-
guix/scripts/hash.scm | 5 +-
guix/scripts/import.scm | 8 ++-
guix/scripts/install.scm | 6 ++-
guix/scripts/lint.scm | 5 +-
guix/scripts/offload.scm | 6 ++-
guix/scripts/pack.scm | 5 +-
guix/scripts/package.scm | 4 +-
guix/scripts/perform-download.scm | 18 ++++---
guix/scripts/processes.scm | 4 +-
guix/scripts/publish.scm | 5 +-
guix/scripts/pull.scm | 4 +-
guix/scripts/refresh.scm | 7 ++-
guix/scripts/remove.scm | 6 ++-
guix/scripts/repl.scm | 5 +-
guix/scripts/search.scm | 6 ++-
guix/scripts/show.scm | 4 +-
guix/scripts/size.scm | 7 ++-
guix/scripts/substitute.scm | 7 ++-
guix/scripts/system.scm | 4 +-
guix/scripts/time-machine.scm | 4 +-
guix/scripts/upgrade.scm | 6 ++-
guix/scripts/weather.scm | 4 +-
guix/ui.scm | 82 +++++++++++++++++++++++++++----
38 files changed, 249 insertions(+), 64 deletions(-)
--
2.28.0
next reply other threads:[~2020-09-01 20:36 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-09-01 20:35 Ludovic Courtès [this message]
2020-09-01 20:41 ` [bug#43159] [PATCH 1/2] scripts: Use 'define-command' and have 'guix help' use that Ludovic Courtès
2020-09-01 20:41 ` [bug#43159] [PATCH 2/2] ui: '--help' output links to <https://guix.gnu.org/help/> Ludovic Courtès
2020-09-02 18:27 ` Maxim Cournoyer
2020-09-02 18:24 ` [bug#43159] [PATCH 1/2] scripts: Use 'define-command' and have 'guix help' use that Maxim Cournoyer
2020-09-03 13:41 ` Ludovic Courtès
2020-09-11 18:58 ` Maxim Cournoyer
2020-09-13 13:03 ` Ludovic Courtès
2020-09-13 23:33 ` Maxim Cournoyer
2020-09-07 12:56 ` [bug#43159] [PATCHES v2] " Ludovic Courtès
2020-09-10 10:34 ` bug#43159: " Ludovic Courtès
2020-09-10 10:55 ` [bug#43159] " Ricardo Wurmus
2020-09-02 8:06 ` [bug#43159] [PATCH 0/2] Make 'guix help' helpful Efraim Flashner
2020-09-02 9:50 ` Ludovic Courtès
2020-09-02 11:09 ` Efraim Flashner
2020-09-03 16:40 ` zimoun
2020-09-07 12:58 ` Ludovic Courtès
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=20200901203520.21103-1-ludo@gnu.org \
--to=ludo@gnu.org \
--cc=43159@debbugs.gnu.org \
/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).