* [bug#43159] [PATCH 0/2] Make 'guix help' helpful
@ 2020-09-01 20:35 Ludovic Courtès
2020-09-01 20:41 ` [bug#43159] [PATCH 1/2] scripts: Use 'define-command' and have 'guix help' use that Ludovic Courtès
` (2 more replies)
0 siblings, 3 replies; 17+ messages in thread
From: Ludovic Courtès @ 2020-09-01 20:35 UTC (permalink / raw)
To: 43159; +Cc: Ludovic Courtès
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
^ permalink raw reply [flat|nested] 17+ messages in thread* [bug#43159] [PATCH 1/2] scripts: Use 'define-command' and have 'guix help' use that. 2020-09-01 20:35 [bug#43159] [PATCH 0/2] Make 'guix help' helpful Ludovic Courtès @ 2020-09-01 20:41 ` 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:24 ` [bug#43159] [PATCH 1/2] scripts: Use 'define-command' and have 'guix help' use that Maxim Cournoyer 2020-09-02 8:06 ` [bug#43159] [PATCH 0/2] Make 'guix help' helpful Efraim Flashner 2020-09-03 16:40 ` zimoun 2 siblings, 2 replies; 17+ messages in thread From: Ludovic Courtès @ 2020-09-01 20:41 UTC (permalink / raw) To: 43159; +Cc: Ludovic Courtès This changes 'guix help' to print a short synopsis for each command and to group commands by category. * guix/scripts.scm (synopsis, category): New variables. (define-command): New macro. * guix/ui.scm (<command>): New record type. (source-file-command): New procedure. (command-files): Return absolute file names. (commands): Return a list of <command> records. (show-guix-help)[display-commands, category-predicate]: New procedures. Display commands grouped in three categories. * guix/scripts/archive.scm (guix-archive): Use 'define-command'. * guix/scripts/authenticate.scm (guix-authenticate): Likewise. * guix/scripts/build.scm (guix-build): Likewise. * guix/scripts/challenge.scm (guix-challenge): Likewise. * guix/scripts/container.scm (guix-container): Likewise. * guix/scripts/copy.scm (guix-copy): Likewise. * guix/scripts/deploy.scm (guix-deploy): Likewise. * guix/scripts/describe.scm (guix-describe): Likewise. * guix/scripts/download.scm (guix-download): Likewise. * guix/scripts/edit.scm (guix-edit): Likewise. * guix/scripts/environment.scm (guix-environment): Likewise. * guix/scripts/gc.scm (guix-gc): Likewise. * guix/scripts/git.scm (guix-git): Likewise. * guix/scripts/graph.scm (guix-graph): Likewise. * guix/scripts/hash.scm (guix-hash): Likewise. * guix/scripts/import.scm (guix-import): Likewise. * guix/scripts/install.scm (guix-install): Likewise. * guix/scripts/lint.scm (guix-lint): Likewise. * guix/scripts/offload.scm (guix-offload): Likewise. * guix/scripts/pack.scm (guix-pack): Likewise. * guix/scripts/package.scm (guix-package): Likewise. * guix/scripts/perform-download.scm (guix-perform-download): Likewise. * guix/scripts/processes.scm (guix-processes): Likewise. * guix/scripts/publish.scm (guix-publish): Likewise. * guix/scripts/pull.scm (guix-pull): Likewise. * guix/scripts/refresh.scm (guix-refresh): Likewise. * guix/scripts/remove.scm (guix-remove): Likewise. * guix/scripts/repl.scm (guix-repl): Likewise. * guix/scripts/search.scm (guix-search): Likewise. * guix/scripts/show.scm (guix-show): Likewise. * guix/scripts/size.scm (guix-size): Likewise. * guix/scripts/substitute.scm (guix-substitute): Likewise. * guix/scripts/system.scm (guix-system): Likewise. * guix/scripts/time-machine.scm (guix-time-machine): Likewise. * guix/scripts/upgrade.scm (guix-upgrade): Likewise. * guix/scripts/weather.scm (guix-weather): Likewise. --- 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 | 77 +++++++++++++++++++++++++++---- 38 files changed, 246 insertions(+), 62 deletions(-) diff --git a/guix/scripts.scm b/guix/scripts.scm index 8534948892..013b775818 100644 --- a/guix/scripts.scm +++ b/guix/scripts.scm @@ -34,7 +34,10 @@ #:use-module (srfi srfi-19) #:use-module (srfi srfi-37) #:use-module (ice-9 match) - #:export (args-fold* + #:export (synopsis + category + define-command + args-fold* parse-command-line maybe-build build-package @@ -50,6 +53,30 @@ ;;; ;;; Code: +;; Syntactic keywords. +(define synopsis 'command-synopsis) +(define category 'command-category) + +(define-syntax define-command + (syntax-rules (category synopsis) + "Define the given command as a procedure along with its synopsis and, +optionally, its category. The synopsis becomes the docstring of the +procedure, but both the category and synopsis are meant to be read (parsed) by +'guix help'." + ;; The (synopsis ...) form is here so that xgettext sees those strings as + ;; translatable. + ((_ (name . args) + (synopsis doc) body ...) + (define (name . args) + doc + body ...)) + ((_ (name . args) + (category _) + (synopsis doc) body ...) + (define (name . args) + doc + body ...)))) + (define (args-fold* args options unrecognized-option-proc operand-proc . seeds) "A wrapper on top of `args-fold' that does proper user-facing error reporting." diff --git a/guix/scripts/archive.scm b/guix/scripts/archive.scm index f3b86fba14..8796774a01 100644 --- a/guix/scripts/archive.scm +++ b/guix/scripts/archive.scm @@ -355,7 +355,10 @@ output port." ;;; Entry point. ;;; -(define (guix-archive . args) +(define-command (guix-archive . args) + (category advanced) + (synopsis "manipulate, export, and import normalized archives (nars)") + (define (lines port) ;; Return lines read from PORT. (let loop ((line (read-line port)) diff --git a/guix/scripts/authenticate.scm b/guix/scripts/authenticate.scm index f1fd8ee895..a4b9171fc7 100644 --- a/guix/scripts/authenticate.scm +++ b/guix/scripts/authenticate.scm @@ -1,5 +1,5 @@ ;;; GNU Guix --- Functional package management for GNU -;;; Copyright © 2013, 2014, 2015, 2016, 2017 Ludovic Courtès <ludo@gnu.org> +;;; Copyright © 2013, 2014, 2015, 2016, 2017, 2020 Ludovic Courtès <ludo@gnu.org> ;;; ;;; This file is part of GNU Guix. ;;; @@ -18,6 +18,7 @@ (define-module (guix scripts authenticate) #:use-module (guix config) + #:use-module (guix scripts) #:use-module (guix base16) #:use-module (gcrypt pk-crypto) #:use-module (guix pki) @@ -90,7 +91,10 @@ to stdout upon success." ;;; unmodified currently. ;;; -(define (guix-authenticate . args) +(define-command (guix-authenticate . args) + (category internal) + (synopsis "sign or verify signatures on normalized archives (nars)") + ;; Signature sexps written to stdout may contain binary data, so force ;; ISO-8859-1 encoding so that things are not mangled. See ;; <http://bugs.gnu.org/17312> for details. diff --git a/guix/scripts/build.scm b/guix/scripts/build.scm index 6286a43c02..37b8d82fd5 100644 --- a/guix/scripts/build.scm +++ b/guix/scripts/build.scm @@ -945,7 +945,10 @@ needed." ;;; Entry point. ;;; -(define (guix-build . args) +(define-command (guix-build . args) + (category development) + (synopsis "build packages or derivations without installing them") + (define opts (parse-command-line args %options (list %default-options))) diff --git a/guix/scripts/challenge.scm b/guix/scripts/challenge.scm index 624f51b200..6aab53152e 100644 --- a/guix/scripts/challenge.scm +++ b/guix/scripts/challenge.scm @@ -475,7 +475,10 @@ Challenge the substitutes for PACKAGE... provided by one or more servers.\n")) ;;; Entry point. ;;; -(define (guix-challenge . args) +(define-command (guix-challenge . args) + (category advanced) + (synopsis "challenge substitute servers, comparing their binaries") + (with-error-handling (let* ((opts (parse-command-line args %options (list %default-options) #:build-options? #f)) diff --git a/guix/scripts/container.scm b/guix/scripts/container.scm index 8041d64b6b..2369437043 100644 --- a/guix/scripts/container.scm +++ b/guix/scripts/container.scm @@ -20,6 +20,7 @@ (define-module (guix scripts container) #:use-module (ice-9 match) #:use-module (guix ui) + #:use-module (guix scripts) #:export (guix-container)) (define (show-help) @@ -46,7 +47,10 @@ Build and manipulate Linux containers.\n")) (proc (string->symbol (string-append "guix-container-" name)))) (module-ref module proc))) -(define (guix-container . args) +(define-command (guix-container . args) + (category development) + (synopsis "run code in containers created by 'guix environment -C'") + (with-error-handling (match args (() diff --git a/guix/scripts/copy.scm b/guix/scripts/copy.scm index 274620fc1e..b2eccae7a6 100644 --- a/guix/scripts/copy.scm +++ b/guix/scripts/copy.scm @@ -170,7 +170,10 @@ Copy ITEMS to or from the specified host over SSH.\n")) ;;; Entry point. ;;; -(define (guix-copy . args) +(define-command (guix-copy . args) + (category advanced) + (synopsis "copy store items remotely over SSH") + (with-error-handling (let* ((opts (parse-command-line args %options (list %default-options))) (source (assoc-ref opts 'source)) diff --git a/guix/scripts/deploy.scm b/guix/scripts/deploy.scm index 4a68197620..1b5be307be 100644 --- a/guix/scripts/deploy.scm +++ b/guix/scripts/deploy.scm @@ -136,7 +136,8 @@ Perform the deployment specified by FILE.\n")) (machine-display-name machine)))) \f -(define (guix-deploy . args) +(define-command (guix-deploy . args) + (synopsis "deploy operating systems on a set of machines") (define (handle-argument arg result) (alist-cons 'file arg result)) diff --git a/guix/scripts/describe.scm b/guix/scripts/describe.scm index bc868ffbbf..c3667516eb 100644 --- a/guix/scripts/describe.scm +++ b/guix/scripts/describe.scm @@ -304,7 +304,8 @@ text. The hyperlink links to a web view of COMMIT, when available." ;;; Entry point. ;;; -(define (guix-describe . args) +(define-command (guix-describe . args) + (synopsis "describe the channel revisions currently used") (let* ((opts (args-fold* args %options (lambda (opt name arg result) (leave (G_ "~A: unrecognized option~%") diff --git a/guix/scripts/download.scm b/guix/scripts/download.scm index 589f62da9d..7192aa14d0 100644 --- a/guix/scripts/download.scm +++ b/guix/scripts/download.scm @@ -156,7 +156,10 @@ and 'base16' ('hex' and 'hexadecimal' can be used as well).\n")) ;;; Entry point. ;;; -(define (guix-download . args) +(define-command (guix-download . args) + (category advanced) + (synopsis "download a file to the store and print its hash") + (define (parse-options) ;; Return the alist of option values. (args-fold* args %options diff --git a/guix/scripts/edit.scm b/guix/scripts/edit.scm index 43f3011869..39bd4f8a6c 100644 --- a/guix/scripts/edit.scm +++ b/guix/scripts/edit.scm @@ -1,5 +1,5 @@ ;;; GNU Guix --- Functional package management for GNU -;;; Copyright © 2015, 2016, 2019 Ludovic Courtès <ludo@gnu.org> +;;; Copyright © 2015, 2016, 2019, 2020 Ludovic Courtès <ludo@gnu.org> ;;; Copyright © 2015 Mathieu Lirzin <mthl@gnu.org> ;;; Copyright © 2020 Simon Tournier <zimon.toutoune@gmail.com> ;;; @@ -78,7 +78,10 @@ line." (search-path* %load-path (location-file location)))) \f -(define (guix-edit . args) +(define-command (guix-edit . args) + (category development) + (synopsis "view and edit package definitions") + (define (parse-arguments) ;; Return the list of package names. (args-fold* args %options diff --git a/guix/scripts/environment.scm b/guix/scripts/environment.scm index 1fb3505307..ad50281eb2 100644 --- a/guix/scripts/environment.scm +++ b/guix/scripts/environment.scm @@ -678,7 +678,10 @@ message if any test fails." ;;; Entry point. ;;; -(define (guix-environment . args) +(define-command (guix-environment . args) + (category development) + (synopsis "spawn one-off software environments") + (with-error-handling (let* ((opts (parse-args args)) (pure? (assoc-ref opts 'pure)) diff --git a/guix/scripts/gc.scm b/guix/scripts/gc.scm index ab7c13315f..043273f491 100644 --- a/guix/scripts/gc.scm +++ b/guix/scripts/gc.scm @@ -220,7 +220,9 @@ is deprecated; use '-D'~%")) ;;; Entry point. ;;; -(define (guix-gc . args) +(define-command (guix-gc . args) + (synopsis "invoke the garbage collector") + (define (parse-options) ;; Return the alist of option values. (parse-command-line args %options (list %default-options) diff --git a/guix/scripts/git.scm b/guix/scripts/git.scm index bc829cbe99..58a496a1b2 100644 --- a/guix/scripts/git.scm +++ b/guix/scripts/git.scm @@ -19,6 +19,7 @@ (define-module (guix scripts git) #:use-module (ice-9 match) #:use-module (guix ui) + #:use-module (guix scripts) #:export (guix-git)) (define (show-help) @@ -45,7 +46,10 @@ Operate on Git repositories.\n")) (proc (string->symbol (string-append "guix-git-" name)))) (module-ref module proc))) -(define (guix-git . args) +(define-command (guix-git . args) + (category advanced) + (synopsis "operate on Git repositories") + (with-error-handling (match args (() diff --git a/guix/scripts/graph.scm b/guix/scripts/graph.scm index 73d9269de2..bfeda4f61b 100644 --- a/guix/scripts/graph.scm +++ b/guix/scripts/graph.scm @@ -565,7 +565,10 @@ Emit a representation of the dependency graph of PACKAGE...\n")) ;;; Entry point. ;;; -(define (guix-graph . args) +(define-command (guix-graph . args) + (category advanced) + (synopsis "view and query package dependency graphs") + (with-error-handling (define opts (parse-command-line args %options diff --git a/guix/scripts/hash.scm b/guix/scripts/hash.scm index 9b4f419a24..480814df20 100644 --- a/guix/scripts/hash.scm +++ b/guix/scripts/hash.scm @@ -116,7 +116,10 @@ and 'base16' ('hex' and 'hexadecimal' can be used as well).\n")) ;;; Entry point. ;;; -(define (guix-hash . args) +(define-command (guix-hash . args) + (category advanced) + (synopsis "compute the cryptographic hash of a file") + (define (parse-options) ;; Return the alist of option values. (parse-command-line args %options (list %default-options) diff --git a/guix/scripts/import.scm b/guix/scripts/import.scm index c6cc93fad8..6e972561fb 100644 --- a/guix/scripts/import.scm +++ b/guix/scripts/import.scm @@ -1,5 +1,5 @@ ;;; GNU Guix --- Functional package management for GNU -;;; Copyright © 2012, 2013, 2014 Ludovic Courtès <ludo@gnu.org> +;;; Copyright © 2012, 2013, 2014, 2020 Ludovic Courtès <ludo@gnu.org> ;;; Copyright © 2014 David Thompson <davet@gnu.org> ;;; Copyright © 2018 Kyle Meyer <kyle@kyleam.com> ;;; Copyright © 2019 Ricardo Wurmus <rekado@elephly.net> @@ -21,6 +21,7 @@ (define-module (guix scripts import) #:use-module (guix ui) + #:use-module (guix scripts) #:use-module (guix utils) #:use-module (srfi srfi-1) #:use-module (srfi srfi-11) @@ -98,7 +99,10 @@ Run IMPORTER with ARGS.\n")) (newline) (show-bug-report-information)) -(define (guix-import . args) +(define-command (guix-import . args) + (category development) + (synopsis "import a package definition from an external repository") + (match args (() (format (current-error-port) diff --git a/guix/scripts/install.scm b/guix/scripts/install.scm index d88e86e77a..894e60f9da 100644 --- a/guix/scripts/install.scm +++ b/guix/scripts/install.scm @@ -1,5 +1,5 @@ ;;; GNU Guix --- Functional package management for GNU -;;; Copyright © 2019 Ludovic Courtès <ludo@gnu.org> +;;; Copyright © 2019, 2020 Ludovic Courtès <ludo@gnu.org> ;;; ;;; This file is part of GNU Guix. ;;; @@ -66,7 +66,9 @@ This is an alias for 'guix package -i'.\n")) %transformation-options %standard-build-options))) -(define (guix-install . args) +(define-command (guix-install . args) + (synopsis "install packages") + (define (handle-argument arg result arg-handler) ;; Treat all non-option arguments as package specs. (values (alist-cons 'install arg result) diff --git a/guix/scripts/lint.scm b/guix/scripts/lint.scm index 5168a1ca17..76bf18220a 100644 --- a/guix/scripts/lint.scm +++ b/guix/scripts/lint.scm @@ -157,7 +157,10 @@ run the checkers on all packages.\n")) ;;; Entry Point ;;; -(define (guix-lint . args) +(define-command (guix-lint . args) + (category advanced) + (synopsis "validate package definitions") + (define (parse-options) ;; Return the alist of option values. (parse-command-line args %options (list %default-options) diff --git a/guix/scripts/offload.scm b/guix/scripts/offload.scm index 1e0e9d7905..4afdb9396d 100644 --- a/guix/scripts/offload.scm +++ b/guix/scripts/offload.scm @@ -39,6 +39,7 @@ #:select (fcntl-flock set-thread-name)) #:use-module ((guix build utils) #:select (which mkdir-p)) #:use-module (guix ui) + #:use-module (guix scripts) #:use-module (guix diagnostics) #:use-module (srfi srfi-1) #:use-module (srfi srfi-11) @@ -725,7 +726,10 @@ machine." ;;; Entry point. ;;; -(define (guix-offload . args) +(define-command (guix-offload . args) + (category advanced) + (synopsis "set up and operate build offloading") + (define request-line-rx ;; The request format. See 'tryBuildHook' method in build.cc. (make-regexp "([01]) ([a-z0-9_-]+) (/[[:graph:]]+.drv) ([[:graph:]]*)")) diff --git a/guix/scripts/pack.scm b/guix/scripts/pack.scm index 9d6881fdaf..379e6a3ac6 100644 --- a/guix/scripts/pack.scm +++ b/guix/scripts/pack.scm @@ -1089,7 +1089,10 @@ Create a bundle of PACKAGE.\n")) ;;; Entry point. ;;; -(define (guix-pack . args) +(define-command (guix-pack . args) + (category development) + (synopsis "create application bundles") + (define opts (parse-command-line args %options (list %default-options))) diff --git a/guix/scripts/package.scm b/guix/scripts/package.scm index ac8dedb5f3..4eb968a49b 100644 --- a/guix/scripts/package.scm +++ b/guix/scripts/package.scm @@ -941,7 +941,9 @@ processed, #f otherwise." ;;; Entry point. ;;; -(define (guix-package . args) +(define-command (guix-package . args) + (synopsis "manage packages and profiles") + (define (handle-argument arg result arg-handler) ;; Process non-option argument ARG by calling back ARG-HANDLER. (if arg-handler diff --git a/guix/scripts/perform-download.scm b/guix/scripts/perform-download.scm index df787a9940..8d409092ba 100644 --- a/guix/scripts/perform-download.scm +++ b/guix/scripts/perform-download.scm @@ -1,5 +1,5 @@ ;;; GNU Guix --- Functional package management for GNU -;;; Copyright © 2016, 2017, 2018 Ludovic Courtès <ludo@gnu.org> +;;; Copyright © 2016, 2017, 2018, 2020 Ludovic Courtès <ludo@gnu.org> ;;; ;;; This file is part of GNU Guix. ;;; @@ -18,6 +18,7 @@ (define-module (guix scripts perform-download) #:use-module (guix ui) + #:use-module (guix scripts) #:use-module (guix derivations) #:use-module ((guix store) #:select (derivation-path? store-path?)) #:use-module (guix build download) @@ -91,14 +92,15 @@ actual output is different from that when we're doing a 'bmCheck' or (leave (G_ "refusing to run with elevated privileges (UID ~a)~%") (getuid)))) -(define (guix-perform-download . args) - "Perform the download described by the given fixed-output derivation. +(define-command (guix-perform-download . args) + (category internal) + (synopsis "perform download described by fixed-output derivations") -This is an \"out-of-band\" download in that this code is executed directly by -the daemon and not explicitly described as an input of the derivation. This -allows us to sidestep bootstrapping problems, such downloading the source code -of GnuTLS over HTTPS, before we have built GnuTLS. See -<http://bugs.gnu.org/22774>." + ;; This is an "out-of-band" download in that this code is executed directly + ;; by the daemon and not explicitly described as an input of the derivation. + ;; This allows us to sidestep bootstrapping problems, such as downloading + ;; the source code of GnuTLS over HTTPS before we have built GnuTLS. See + ;; <https://bugs.gnu.org/22774>. (define print-build-trace? (match (getenv "_NIX_OPTIONS") diff --git a/guix/scripts/processes.scm b/guix/scripts/processes.scm index 35698a0216..272eae2f6f 100644 --- a/guix/scripts/processes.scm +++ b/guix/scripts/processes.scm @@ -223,7 +223,9 @@ List the current Guix sessions and their processes.")) ;;; Entry point. ;;; -(define (guix-processes . args) +(define-command (guix-processes . args) + (category advanced) + (synopsis "list currently running sessions") (define options (args-fold* args %options (lambda (opt name arg result) diff --git a/guix/scripts/publish.scm b/guix/scripts/publish.scm index 61542f83a0..872931840a 100644 --- a/guix/scripts/publish.scm +++ b/guix/scripts/publish.scm @@ -1013,7 +1013,10 @@ methods, return the applicable compression." ;;; Entry point. ;;; -(define (guix-publish . args) +(define-command (guix-publish . args) + (category advanced) + (synopsis "publish build results over HTTP") + (with-error-handling (let* ((opts (args-fold* args %options (lambda (opt name arg result) diff --git a/guix/scripts/pull.scm b/guix/scripts/pull.scm index 3b980b8f3f..bb1b560a22 100644 --- a/guix/scripts/pull.scm +++ b/guix/scripts/pull.scm @@ -751,7 +751,9 @@ Use '~/.config/guix/channels.scm' instead.")) channels))) \f -(define (guix-pull . args) +(define-command (guix-pull . args) + (synopsis "pull the latest revision of Guix") + (with-error-handling (with-git-error-handling (let* ((opts (parse-command-line args %options diff --git a/guix/scripts/refresh.scm b/guix/scripts/refresh.scm index efada1df5a..eba996d6c6 100644 --- a/guix/scripts/refresh.scm +++ b/guix/scripts/refresh.scm @@ -1,5 +1,5 @@ ;;; GNU Guix --- Functional package management for GNU -;;; Copyright © 2013, 2014, 2015, 2016, 2017, 2018, 2019 Ludovic Courtès <ludo@gnu.org> +;;; Copyright © 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Ludovic Courtès <ludo@gnu.org> ;;; Copyright © 2013 Nikita Karetnikov <nikita@karetnikov.org> ;;; Copyright © 2014 Eric Bavier <bavier@member.fsf.org> ;;; Copyright © 2015 Alex Kost <alezost@gmail.com> @@ -496,7 +496,10 @@ all are dependent packages: ~{~a~^ ~}~%") ;;; Entry point. ;;; -(define (guix-refresh . args) +(define-command (guix-refresh . args) + (category development) + (synopsis "update existing package definitions") + (define (parse-options) ;; Return the alist of option values. (parse-command-line args %options (list %default-options) diff --git a/guix/scripts/remove.scm b/guix/scripts/remove.scm index 2f06ea4f37..e05fb05f07 100644 --- a/guix/scripts/remove.scm +++ b/guix/scripts/remove.scm @@ -1,5 +1,5 @@ ;;; GNU Guix --- Functional package management for GNU -;;; Copyright © 2019 Ludovic Courtès <ludo@gnu.org> +;;; Copyright © 2019, 2020 Ludovic Courtès <ludo@gnu.org> ;;; ;;; This file is part of GNU Guix. ;;; @@ -63,7 +63,9 @@ This is an alias for 'guix package -r'.\n")) %standard-build-options))) -(define (guix-remove . args) +(define-command (guix-remove . args) + (synopsis "removed installed packages") + (define (handle-argument arg result arg-handler) ;; Treat all non-option arguments as package specs. (values (alist-cons 'remove arg result) diff --git a/guix/scripts/repl.scm b/guix/scripts/repl.scm index 0ea9c3655c..202a3a197f 100644 --- a/guix/scripts/repl.scm +++ b/guix/scripts/repl.scm @@ -137,7 +137,10 @@ call THUNK." (loop))))))) \f -(define (guix-repl . args) +(define-command (guix-repl . args) + (category advanced) + (synopsis "read-eval-print loop (REPL) for interactive programming") + (define opts (args-fold* args %options (lambda (opt name arg result) diff --git a/guix/scripts/search.scm b/guix/scripts/search.scm index 827b2eb7a9..0c9e6af07b 100644 --- a/guix/scripts/search.scm +++ b/guix/scripts/search.scm @@ -1,5 +1,5 @@ ;;; GNU Guix --- Functional package management for GNU -;;; Copyright © 2019 Ludovic Courtès <ludo@gnu.org> +;;; Copyright © 2019, 2020 Ludovic Courtès <ludo@gnu.org> ;;; ;;; This file is part of GNU Guix. ;;; @@ -57,7 +57,9 @@ This is an alias for 'guix package -s'.\n")) (member "load-path" (option-names option))) %standard-build-options))) -(define (guix-search . args) +(define-command (guix-search . args) + (synopsis "search for packages") + (define (handle-argument arg result) ;; Treat all non-option arguments as regexps. (cons `(query search ,(or arg "")) diff --git a/guix/scripts/show.scm b/guix/scripts/show.scm index a2b0030a63..535d03c1a6 100644 --- a/guix/scripts/show.scm +++ b/guix/scripts/show.scm @@ -57,7 +57,9 @@ This is an alias for 'guix package --show='.\n")) (member "load-path" (option-names option))) %standard-build-options))) -(define (guix-show . args) +(define-command (guix-show . args) + (synopsis "show information about packages") + (define (handle-argument arg result) ;; Treat all non-option arguments as regexps. (cons `(query show ,arg) diff --git a/guix/scripts/size.scm b/guix/scripts/size.scm index c42f4f7782..2ed5d3cdd0 100644 --- a/guix/scripts/size.scm +++ b/guix/scripts/size.scm @@ -1,5 +1,5 @@ ;;; GNU Guix --- Functional package management for GNU -;;; Copyright © 2015, 2016, 2017, 2018, 2019 Ludovic Courtès <ludo@gnu.org> +;;; Copyright © 2015, 2016, 2017, 2018, 2019, 2020 Ludovic Courtès <ludo@gnu.org> ;;; Copyright © 2019 Simon Tournier <zimon.toutoune@gmail.com> ;;; ;;; This file is part of GNU Guix. @@ -298,7 +298,10 @@ Report the size of the PACKAGE or STORE-ITEM, with its dependencies.\n")) ;;; Entry point. ;;; -(define (guix-size . args) +(define-command (guix-size . args) + (category advanced) + (synopsis "profile the on-disk size of packages") + (with-error-handling (let* ((opts (parse-command-line args %options (list %default-options) #:build-options? #f)) diff --git a/guix/scripts/substitute.scm b/guix/scripts/substitute.scm index f9d19fd735..1462ce9918 100755 --- a/guix/scripts/substitute.scm +++ b/guix/scripts/substitute.scm @@ -20,6 +20,7 @@ (define-module (guix scripts substitute) #:use-module (guix ui) + #:use-module (guix scripts) #:use-module (guix store) #:use-module (guix utils) #:use-module (guix combinators) @@ -1095,8 +1096,10 @@ default value." (unless (string->uri uri) (leave (G_ "~a: invalid URI~%") uri))) -(define (guix-substitute . args) - "Implement the build daemon's substituter protocol." +(define-command (guix-substitute . args) + (category internal) + (synopsis "implement the build daemon's substituter protocol") + (define print-build-trace? (match (or (find-daemon-option "untrusted-print-extended-build-trace") (find-daemon-option "print-extended-build-trace")) diff --git a/guix/scripts/system.scm b/guix/scripts/system.scm index 3222a53c8f..2a514166eb 100644 --- a/guix/scripts/system.scm +++ b/guix/scripts/system.scm @@ -1240,7 +1240,9 @@ argument list and OPTS is the option alist." ;; need an operating system configuration file. (else (process-action command args opts)))) -(define (guix-system . args) +(define-command (guix-system . args) + (synopsis "build and deploy full operating systems") + (define (parse-sub-command arg result) ;; Parse sub-command ARG and augment RESULT accordingly. (if (assoc-ref result 'action) diff --git a/guix/scripts/time-machine.scm b/guix/scripts/time-machine.scm index 441673b780..0d27414702 100644 --- a/guix/scripts/time-machine.scm +++ b/guix/scripts/time-machine.scm @@ -128,7 +128,9 @@ Execute COMMAND ARGS... in an older version of Guix.\n")) ;;; Entry point. ;;; -(define (guix-time-machine . args) +(define-command (guix-time-machine . args) + (synopsis "run commands from a different revision") + (with-error-handling (with-git-error-handling (let* ((opts (parse-args args)) diff --git a/guix/scripts/upgrade.scm b/guix/scripts/upgrade.scm index d2784669be..8c7abd133a 100644 --- a/guix/scripts/upgrade.scm +++ b/guix/scripts/upgrade.scm @@ -1,5 +1,5 @@ ;;; GNU Guix --- Functional package management for GNU -;;; Copyright © 2019 Ludovic Courtès <ludo@gnu.org> +;;; Copyright © 2019, 2020 Ludovic Courtès <ludo@gnu.org> ;;; Copyright © 2020 Jakub Kądziołka <kuba@kadziolka.net> ;;; ;;; This file is part of GNU Guix. @@ -67,7 +67,9 @@ This is an alias for 'guix package -u'.\n")) %transformation-options %standard-build-options))) -(define (guix-upgrade . args) +(define-command (guix-upgrade . args) + (synopsis "upgrade packages to their latest version") + (define (handle-argument arg result arg-handler) ;; Accept at most one non-option argument, and treat it as an upgrade ;; regexp. diff --git a/guix/scripts/weather.scm b/guix/scripts/weather.scm index 3035ff6ca8..48207d4205 100644 --- a/guix/scripts/weather.scm +++ b/guix/scripts/weather.scm @@ -495,7 +495,9 @@ SERVER. Display information for packages with at least THRESHOLD dependents." ;;; Entry point. ;;; -(define (guix-weather . args) +(define-command (guix-weather . args) + (synopsis "report on the available of pre-built package binaries") + (define (package-list opts) ;; Return the package list specified by OPTS. (let ((files (filter-map (match-lambda diff --git a/guix/ui.scm b/guix/ui.scm index efc3f39186..4d90a47bb9 100644 --- a/guix/ui.scm +++ b/guix/ui.scm @@ -60,6 +60,7 @@ ;; Avoid "overrides core binding" warning. delete)) #:use-module (srfi srfi-1) + #:use-module (srfi srfi-9 gnu) #:use-module (srfi srfi-11) #:use-module (srfi srfi-19) #:use-module (srfi srfi-26) @@ -1988,6 +1989,44 @@ optionally contain a version number and an output name, as in these examples: (G_ "Try `guix --help' for more information.~%")) (exit 1)) +;; Representation of a 'guix' command. +(define-immutable-record-type <command> + (command name synopsis category) + command? + (name command-name) + (synopsis command-synopsis) + (category command-category)) + +(define (source-file-command file) + "Read FILE, a Scheme source file, and return either a <command> object based +on the 'define-command' top-level form found therein, or #f if FILE does not +contain a 'define-command' form." + (define command-name + (match (string-split file #\/) + ((_ ... "guix" "scripts" name) + (list (file-sans-extension name))) + ((_ ... "guix" "scripts" first second) + (list first (file-sans-extension second))))) + + ;; The strategy here is to parse FILE. This is much cheaper than a + ;; technique based on run-time introspection where we'd load FILE and all + ;; the modules it depends on. + (call-with-input-file file + (lambda (port) + (let loop () + (match (read port) + (('define-command _ ('synopsis synopsis) + _ ...) + (command command-name synopsis 'main)) + (('define-command _ + ('category category) ('synopsis synopsis) + _ ...) + (command command-name synopsis category)) + ((? eof-object?) + #f) + (_ + (loop))))))) + (define (command-files) "Return the list of source files that define Guix sub-commands." (define directory @@ -1999,28 +2038,50 @@ optionally contain a version number and an output name, as in these examples: (cut string-suffix? ".scm" <>)) (if directory - (scandir directory dot-scm?) + (map (cut string-append directory "/" <>) + (scandir directory dot-scm?)) '())) (define (commands) - "Return the list of Guix command names." - (map (compose (cut string-drop-right <> 4) - basename) - (command-files))) + "Return the list of commands, alphabetically sorted." + (filter-map source-file-command (command-files))) (define (show-guix-help) (define (internal? command) (member command '("substitute" "authenticate" "offload" "perform-download"))) + (define (display-commands commands) + (let* ((names (map (lambda (command) + (string-join (command-name command))) + commands)) + (max-width (reduce max 0 (map string-length names)))) + (for-each (lambda (name command) + (format #t " ~a ~a~%" + (string-pad-right name max-width) + (G_ (command-synopsis command)))) + names + commands))) + + (define (category-predicate category) + (lambda (command) + (eq? category (command-category command)))) + (format #t (G_ "Usage: guix COMMAND ARGS... Run COMMAND with ARGS.\n")) (newline) (format #t (G_ "COMMAND must be one of the sub-commands listed below:\n")) (newline) - ;; TODO: Display a synopsis of each command. - (format #t "~{ ~a~%~}" (sort (remove internal? (commands)) - string<?)) + (let ((commands (commands))) + ;; Note: commands in other categories, such as "internal", are not shown. + (format #t (G_ " main commands:~%")) + (display-commands (filter (category-predicate 'main) commands)) + (newline) + (format #t (G_ " commands for developers:~%")) + (display-commands (filter (category-predicate 'development) commands)) + (newline) + (format #t (G_ " advanced usage:~%")) + (display-commands (filter (category-predicate 'advanced) commands))) (show-bug-report-information)) (define (run-guix-command command . args) -- 2.28.0 ^ permalink raw reply related [flat|nested] 17+ messages in thread
* [bug#43159] [PATCH 2/2] ui: '--help' output links to <https://guix.gnu.org/help/>. 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 ` 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 1 sibling, 1 reply; 17+ messages in thread From: Ludovic Courtès @ 2020-09-01 20:41 UTC (permalink / raw) To: 43159; +Cc: Ludovic Courtès * guix/ui.scm (show-bug-report-information): Link to <https://guix.gnu.org/help/> instead of <https://www.gnu.org/gethelp/>. The former is much more useful and includes links to GNU manuals. --- guix/ui.scm | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/guix/ui.scm b/guix/ui.scm index 4d90a47bb9..87a1925a4b 100644 --- a/guix/ui.scm +++ b/guix/ui.scm @@ -542,8 +542,9 @@ There is NO WARRANTY, to the extent permitted by law. Report bugs to: ~a.") %guix-bug-report-address) (format #t (G_ " ~a home page: <~a>") %guix-package-name %guix-home-page-url) - (display (G_ " -General help using GNU software: <http://www.gnu.org/gethelp/>")) + (format #t (G_ " +General help using Guix and GNU software: <~a>") + "https://guix.gnu.org/help/") (newline)) (define (augmented-system-error-handler file) -- 2.28.0 ^ permalink raw reply related [flat|nested] 17+ messages in thread
* [bug#43159] [PATCH 2/2] ui: '--help' output links to <https://guix.gnu.org/help/>. 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 0 siblings, 0 replies; 17+ messages in thread From: Maxim Cournoyer @ 2020-09-02 18:27 UTC (permalink / raw) To: Ludovic Courtès; +Cc: 43159 Ludovic Courtès <ludo@gnu.org> writes: > * guix/ui.scm (show-bug-report-information): Link to > <https://guix.gnu.org/help/> instead of <https://www.gnu.org/gethelp/>. > The former is much more useful and includes links to GNU manuals. > --- > guix/ui.scm | 5 +++-- > 1 file changed, 3 insertions(+), 2 deletions(-) > > diff --git a/guix/ui.scm b/guix/ui.scm > index 4d90a47bb9..87a1925a4b 100644 > --- a/guix/ui.scm > +++ b/guix/ui.scm > @@ -542,8 +542,9 @@ There is NO WARRANTY, to the extent permitted by law. > Report bugs to: ~a.") %guix-bug-report-address) > (format #t (G_ " > ~a home page: <~a>") %guix-package-name %guix-home-page-url) > - (display (G_ " > -General help using GNU software: <http://www.gnu.org/gethelp/>")) > + (format #t (G_ " > +General help using Guix and GNU software: <~a>") > + "https://guix.gnu.org/help/") > (newline)) LGTM! Maxim ^ permalink raw reply [flat|nested] 17+ messages in thread
* [bug#43159] [PATCH 1/2] scripts: Use 'define-command' and have 'guix help' use that. 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:24 ` Maxim Cournoyer 2020-09-03 13:41 ` Ludovic Courtès 2020-09-07 12:56 ` [bug#43159] [PATCHES v2] " Ludovic Courtès 1 sibling, 2 replies; 17+ messages in thread From: Maxim Cournoyer @ 2020-09-02 18:24 UTC (permalink / raw) To: Ludovic Courtès; +Cc: 43159 Ludovic Courtès <ludo@gnu.org> writes: > This changes 'guix help' to print a short synopsis for each command and > to group commands by category. [...] > diff --git a/guix/scripts.scm b/guix/scripts.scm > index 8534948892..013b775818 100644 > --- a/guix/scripts.scm > +++ b/guix/scripts.scm > @@ -34,7 +34,10 @@ > #:use-module (srfi srfi-19) > #:use-module (srfi srfi-37) > #:use-module (ice-9 match) > - #:export (args-fold* > + #:export (synopsis > + category > + define-command > + args-fold* > parse-command-line > maybe-build > build-package > @@ -50,6 +53,30 @@ > ;;; > ;;; Code: > > +;; Syntactic keywords. > +(define synopsis 'command-synopsis) > +(define category 'command-category) Are these definition really necessary/useful? I would have thought having category and synopsis understood as literals in the define-command syntax was enough? > +(define-syntax define-command > + (syntax-rules (category synopsis) > + "Define the given command as a procedure along with its synopsis and, > +optionally, its category. The synopsis becomes the docstring of the > +procedure, but both the category and synopsis are meant to be read (parsed) by > +'guix help'." > + ;; The (synopsis ...) form is here so that xgettext sees those strings as > + ;; translatable. > + ((_ (name . args) > + (synopsis doc) body ...) > + (define (name . args) > + doc > + body ...)) > + ((_ (name . args) > + (category _) > + (synopsis doc) body ...) > + (define (name . args) > + doc > + body ...)))) > + > (define (args-fold* args options unrecognized-option-proc operand-proc . seeds) > "A wrapper on top of `args-fold' that does proper user-facing error > reporting." > diff --git a/guix/scripts/archive.scm b/guix/scripts/archive.scm > index f3b86fba14..8796774a01 100644 > --- a/guix/scripts/archive.scm > +++ b/guix/scripts/archive.scm > @@ -355,7 +355,10 @@ output port." > ;;; Entry point. > ;;; > > -(define (guix-archive . args) > +(define-command (guix-archive . args) > + (category advanced) It'd be helpful if the category was an enum to keep the set of categories focused and helpful. [...] > --- a/guix/scripts/weather.scm > +++ b/guix/scripts/weather.scm > @@ -495,7 +495,9 @@ SERVER. Display information for packages with at least THRESHOLD dependents." > ;;; Entry point. > ;;; > > -(define (guix-weather . args) > +(define-command (guix-weather . args) > + (synopsis "report on the available of pre-built package binaries") ^ availability [...] > +(define (source-file-command file) > + "Read FILE, a Scheme source file, and return either a <command> object based > +on the 'define-command' top-level form found therein, or #f if FILE does not > +contain a 'define-command' form." > + (define command-name > + (match (string-split file #\/) > + ((_ ... "guix" "scripts" name) > + (list (file-sans-extension name))) > + ((_ ... "guix" "scripts" first second) > + (list first (file-sans-extension second))))) It'd be better if an else clause threw an informative error, especially since the restriction on file name is not otherwise documented. > + ;; The strategy here is to parse FILE. This is much cheaper than a > + ;; technique based on run-time introspection where we'd load FILE and all > + ;; the modules it depends on. Interesting! Have you measure it? I would have thought loading a couple optimized byte code modules could have been nearly as fast as parsing files manually. If so, I think it'd be preferable to use introspection rather than implement a custom parser. > + (call-with-input-file file > + (lambda (port) > + (let loop () > + (match (read port) > + (('define-command _ ('synopsis synopsis) > + _ ...) > + (command command-name synopsis 'main)) > + (('define-command _ > + ('category category) ('synopsis synopsis) > + _ ...) > + (command command-name synopsis category)) > + ((? eof-object?) > + #f) > + (_ > + (loop))))))) > + [...] > + (define (display-commands commands) > + (let* ((names (map (lambda (command) > + (string-join (command-name command))) > + commands)) > + (max-width (reduce max 0 (map string-length names)))) You can drop reduce and use (max (map string-length names)) instead. Maxim ^ permalink raw reply [flat|nested] 17+ messages in thread
* [bug#43159] [PATCH 1/2] scripts: Use 'define-command' and have 'guix help' use that. 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-07 12:56 ` [bug#43159] [PATCHES v2] " Ludovic Courtès 1 sibling, 1 reply; 17+ messages in thread From: Ludovic Courtès @ 2020-09-03 13:41 UTC (permalink / raw) To: Maxim Cournoyer; +Cc: 43159 Hi Maxim, Maxim Cournoyer <maxim.cournoyer@gmail.com> skribis: > Ludovic Courtès <ludo@gnu.org> writes: [...] >> +;; Syntactic keywords. >> +(define synopsis 'command-synopsis) >> +(define category 'command-category) > > Are these definition really necessary/useful? I would have thought > having category and synopsis understood as literals in the > define-command syntax was enough? It’s not strictly necessary but it’s been considered “good practice”. That allows users to detect name clashes, to rename/hide/etc. syntactic keywords and so on. >> +(define-syntax define-command >> + (syntax-rules (category synopsis) [...] >> -(define (guix-archive . args) >> +(define-command (guix-archive . args) >> + (category advanced) > > It'd be helpful if the category was an enum to keep the set of > categories focused and helpful. Yes, I thought about making it a syntactic keyword; let’s see. >> + ;; The strategy here is to parse FILE. This is much cheaper than a >> + ;; technique based on run-time introspection where we'd load FILE and all >> + ;; the modules it depends on. > > Interesting! Have you measure it? I would have thought loading a couple > optimized byte code modules could have been nearly as fast as parsing > files manually. If so, I think it'd be preferable to use introspection > rather than implement a custom parser. On a fast recent laptop with an SSD, a load of 0, hot cache, etc., we’d still be below 1s. But see: --8<---------------cut here---------------start------------->8--- $ strace -c guix help >/dev/null % time seconds usecs/call calls errors syscall ------ ----------- ----------- --------- --------- ------------------ 62.69 0.002698 1 2266 2043 stat 10.94 0.000471 2 161 2 lstat 4.55 0.000196 0 246 mmap 4.51 0.000194 0 330 172 openat [...] ------ ----------- ----------- --------- --------- ------------------ 100.00 0.004304 1 3748 2235 total $ strace -c guile -c '(use-modules (guix scripts system) (guix scripts authenticate))' % time seconds usecs/call calls errors syscall ------ ----------- ----------- --------- --------- ------------------ 54.27 0.007799 1 5735 4518 stat 12.00 0.001724 11 149 27 futex 9.06 0.001302 0 1328 651 openat 7.24 0.001040 1 822 mmap [...] ------ ----------- ----------- --------- --------- ------------------ 100.00 0.014371 1 10334 5202 total --8<---------------cut here---------------end--------------->8--- (The 1st run is the current ‘guix help’; the 2nd run +/- emulates what you propose.) Loading all the modules translates into a lot more I/O, roughly an order of magnitude. We’re talking about loading tens of modules just to get at that synopsis: --8<---------------cut here---------------start------------->8--- scheme@(guile-user)> ,use(guix modules) scheme@(guile-user)> (length (source-module-closure '((guix scripts system) (guix scripts authenticate)))) $10 = 439 scheme@(guile-user)> (length (source-module-closure '((guix scripts) (guix ui)))) $11 = 31 --8<---------------cut here---------------end--------------->8--- Memory usage would also be very different: --8<---------------cut here---------------start------------->8--- $ \time guix help >/dev/null 0.07user 0.01system 0:00.06elapsed 128%CPU (0avgtext+0avgdata 35348maxresident)k 0inputs+0outputs (0major+3906minor)pagefaults 0swaps $ \time guile -c '(use-modules (guix scripts system) (guix scripts authenticate))' 0.42user 0.05system 0:00.37elapsed 128%CPU (0avgtext+0avgdata 166916maxresident)k 0inputs+0outputs (0major+15148minor)pagefaults 0swaps --8<---------------cut here---------------end--------------->8--- In summary, while this approach undoubtedly looks awkward to any Lisper, I think it’s a good way to not contribute to the general impression of sluggishness and resource-hungriness of ‘guix’ commands. :-) >> + (define (display-commands commands) >> + (let* ((names (map (lambda (command) >> + (string-join (command-name command))) >> + commands)) >> + (max-width (reduce max 0 (map string-length names)))) > > You can drop reduce and use (max (map string-length names)) instead. I could do (apply max (map …)) but I don’t like the idea of abusing variadic argument lists in that way—I know, it’s very subjective. ;-) Thanks for your feedback, I’ll send a v2! Ludo’. ^ permalink raw reply [flat|nested] 17+ messages in thread
* [bug#43159] [PATCH 1/2] scripts: Use 'define-command' and have 'guix help' use that. 2020-09-03 13:41 ` Ludovic Courtès @ 2020-09-11 18:58 ` Maxim Cournoyer 2020-09-13 13:03 ` Ludovic Courtès 0 siblings, 1 reply; 17+ messages in thread From: Maxim Cournoyer @ 2020-09-11 18:58 UTC (permalink / raw) To: Ludovic Courtès; +Cc: 43159 Hi Ludovic, Sorry I couldn't reply faster. Ludovic Courtès <ludo@gnu.org> writes: [...] >>> +;; Syntactic keywords. >>> +(define synopsis 'command-synopsis) >>> +(define category 'command-category) >> >> Are these definition really necessary/useful? I would have thought >> having category and synopsis understood as literals in the >> define-command syntax was enough? > > It’s not strictly necessary but it’s been considered “good practice”. > That allows users to detect name clashes, to rename/hide/etc. syntactic > keywords and so on. I see! Thank you for explaining. [...] >>> + ;; The strategy here is to parse FILE. This is much cheaper than a >>> + ;; technique based on run-time introspection where we'd load FILE and all >>> + ;; the modules it depends on. >> >> Interesting! Have you measure it? I would have thought loading a couple >> optimized byte code modules could have been nearly as fast as parsing >> files manually. If so, I think it'd be preferable to use introspection >> rather than implement a custom parser. > > On a fast recent laptop with an SSD, a load of 0, hot cache, etc., we’d > still be below 1s. But see: > > $ strace -c guix help >/dev/null > % time seconds usecs/call calls errors syscall > ------ ----------- ----------- --------- --------- ------------------ > 62.69 0.002698 1 2266 2043 stat > 10.94 0.000471 2 161 2 lstat > 4.55 0.000196 0 246 mmap > 4.51 0.000194 0 330 172 openat > > [...] > > ------ ----------- ----------- --------- --------- ------------------ > 100.00 0.004304 1 3748 2235 total > $ strace -c guile -c '(use-modules (guix scripts system) (guix scripts authenticate))' > % time seconds usecs/call calls errors syscall > ------ ----------- ----------- --------- --------- ------------------ > 54.27 0.007799 1 5735 4518 stat > 12.00 0.001724 11 149 27 futex > 9.06 0.001302 0 1328 651 openat > 7.24 0.001040 1 822 mmap > > [...] > > ------ ----------- ----------- --------- --------- ------------------ > 100.00 0.014371 1 10334 5202 total > > > (The 1st run is the current ‘guix help’; the 2nd run +/- emulates what > you propose.) > > Loading all the modules translates into a lot more I/O, roughly an order > of magnitude. We’re talking about loading tens of modules just to get > at that synopsis: > > scheme@(guile-user)> ,use(guix modules) > scheme@(guile-user)> (length (source-module-closure '((guix scripts system) (guix scripts authenticate)))) > $10 = 439 > scheme@(guile-user)> (length (source-module-closure '((guix scripts) (guix ui)))) > $11 = 31 > > Memory usage would also be very different: > > $ \time guix help >/dev/null > 0.07user 0.01system 0:00.06elapsed 128%CPU (0avgtext+0avgdata 35348maxresident)k > 0inputs+0outputs (0major+3906minor)pagefaults 0swaps > $ \time guile -c '(use-modules (guix scripts system) (guix scripts authenticate))' > 0.42user 0.05system 0:00.37elapsed 128%CPU (0avgtext+0avgdata 166916maxresident)k > 0inputs+0outputs (0major+15148minor)pagefaults 0swaps Thanks for the detailed measurements! It does indeed seem your approach is better, especially considering memory usage. Perhaps the commands could have been moved to dedicated modules not using much dependency at all so that their closure would have been small hence fast to load, but keeping the commands definitions local to where they are useful is definitely a nice property. > In summary, while this approach undoubtedly looks awkward to any Lisper, > I think it’s a good way to not contribute to the general impression of > sluggishness and resource-hungriness of ‘guix’ commands. :-) > >>> + (define (display-commands commands) >>> + (let* ((names (map (lambda (command) >>> + (string-join (command-name command))) >>> + commands)) >>> + (max-width (reduce max 0 (map string-length names)))) >> >> You can drop reduce and use (max (map string-length names)) instead. > > I could do (apply max (map …)) but I don’t like the idea of abusing > variadic argument lists in that way—I know, it’s very subjective. ;-) Eh, I wonder why? I may be missing something, but if max allows it, doesn't it mean it's a valid use? Anyway, just curious to know what are the grounds for this personal preference :-). > Thanks for your feedback, I’ll send a v2! Thanks! I'm late, but LGTM, thank you. Maxim ^ permalink raw reply [flat|nested] 17+ messages in thread
* [bug#43159] [PATCH 1/2] scripts: Use 'define-command' and have 'guix help' use that. 2020-09-11 18:58 ` Maxim Cournoyer @ 2020-09-13 13:03 ` Ludovic Courtès 2020-09-13 23:33 ` Maxim Cournoyer 0 siblings, 1 reply; 17+ messages in thread From: Ludovic Courtès @ 2020-09-13 13:03 UTC (permalink / raw) To: Maxim Cournoyer; +Cc: 43159 Hi, Maxim Cournoyer <maxim.cournoyer@gmail.com> skribis: > Sorry I couldn't reply faster. No problem. I went ahead with this patch series, but nothing’s set in stone and I’m open to further changes. > Thanks for the detailed measurements! It does indeed seem your approach > is better, especially considering memory usage. Perhaps the commands > could have been moved to dedicated modules not using much dependency at > all so that their closure would have been small hence fast to load, but > keeping the commands definitions local to where they are useful is > definitely a nice property. We can’t really reduce the closure of commands. In particular, (guix scripts system) has to load pretty much “everything”. What we could do is use #:autoload aggressively in the (guix scripts …) modules, such that startup time would be as small as possible—e.g., ‘--help’ would not trigger loading of a zillion modules. It’s a bit tedious though and not necessarily helpful in the general case where one is doing something non-trivial with the command. Well dunno, we could try! >> In summary, while this approach undoubtedly looks awkward to any Lisper, >> I think it’s a good way to not contribute to the general impression of >> sluggishness and resource-hungriness of ‘guix’ commands. :-) >> >>>> + (define (display-commands commands) >>>> + (let* ((names (map (lambda (command) >>>> + (string-join (command-name command))) >>>> + commands)) >>>> + (max-width (reduce max 0 (map string-length names)))) >>> >>> You can drop reduce and use (max (map string-length names)) instead. >> >> I could do (apply max (map …)) but I don’t like the idea of abusing >> variadic argument lists in that way—I know, it’s very subjective. ;-) > > Eh, I wonder why? I may be missing something, but if max allows it, > doesn't it mean it's a valid use? Anyway, just curious to know what are > the grounds for this personal preference :-). It’s mostly aesthetic, but it comes from the idea that there could be limitations on the maximum number of arguments a procedure can take, or inefficiencies with dealing with many arguments. Now, in today’s Guile, there are no such issues… (And now I look really silly!) :-) Ludo’. ^ permalink raw reply [flat|nested] 17+ messages in thread
* [bug#43159] [PATCH 1/2] scripts: Use 'define-command' and have 'guix help' use that. 2020-09-13 13:03 ` Ludovic Courtès @ 2020-09-13 23:33 ` Maxim Cournoyer 0 siblings, 0 replies; 17+ messages in thread From: Maxim Cournoyer @ 2020-09-13 23:33 UTC (permalink / raw) To: Ludovic Courtès; +Cc: 43159 Hi Ludovic! Ludovic Courtès <ludo@gnu.org> writes: > Hi, > > Maxim Cournoyer <maxim.cournoyer@gmail.com> skribis: > >> Sorry I couldn't reply faster. > > No problem. I went ahead with this patch series, but nothing’s set in > stone and I’m open to further changes. No problem! I'm glad this nice UI improvement has already landed. >> Thanks for the detailed measurements! It does indeed seem your approach >> is better, especially considering memory usage. Perhaps the commands >> could have been moved to dedicated modules not using much dependency at >> all so that their closure would have been small hence fast to load, but >> keeping the commands definitions local to where they are useful is >> definitely a nice property. > > We can’t really reduce the closure of commands. In particular, (guix > scripts system) has to load pretty much “everything”. > > What we could do is use #:autoload aggressively in the (guix scripts …) > modules, such that startup time would be as small as possible—e.g., > ‘--help’ would not trigger loading of a zillion modules. > > It’s a bit tedious though and not necessarily helpful in the general > case where one is doing something non-trivial with the command. Well > dunno, we could try! Seems like too much micro-management. This further solidifies your design choice as the right one :-). >>> In summary, while this approach undoubtedly looks awkward to any Lisper, >>> I think it’s a good way to not contribute to the general impression of >>> sluggishness and resource-hungriness of ‘guix’ commands. :-) >>> >>>>> + (define (display-commands commands) >>>>> + (let* ((names (map (lambda (command) >>>>> + (string-join (command-name command))) >>>>> + commands)) >>>>> + (max-width (reduce max 0 (map string-length names)))) >>>> >>>> You can drop reduce and use (max (map string-length names)) instead. >>> >>> I could do (apply max (map …)) but I don’t like the idea of abusing >>> variadic argument lists in that way—I know, it’s very subjective. ;-) >> >> Eh, I wonder why? I may be missing something, but if max allows it, >> doesn't it mean it's a valid use? Anyway, just curious to know what are >> the grounds for this personal preference :-). > > It’s mostly aesthetic, but it comes from the idea that there could be > limitations on the maximum number of arguments a procedure can take, or > inefficiencies with dealing with many arguments. Now, in today’s Guile, > there are no such issues… (And now I look really silly!) :-) Ha! Thanks for explaining. Now I know I can shamelessly continue using apply on procedures accepting N arguments :-). Maxim ^ permalink raw reply [flat|nested] 17+ messages in thread
* [bug#43159] [PATCHES v2] scripts: Use 'define-command' and have 'guix help' use that. 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-07 12:56 ` Ludovic Courtès 2020-09-10 10:34 ` bug#43159: " Ludovic Courtès 1 sibling, 1 reply; 17+ messages in thread From: Ludovic Courtès @ 2020-09-07 12:56 UTC (permalink / raw) To: Maxim Cournoyer, Efraim Flashner, zimoun; +Cc: 43159 [-- Attachment #1: Type: text/plain, Size: 2985 bytes --] Hi all! Here’s a v2 of the patches, where I tried to take your feedback into account. Changes: • Categories that appear in uses of ‘define-command’ are now validated at macro-expansion time. • (guix scripts) contains an alist of the known categories and ‘show-help’ traverses it. • Changed the label for development commands to “commands for development”, and changed “advanced” to “plumbing”. • Added a “packaging” category. • Fixed the typos you reported. The end result is: --8<---------------cut here---------------start------------->8--- 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 remove 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 availability of pre-built package binaries software development commands container run code in containers created by 'guix environment -C' environment spawn one-off software environments pack create application bundles packaging commands build build packages or derivations without installing them challenge challenge substitute servers, comparing their binaries download download a file to the store and print its hash edit view and edit package definitions graph view and query package dependency graphs hash compute the cryptographic hash of a file import import a package definition from an external repository lint validate package definitions publish publish build results over HTTP refresh update existing package definitions size profile the on-disk size of packages plumbing commands archive manipulate, export, and import normalized archives (nars) copy copy store items remotely over SSH git operate on Git repositories offload set up and operate build offloading processes list currently running sessions repl read-eval-print loop (REPL) for interactive programming 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--- Let me know what you think! Thanks, Ludo’. [-- Attachment #2: 0002-scripts-Use-define-command-and-have-guix-help-use-th.patch --] [-- Type: text/x-patch, Size: 37031 bytes --] From 63c3ab624d6bee53a0221c35a0e280dd0673d64c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ludovic=20Court=C3=A8s?= <ludo@gnu.org> Date: Tue, 1 Sep 2020 22:13:11 +0200 Subject: [PATCH 2/2] scripts: Use 'define-command' and have 'guix help' use that. This changes 'guix help' to print a short synopsis for each command and to group commands by category. * guix/scripts.scm (synopsis, category): New variables. (define-command-categories, define-command): New macros. (%command-categories): New variable. * guix/ui.scm (<command>): New record type. (source-file-command): New procedure. (command-files): Return absolute file names. (commands): Return a list of <command> records. (show-guix-help)[display-commands, category-predicate]: New procedures. Display commands grouped in three categories. * guix/scripts/archive.scm (guix-archive): Use 'define-command'. * guix/scripts/authenticate.scm (guix-authenticate): Likewise. * guix/scripts/build.scm (guix-build): Likewise. * guix/scripts/challenge.scm (guix-challenge): Likewise. * guix/scripts/container.scm (guix-container): Likewise. * guix/scripts/copy.scm (guix-copy): Likewise. * guix/scripts/deploy.scm (guix-deploy): Likewise. * guix/scripts/describe.scm (guix-describe): Likewise. * guix/scripts/download.scm (guix-download): Likewise. * guix/scripts/edit.scm (guix-edit): Likewise. * guix/scripts/environment.scm (guix-environment): Likewise. * guix/scripts/gc.scm (guix-gc): Likewise. * guix/scripts/git.scm (guix-git): Likewise. * guix/scripts/graph.scm (guix-graph): Likewise. * guix/scripts/hash.scm (guix-hash): Likewise. * guix/scripts/import.scm (guix-import): Likewise. * guix/scripts/install.scm (guix-install): Likewise. * guix/scripts/lint.scm (guix-lint): Likewise. * guix/scripts/offload.scm (guix-offload): Likewise. * guix/scripts/pack.scm (guix-pack): Likewise. * guix/scripts/package.scm (guix-package): Likewise. * guix/scripts/perform-download.scm (guix-perform-download): Likewise. * guix/scripts/processes.scm (guix-processes): Likewise. * guix/scripts/publish.scm (guix-publish): Likewise. * guix/scripts/pull.scm (guix-pull): Likewise. * guix/scripts/refresh.scm (guix-refresh): Likewise. * guix/scripts/remove.scm (guix-remove): Likewise. * guix/scripts/repl.scm (guix-repl): Likewise. * guix/scripts/search.scm (guix-search): Likewise. * guix/scripts/show.scm (guix-show): Likewise. * guix/scripts/size.scm (guix-size): Likewise. * guix/scripts/substitute.scm (guix-substitute): Likewise. * guix/scripts/system.scm (guix-system): Likewise. * guix/scripts/time-machine.scm (guix-time-machine): Likewise. * guix/scripts/upgrade.scm (guix-upgrade): Likewise. * guix/scripts/weather.scm (guix-weather): Likewise. --- guix/scripts.scm | 62 +++++++++++++++++++++++- 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 | 80 +++++++++++++++++++++++++++---- 38 files changed, 281 insertions(+), 63 deletions(-) diff --git a/guix/scripts.scm b/guix/scripts.scm index 8534948892..9792aaebe9 100644 --- a/guix/scripts.scm +++ b/guix/scripts.scm @@ -34,7 +34,12 @@ #:use-module (srfi srfi-19) #:use-module (srfi srfi-37) #:use-module (ice-9 match) - #:export (args-fold* + #:export (synopsis + category + define-command + %command-categories + + args-fold* parse-command-line maybe-build build-package @@ -50,6 +55,61 @@ ;;; ;;; Code: +;; Syntactic keywords. +(define synopsis 'command-synopsis) +(define category 'command-category) + +(define-syntax define-command-categories + (syntax-rules (G_) + "Define command categories." + ((_ name assert-valid (identifiers (G_ synopses)) ...) + (begin + (define-public identifiers + ;; Define and export syntactic keywords. + (list 'syntactic-keyword-for-command-category)) + ... + + (define-syntax assert-valid + ;; Validate at expansion time that we're passed a valid category. + (syntax-rules (identifiers ...) + ((_ identifiers) #t) + ...)) + + (define name + ;; Alist mapping category name to synopsis. + `((identifiers . synopses) ...)))))) + +;; Command categories. +(define-command-categories %command-categories + assert-valid-command-category + (main (G_ "main commands")) + (development (G_ "software development commands")) + (packaging (G_ "packaging commands")) + (plumbing (G_ "plumbing commands")) + (internal (G_ "internal commands"))) + +(define-syntax define-command + (syntax-rules (category synopsis) + "Define the given command as a procedure along with its synopsis and, +optionally, its category. The synopsis becomes the docstring of the +procedure, but both the category and synopsis are meant to be read (parsed) by +'guix help'." + ;; The (synopsis ...) form is here so that xgettext sees those strings as + ;; translatable. + ((_ (name . args) + (synopsis doc) body ...) + (define (name . args) + doc + body ...)) + ((_ (name . args) + (category cat) (synopsis doc) + body ...) + (begin + (assert-valid-command-category cat) + (define (name . args) + doc + body ...))))) + (define (args-fold* args options unrecognized-option-proc operand-proc . seeds) "A wrapper on top of `args-fold' that does proper user-facing error reporting." diff --git a/guix/scripts/archive.scm b/guix/scripts/archive.scm index f3b86fba14..02557ce454 100644 --- a/guix/scripts/archive.scm +++ b/guix/scripts/archive.scm @@ -355,7 +355,10 @@ output port." ;;; Entry point. ;;; -(define (guix-archive . args) +(define-command (guix-archive . args) + (category plumbing) + (synopsis "manipulate, export, and import normalized archives (nars)") + (define (lines port) ;; Return lines read from PORT. (let loop ((line (read-line port)) diff --git a/guix/scripts/authenticate.scm b/guix/scripts/authenticate.scm index f1fd8ee895..a4b9171fc7 100644 --- a/guix/scripts/authenticate.scm +++ b/guix/scripts/authenticate.scm @@ -1,5 +1,5 @@ ;;; GNU Guix --- Functional package management for GNU -;;; Copyright © 2013, 2014, 2015, 2016, 2017 Ludovic Courtès <ludo@gnu.org> +;;; Copyright © 2013, 2014, 2015, 2016, 2017, 2020 Ludovic Courtès <ludo@gnu.org> ;;; ;;; This file is part of GNU Guix. ;;; @@ -18,6 +18,7 @@ (define-module (guix scripts authenticate) #:use-module (guix config) + #:use-module (guix scripts) #:use-module (guix base16) #:use-module (gcrypt pk-crypto) #:use-module (guix pki) @@ -90,7 +91,10 @@ to stdout upon success." ;;; unmodified currently. ;;; -(define (guix-authenticate . args) +(define-command (guix-authenticate . args) + (category internal) + (synopsis "sign or verify signatures on normalized archives (nars)") + ;; Signature sexps written to stdout may contain binary data, so force ;; ISO-8859-1 encoding so that things are not mangled. See ;; <http://bugs.gnu.org/17312> for details. diff --git a/guix/scripts/build.scm b/guix/scripts/build.scm index 6286a43c02..25418661b9 100644 --- a/guix/scripts/build.scm +++ b/guix/scripts/build.scm @@ -945,7 +945,10 @@ needed." ;;; Entry point. ;;; -(define (guix-build . args) +(define-command (guix-build . args) + (category packaging) + (synopsis "build packages or derivations without installing them") + (define opts (parse-command-line args %options (list %default-options))) diff --git a/guix/scripts/challenge.scm b/guix/scripts/challenge.scm index 624f51b200..39bd2c1c0f 100644 --- a/guix/scripts/challenge.scm +++ b/guix/scripts/challenge.scm @@ -475,7 +475,10 @@ Challenge the substitutes for PACKAGE... provided by one or more servers.\n")) ;;; Entry point. ;;; -(define (guix-challenge . args) +(define-command (guix-challenge . args) + (category packaging) + (synopsis "challenge substitute servers, comparing their binaries") + (with-error-handling (let* ((opts (parse-command-line args %options (list %default-options) #:build-options? #f)) diff --git a/guix/scripts/container.scm b/guix/scripts/container.scm index 8041d64b6b..2369437043 100644 --- a/guix/scripts/container.scm +++ b/guix/scripts/container.scm @@ -20,6 +20,7 @@ (define-module (guix scripts container) #:use-module (ice-9 match) #:use-module (guix ui) + #:use-module (guix scripts) #:export (guix-container)) (define (show-help) @@ -46,7 +47,10 @@ Build and manipulate Linux containers.\n")) (proc (string->symbol (string-append "guix-container-" name)))) (module-ref module proc))) -(define (guix-container . args) +(define-command (guix-container . args) + (category development) + (synopsis "run code in containers created by 'guix environment -C'") + (with-error-handling (match args (() diff --git a/guix/scripts/copy.scm b/guix/scripts/copy.scm index 274620fc1e..2780d4fbe9 100644 --- a/guix/scripts/copy.scm +++ b/guix/scripts/copy.scm @@ -170,7 +170,10 @@ Copy ITEMS to or from the specified host over SSH.\n")) ;;; Entry point. ;;; -(define (guix-copy . args) +(define-command (guix-copy . args) + (category plumbing) + (synopsis "copy store items remotely over SSH") + (with-error-handling (let* ((opts (parse-command-line args %options (list %default-options))) (source (assoc-ref opts 'source)) diff --git a/guix/scripts/deploy.scm b/guix/scripts/deploy.scm index 4a68197620..1b5be307be 100644 --- a/guix/scripts/deploy.scm +++ b/guix/scripts/deploy.scm @@ -136,7 +136,8 @@ Perform the deployment specified by FILE.\n")) (machine-display-name machine)))) \f -(define (guix-deploy . args) +(define-command (guix-deploy . args) + (synopsis "deploy operating systems on a set of machines") (define (handle-argument arg result) (alist-cons 'file arg result)) diff --git a/guix/scripts/describe.scm b/guix/scripts/describe.scm index bc868ffbbf..c3667516eb 100644 --- a/guix/scripts/describe.scm +++ b/guix/scripts/describe.scm @@ -304,7 +304,8 @@ text. The hyperlink links to a web view of COMMIT, when available." ;;; Entry point. ;;; -(define (guix-describe . args) +(define-command (guix-describe . args) + (synopsis "describe the channel revisions currently used") (let* ((opts (args-fold* args %options (lambda (opt name arg result) (leave (G_ "~A: unrecognized option~%") diff --git a/guix/scripts/download.scm b/guix/scripts/download.scm index 589f62da9d..ce8dd8b02c 100644 --- a/guix/scripts/download.scm +++ b/guix/scripts/download.scm @@ -156,7 +156,10 @@ and 'base16' ('hex' and 'hexadecimal' can be used as well).\n")) ;;; Entry point. ;;; -(define (guix-download . args) +(define-command (guix-download . args) + (category packaging) + (synopsis "download a file to the store and print its hash") + (define (parse-options) ;; Return the alist of option values. (args-fold* args %options diff --git a/guix/scripts/edit.scm b/guix/scripts/edit.scm index 43f3011869..49c9d945b6 100644 --- a/guix/scripts/edit.scm +++ b/guix/scripts/edit.scm @@ -1,5 +1,5 @@ ;;; GNU Guix --- Functional package management for GNU -;;; Copyright © 2015, 2016, 2019 Ludovic Courtès <ludo@gnu.org> +;;; Copyright © 2015, 2016, 2019, 2020 Ludovic Courtès <ludo@gnu.org> ;;; Copyright © 2015 Mathieu Lirzin <mthl@gnu.org> ;;; Copyright © 2020 Simon Tournier <zimon.toutoune@gmail.com> ;;; @@ -78,7 +78,10 @@ line." (search-path* %load-path (location-file location)))) \f -(define (guix-edit . args) +(define-command (guix-edit . args) + (category packaging) + (synopsis "view and edit package definitions") + (define (parse-arguments) ;; Return the list of package names. (args-fold* args %options diff --git a/guix/scripts/environment.scm b/guix/scripts/environment.scm index 1fb3505307..ad50281eb2 100644 --- a/guix/scripts/environment.scm +++ b/guix/scripts/environment.scm @@ -678,7 +678,10 @@ message if any test fails." ;;; Entry point. ;;; -(define (guix-environment . args) +(define-command (guix-environment . args) + (category development) + (synopsis "spawn one-off software environments") + (with-error-handling (let* ((opts (parse-args args)) (pure? (assoc-ref opts 'pure)) diff --git a/guix/scripts/gc.scm b/guix/scripts/gc.scm index ab7c13315f..043273f491 100644 --- a/guix/scripts/gc.scm +++ b/guix/scripts/gc.scm @@ -220,7 +220,9 @@ is deprecated; use '-D'~%")) ;;; Entry point. ;;; -(define (guix-gc . args) +(define-command (guix-gc . args) + (synopsis "invoke the garbage collector") + (define (parse-options) ;; Return the alist of option values. (parse-command-line args %options (list %default-options) diff --git a/guix/scripts/git.scm b/guix/scripts/git.scm index bc829cbe99..4436d8a6e0 100644 --- a/guix/scripts/git.scm +++ b/guix/scripts/git.scm @@ -19,6 +19,7 @@ (define-module (guix scripts git) #:use-module (ice-9 match) #:use-module (guix ui) + #:use-module (guix scripts) #:export (guix-git)) (define (show-help) @@ -45,7 +46,10 @@ Operate on Git repositories.\n")) (proc (string->symbol (string-append "guix-git-" name)))) (module-ref module proc))) -(define (guix-git . args) +(define-command (guix-git . args) + (category plumbing) + (synopsis "operate on Git repositories") + (with-error-handling (match args (() diff --git a/guix/scripts/graph.scm b/guix/scripts/graph.scm index 73d9269de2..d7a08a4fe1 100644 --- a/guix/scripts/graph.scm +++ b/guix/scripts/graph.scm @@ -565,7 +565,10 @@ Emit a representation of the dependency graph of PACKAGE...\n")) ;;; Entry point. ;;; -(define (guix-graph . args) +(define-command (guix-graph . args) + (category packaging) + (synopsis "view and query package dependency graphs") + (with-error-handling (define opts (parse-command-line args %options diff --git a/guix/scripts/hash.scm b/guix/scripts/hash.scm index 9b4f419a24..797b99f053 100644 --- a/guix/scripts/hash.scm +++ b/guix/scripts/hash.scm @@ -116,7 +116,10 @@ and 'base16' ('hex' and 'hexadecimal' can be used as well).\n")) ;;; Entry point. ;;; -(define (guix-hash . args) +(define-command (guix-hash . args) + (category packaging) + (synopsis "compute the cryptographic hash of a file") + (define (parse-options) ;; Return the alist of option values. (parse-command-line args %options (list %default-options) diff --git a/guix/scripts/import.scm b/guix/scripts/import.scm index c6cc93fad8..0a3863f965 100644 --- a/guix/scripts/import.scm +++ b/guix/scripts/import.scm @@ -1,5 +1,5 @@ ;;; GNU Guix --- Functional package management for GNU -;;; Copyright © 2012, 2013, 2014 Ludovic Courtès <ludo@gnu.org> +;;; Copyright © 2012, 2013, 2014, 2020 Ludovic Courtès <ludo@gnu.org> ;;; Copyright © 2014 David Thompson <davet@gnu.org> ;;; Copyright © 2018 Kyle Meyer <kyle@kyleam.com> ;;; Copyright © 2019 Ricardo Wurmus <rekado@elephly.net> @@ -21,6 +21,7 @@ (define-module (guix scripts import) #:use-module (guix ui) + #:use-module (guix scripts) #:use-module (guix utils) #:use-module (srfi srfi-1) #:use-module (srfi srfi-11) @@ -98,7 +99,10 @@ Run IMPORTER with ARGS.\n")) (newline) (show-bug-report-information)) -(define (guix-import . args) +(define-command (guix-import . args) + (category packaging) + (synopsis "import a package definition from an external repository") + (match args (() (format (current-error-port) diff --git a/guix/scripts/install.scm b/guix/scripts/install.scm index d88e86e77a..894e60f9da 100644 --- a/guix/scripts/install.scm +++ b/guix/scripts/install.scm @@ -1,5 +1,5 @@ ;;; GNU Guix --- Functional package management for GNU -;;; Copyright © 2019 Ludovic Courtès <ludo@gnu.org> +;;; Copyright © 2019, 2020 Ludovic Courtès <ludo@gnu.org> ;;; ;;; This file is part of GNU Guix. ;;; @@ -66,7 +66,9 @@ This is an alias for 'guix package -i'.\n")) %transformation-options %standard-build-options))) -(define (guix-install . args) +(define-command (guix-install . args) + (synopsis "install packages") + (define (handle-argument arg result arg-handler) ;; Treat all non-option arguments as package specs. (values (alist-cons 'install arg result) diff --git a/guix/scripts/lint.scm b/guix/scripts/lint.scm index 5168a1ca17..979d4f8363 100644 --- a/guix/scripts/lint.scm +++ b/guix/scripts/lint.scm @@ -157,7 +157,10 @@ run the checkers on all packages.\n")) ;;; Entry Point ;;; -(define (guix-lint . args) +(define-command (guix-lint . args) + (category packaging) + (synopsis "validate package definitions") + (define (parse-options) ;; Return the alist of option values. (parse-command-line args %options (list %default-options) diff --git a/guix/scripts/offload.scm b/guix/scripts/offload.scm index 1e0e9d7905..3dc8ccefcb 100644 --- a/guix/scripts/offload.scm +++ b/guix/scripts/offload.scm @@ -39,6 +39,7 @@ #:select (fcntl-flock set-thread-name)) #:use-module ((guix build utils) #:select (which mkdir-p)) #:use-module (guix ui) + #:use-module (guix scripts) #:use-module (guix diagnostics) #:use-module (srfi srfi-1) #:use-module (srfi srfi-11) @@ -725,7 +726,10 @@ machine." ;;; Entry point. ;;; -(define (guix-offload . args) +(define-command (guix-offload . args) + (category plumbing) + (synopsis "set up and operate build offloading") + (define request-line-rx ;; The request format. See 'tryBuildHook' method in build.cc. (make-regexp "([01]) ([a-z0-9_-]+) (/[[:graph:]]+.drv) ([[:graph:]]*)")) diff --git a/guix/scripts/pack.scm b/guix/scripts/pack.scm index 9d6881fdaf..379e6a3ac6 100644 --- a/guix/scripts/pack.scm +++ b/guix/scripts/pack.scm @@ -1089,7 +1089,10 @@ Create a bundle of PACKAGE.\n")) ;;; Entry point. ;;; -(define (guix-pack . args) +(define-command (guix-pack . args) + (category development) + (synopsis "create application bundles") + (define opts (parse-command-line args %options (list %default-options))) diff --git a/guix/scripts/package.scm b/guix/scripts/package.scm index ac8dedb5f3..4eb968a49b 100644 --- a/guix/scripts/package.scm +++ b/guix/scripts/package.scm @@ -941,7 +941,9 @@ processed, #f otherwise." ;;; Entry point. ;;; -(define (guix-package . args) +(define-command (guix-package . args) + (synopsis "manage packages and profiles") + (define (handle-argument arg result arg-handler) ;; Process non-option argument ARG by calling back ARG-HANDLER. (if arg-handler diff --git a/guix/scripts/perform-download.scm b/guix/scripts/perform-download.scm index df787a9940..8d409092ba 100644 --- a/guix/scripts/perform-download.scm +++ b/guix/scripts/perform-download.scm @@ -1,5 +1,5 @@ ;;; GNU Guix --- Functional package management for GNU -;;; Copyright © 2016, 2017, 2018 Ludovic Courtès <ludo@gnu.org> +;;; Copyright © 2016, 2017, 2018, 2020 Ludovic Courtès <ludo@gnu.org> ;;; ;;; This file is part of GNU Guix. ;;; @@ -18,6 +18,7 @@ (define-module (guix scripts perform-download) #:use-module (guix ui) + #:use-module (guix scripts) #:use-module (guix derivations) #:use-module ((guix store) #:select (derivation-path? store-path?)) #:use-module (guix build download) @@ -91,14 +92,15 @@ actual output is different from that when we're doing a 'bmCheck' or (leave (G_ "refusing to run with elevated privileges (UID ~a)~%") (getuid)))) -(define (guix-perform-download . args) - "Perform the download described by the given fixed-output derivation. +(define-command (guix-perform-download . args) + (category internal) + (synopsis "perform download described by fixed-output derivations") -This is an \"out-of-band\" download in that this code is executed directly by -the daemon and not explicitly described as an input of the derivation. This -allows us to sidestep bootstrapping problems, such downloading the source code -of GnuTLS over HTTPS, before we have built GnuTLS. See -<http://bugs.gnu.org/22774>." + ;; This is an "out-of-band" download in that this code is executed directly + ;; by the daemon and not explicitly described as an input of the derivation. + ;; This allows us to sidestep bootstrapping problems, such as downloading + ;; the source code of GnuTLS over HTTPS before we have built GnuTLS. See + ;; <https://bugs.gnu.org/22774>. (define print-build-trace? (match (getenv "_NIX_OPTIONS") diff --git a/guix/scripts/processes.scm b/guix/scripts/processes.scm index 35698a0216..b4ca7b1687 100644 --- a/guix/scripts/processes.scm +++ b/guix/scripts/processes.scm @@ -223,7 +223,9 @@ List the current Guix sessions and their processes.")) ;;; Entry point. ;;; -(define (guix-processes . args) +(define-command (guix-processes . args) + (category plumbing) + (synopsis "list currently running sessions") (define options (args-fold* args %options (lambda (opt name arg result) diff --git a/guix/scripts/publish.scm b/guix/scripts/publish.scm index 61542f83a0..4eaf961ab2 100644 --- a/guix/scripts/publish.scm +++ b/guix/scripts/publish.scm @@ -1013,7 +1013,10 @@ methods, return the applicable compression." ;;; Entry point. ;;; -(define (guix-publish . args) +(define-command (guix-publish . args) + (category packaging) + (synopsis "publish build results over HTTP") + (with-error-handling (let* ((opts (args-fold* args %options (lambda (opt name arg result) diff --git a/guix/scripts/pull.scm b/guix/scripts/pull.scm index 3b980b8f3f..bb1b560a22 100644 --- a/guix/scripts/pull.scm +++ b/guix/scripts/pull.scm @@ -751,7 +751,9 @@ Use '~/.config/guix/channels.scm' instead.")) channels))) \f -(define (guix-pull . args) +(define-command (guix-pull . args) + (synopsis "pull the latest revision of Guix") + (with-error-handling (with-git-error-handling (let* ((opts (parse-command-line args %options diff --git a/guix/scripts/refresh.scm b/guix/scripts/refresh.scm index efada1df5a..4a71df28d1 100644 --- a/guix/scripts/refresh.scm +++ b/guix/scripts/refresh.scm @@ -1,5 +1,5 @@ ;;; GNU Guix --- Functional package management for GNU -;;; Copyright © 2013, 2014, 2015, 2016, 2017, 2018, 2019 Ludovic Courtès <ludo@gnu.org> +;;; Copyright © 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Ludovic Courtès <ludo@gnu.org> ;;; Copyright © 2013 Nikita Karetnikov <nikita@karetnikov.org> ;;; Copyright © 2014 Eric Bavier <bavier@member.fsf.org> ;;; Copyright © 2015 Alex Kost <alezost@gmail.com> @@ -496,7 +496,10 @@ all are dependent packages: ~{~a~^ ~}~%") ;;; Entry point. ;;; -(define (guix-refresh . args) +(define-command (guix-refresh . args) + (category packaging) + (synopsis "update existing package definitions") + (define (parse-options) ;; Return the alist of option values. (parse-command-line args %options (list %default-options) diff --git a/guix/scripts/remove.scm b/guix/scripts/remove.scm index 2f06ea4f37..a46ad04d56 100644 --- a/guix/scripts/remove.scm +++ b/guix/scripts/remove.scm @@ -1,5 +1,5 @@ ;;; GNU Guix --- Functional package management for GNU -;;; Copyright © 2019 Ludovic Courtès <ludo@gnu.org> +;;; Copyright © 2019, 2020 Ludovic Courtès <ludo@gnu.org> ;;; ;;; This file is part of GNU Guix. ;;; @@ -63,7 +63,9 @@ This is an alias for 'guix package -r'.\n")) %standard-build-options))) -(define (guix-remove . args) +(define-command (guix-remove . args) + (synopsis "remove installed packages") + (define (handle-argument arg result arg-handler) ;; Treat all non-option arguments as package specs. (values (alist-cons 'remove arg result) diff --git a/guix/scripts/repl.scm b/guix/scripts/repl.scm index 0ea9c3655c..3c79e89f8d 100644 --- a/guix/scripts/repl.scm +++ b/guix/scripts/repl.scm @@ -137,7 +137,10 @@ call THUNK." (loop))))))) \f -(define (guix-repl . args) +(define-command (guix-repl . args) + (category plumbing) + (synopsis "read-eval-print loop (REPL) for interactive programming") + (define opts (args-fold* args %options (lambda (opt name arg result) diff --git a/guix/scripts/search.scm b/guix/scripts/search.scm index 827b2eb7a9..0c9e6af07b 100644 --- a/guix/scripts/search.scm +++ b/guix/scripts/search.scm @@ -1,5 +1,5 @@ ;;; GNU Guix --- Functional package management for GNU -;;; Copyright © 2019 Ludovic Courtès <ludo@gnu.org> +;;; Copyright © 2019, 2020 Ludovic Courtès <ludo@gnu.org> ;;; ;;; This file is part of GNU Guix. ;;; @@ -57,7 +57,9 @@ This is an alias for 'guix package -s'.\n")) (member "load-path" (option-names option))) %standard-build-options))) -(define (guix-search . args) +(define-command (guix-search . args) + (synopsis "search for packages") + (define (handle-argument arg result) ;; Treat all non-option arguments as regexps. (cons `(query search ,(or arg "")) diff --git a/guix/scripts/show.scm b/guix/scripts/show.scm index a2b0030a63..535d03c1a6 100644 --- a/guix/scripts/show.scm +++ b/guix/scripts/show.scm @@ -57,7 +57,9 @@ This is an alias for 'guix package --show='.\n")) (member "load-path" (option-names option))) %standard-build-options))) -(define (guix-show . args) +(define-command (guix-show . args) + (synopsis "show information about packages") + (define (handle-argument arg result) ;; Treat all non-option arguments as regexps. (cons `(query show ,arg) diff --git a/guix/scripts/size.scm b/guix/scripts/size.scm index c42f4f7782..e46983382a 100644 --- a/guix/scripts/size.scm +++ b/guix/scripts/size.scm @@ -1,5 +1,5 @@ ;;; GNU Guix --- Functional package management for GNU -;;; Copyright © 2015, 2016, 2017, 2018, 2019 Ludovic Courtès <ludo@gnu.org> +;;; Copyright © 2015, 2016, 2017, 2018, 2019, 2020 Ludovic Courtès <ludo@gnu.org> ;;; Copyright © 2019 Simon Tournier <zimon.toutoune@gmail.com> ;;; ;;; This file is part of GNU Guix. @@ -298,7 +298,10 @@ Report the size of the PACKAGE or STORE-ITEM, with its dependencies.\n")) ;;; Entry point. ;;; -(define (guix-size . args) +(define-command (guix-size . args) + (category packaging) + (synopsis "profile the on-disk size of packages") + (with-error-handling (let* ((opts (parse-command-line args %options (list %default-options) #:build-options? #f)) diff --git a/guix/scripts/substitute.scm b/guix/scripts/substitute.scm index f9d19fd735..1462ce9918 100755 --- a/guix/scripts/substitute.scm +++ b/guix/scripts/substitute.scm @@ -20,6 +20,7 @@ (define-module (guix scripts substitute) #:use-module (guix ui) + #:use-module (guix scripts) #:use-module (guix store) #:use-module (guix utils) #:use-module (guix combinators) @@ -1095,8 +1096,10 @@ default value." (unless (string->uri uri) (leave (G_ "~a: invalid URI~%") uri))) -(define (guix-substitute . args) - "Implement the build daemon's substituter protocol." +(define-command (guix-substitute . args) + (category internal) + (synopsis "implement the build daemon's substituter protocol") + (define print-build-trace? (match (or (find-daemon-option "untrusted-print-extended-build-trace") (find-daemon-option "print-extended-build-trace")) diff --git a/guix/scripts/system.scm b/guix/scripts/system.scm index 3222a53c8f..2a514166eb 100644 --- a/guix/scripts/system.scm +++ b/guix/scripts/system.scm @@ -1240,7 +1240,9 @@ argument list and OPTS is the option alist." ;; need an operating system configuration file. (else (process-action command args opts)))) -(define (guix-system . args) +(define-command (guix-system . args) + (synopsis "build and deploy full operating systems") + (define (parse-sub-command arg result) ;; Parse sub-command ARG and augment RESULT accordingly. (if (assoc-ref result 'action) diff --git a/guix/scripts/time-machine.scm b/guix/scripts/time-machine.scm index 441673b780..0d27414702 100644 --- a/guix/scripts/time-machine.scm +++ b/guix/scripts/time-machine.scm @@ -128,7 +128,9 @@ Execute COMMAND ARGS... in an older version of Guix.\n")) ;;; Entry point. ;;; -(define (guix-time-machine . args) +(define-command (guix-time-machine . args) + (synopsis "run commands from a different revision") + (with-error-handling (with-git-error-handling (let* ((opts (parse-args args)) diff --git a/guix/scripts/upgrade.scm b/guix/scripts/upgrade.scm index d2784669be..8c7abd133a 100644 --- a/guix/scripts/upgrade.scm +++ b/guix/scripts/upgrade.scm @@ -1,5 +1,5 @@ ;;; GNU Guix --- Functional package management for GNU -;;; Copyright © 2019 Ludovic Courtès <ludo@gnu.org> +;;; Copyright © 2019, 2020 Ludovic Courtès <ludo@gnu.org> ;;; Copyright © 2020 Jakub Kądziołka <kuba@kadziolka.net> ;;; ;;; This file is part of GNU Guix. @@ -67,7 +67,9 @@ This is an alias for 'guix package -u'.\n")) %transformation-options %standard-build-options))) -(define (guix-upgrade . args) +(define-command (guix-upgrade . args) + (synopsis "upgrade packages to their latest version") + (define (handle-argument arg result arg-handler) ;; Accept at most one non-option argument, and treat it as an upgrade ;; regexp. diff --git a/guix/scripts/weather.scm b/guix/scripts/weather.scm index 3035ff6ca8..6a2582c997 100644 --- a/guix/scripts/weather.scm +++ b/guix/scripts/weather.scm @@ -495,7 +495,9 @@ SERVER. Display information for packages with at least THRESHOLD dependents." ;;; Entry point. ;;; -(define (guix-weather . args) +(define-command (guix-weather . args) + (synopsis "report on the availability of pre-built package binaries") + (define (package-list opts) ;; Return the package list specified by OPTS. (let ((files (filter-map (match-lambda diff --git a/guix/ui.scm b/guix/ui.scm index 981e133aaf..51a61be687 100644 --- a/guix/ui.scm +++ b/guix/ui.scm @@ -60,6 +60,7 @@ ;; Avoid "overrides core binding" warning. delete)) #:use-module (srfi srfi-1) + #:use-module (srfi srfi-9 gnu) #:use-module (srfi srfi-11) #:use-module (srfi srfi-19) #:use-module (srfi srfi-26) @@ -1989,6 +1990,44 @@ optionally contain a version number and an output name, as in these examples: (G_ "Try `guix --help' for more information.~%")) (exit 1)) +;; Representation of a 'guix' command. +(define-immutable-record-type <command> + (command name synopsis category) + command? + (name command-name) + (synopsis command-synopsis) + (category command-category)) + +(define (source-file-command file) + "Read FILE, a Scheme source file, and return either a <command> object based +on the 'define-command' top-level form found therein, or #f if FILE does not +contain a 'define-command' form." + (define command-name + (match (string-split file #\/) + ((_ ... "guix" "scripts" name) + (list (file-sans-extension name))) + ((_ ... "guix" "scripts" first second) + (list first (file-sans-extension second))))) + + ;; The strategy here is to parse FILE. This is much cheaper than a + ;; technique based on run-time introspection where we'd load FILE and all + ;; the modules it depends on. + (call-with-input-file file + (lambda (port) + (let loop () + (match (read port) + (('define-command _ ('synopsis synopsis) + _ ...) + (command command-name synopsis 'main)) + (('define-command _ + ('category category) ('synopsis synopsis) + _ ...) + (command command-name synopsis category)) + ((? eof-object?) + #f) + (_ + (loop))))))) + (define (command-files) "Return the list of source files that define Guix sub-commands." (define directory @@ -2000,28 +2039,51 @@ optionally contain a version number and an output name, as in these examples: (cut string-suffix? ".scm" <>)) (if directory - (scandir directory dot-scm?) + (map (cut string-append directory "/" <>) + (scandir directory dot-scm?)) '())) (define (commands) - "Return the list of Guix command names." - (map (compose (cut string-drop-right <> 4) - basename) - (command-files))) + "Return the list of commands, alphabetically sorted." + (filter-map source-file-command (command-files))) (define (show-guix-help) (define (internal? command) (member command '("substitute" "authenticate" "offload" "perform-download"))) + (define (display-commands commands) + (let* ((names (map (lambda (command) + (string-join (command-name command))) + commands)) + (max-width (reduce max 0 (map string-length names)))) + (for-each (lambda (name command) + (format #t " ~a ~a~%" + (string-pad-right name max-width) + (G_ (command-synopsis command)))) + names + commands))) + + (define (category-predicate category) + (lambda (command) + (eq? category (command-category command)))) + (format #t (G_ "Usage: guix COMMAND ARGS... Run COMMAND with ARGS.\n")) (newline) (format #t (G_ "COMMAND must be one of the sub-commands listed below:\n")) - (newline) - ;; TODO: Display a synopsis of each command. - (format #t "~{ ~a~%~}" (sort (remove internal? (commands)) - string<?)) + + (let ((commands (commands)) + (categories (module-ref (resolve-interface '(guix scripts)) + '%command-categories))) + (for-each (match-lambda + (('internal . _) + #t) ;hide internal commands + ((category . synopsis) + (format #t "~% ~a~%" (G_ synopsis)) + (display-commands (filter (category-predicate category) + commands)))) + categories)) (show-bug-report-information)) (define (run-guix-command command . args) -- 2.28.0 [-- Warning: decoded text below may be mangled, UTF-8 assumed --] [-- Attachment #3: 0001-ui-help-output-links-to-https-guix.gnu.org-help.patch --] [-- Type: text/x-patch, Size: 1102 bytes --] From b3494f3cd670e0d1e5842b9b022c2606a520d34a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ludovic=20Court=C3=A8s?= <ludo@gnu.org> Date: Tue, 1 Sep 2020 22:23:50 +0200 Subject: [PATCH 1/2] ui: '--help' output links to <https://guix.gnu.org/help/>. * guix/ui.scm (show-bug-report-information): Link to <https://guix.gnu.org/help/> instead of <https://www.gnu.org/gethelp/>. The former is much more useful and includes links to GNU manuals. --- guix/ui.scm | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/guix/ui.scm b/guix/ui.scm index efc3f39186..981e133aaf 100644 --- a/guix/ui.scm +++ b/guix/ui.scm @@ -541,8 +541,9 @@ There is NO WARRANTY, to the extent permitted by law. Report bugs to: ~a.") %guix-bug-report-address) (format #t (G_ " ~a home page: <~a>") %guix-package-name %guix-home-page-url) - (display (G_ " -General help using GNU software: <http://www.gnu.org/gethelp/>")) + (format #t (G_ " +General help using Guix and GNU software: <~a>") + "https://guix.gnu.org/help/") (newline)) (define (augmented-system-error-handler file) -- 2.28.0 ^ permalink raw reply related [flat|nested] 17+ messages in thread
* bug#43159: [PATCHES v2] scripts: Use 'define-command' and have 'guix help' use that. 2020-09-07 12:56 ` [bug#43159] [PATCHES v2] " Ludovic Courtès @ 2020-09-10 10:34 ` Ludovic Courtès 2020-09-10 10:55 ` [bug#43159] " Ricardo Wurmus 0 siblings, 1 reply; 17+ messages in thread From: Ludovic Courtès @ 2020-09-10 10:34 UTC (permalink / raw) To: Maxim Cournoyer; +Cc: 43159-done, Efraim Flashner, zimoun Ludovic Courtès <ludo@gnu.org> skribis: > Here’s a v2 of the patches, where I tried to take your feedback into > account. Changes: > > • Categories that appear in uses of ‘define-command’ are now validated > at macro-expansion time. > > • (guix scripts) contains an alist of the known categories and > ‘show-help’ traverses it. > > • Changed the label for development commands to “commands for > development”, and changed “advanced” to “plumbing”. > > • Added a “packaging” category. > > • Fixed the typos you reported. I pushed this v2 as 3794ce93be8216d8378df7b808ce7f53b1e05a53. Let’s iterate from here if people have ideas about better categorization or things like that. Thanks, Ludo’. ^ permalink raw reply [flat|nested] 17+ messages in thread
* [bug#43159] [PATCHES v2] scripts: Use 'define-command' and have 'guix help' use that. 2020-09-10 10:34 ` bug#43159: " Ludovic Courtès @ 2020-09-10 10:55 ` Ricardo Wurmus 0 siblings, 0 replies; 17+ messages in thread From: Ricardo Wurmus @ 2020-09-10 10:55 UTC (permalink / raw) To: Ludovic Courtès Cc: 43159, zimon.toutoune, efraim, maxim.cournoyer, 43159-done I’m a bit late, but I’m very happy to see that “for developers” has become “for development”! Ludovic Courtès <ludo@gnu.org> writes: > Ludovic Courtès <ludo@gnu.org> skribis: > >> Here’s a v2 of the patches, where I tried to take your feedback into >> account. Changes: >> >> • Categories that appear in uses of ‘define-command’ are now validated >> at macro-expansion time. Neat! >> • (guix scripts) contains an alist of the known categories and >> ‘show-help’ traverses it. Knowing that guile-config exists for automatically generating help screens, configuration files, command line options, and all that I wonder if there’s anything here that could become part of guile-config and move out of Guix. I had been in that situation myself where I felt that guile-config may not be a great fit for my help texts because of minor quibbles about the format or the way things are presented by default. In the end I decided to use guile-config, because I prefer to have this handled by someone else who keeps thinking about the problems relating to argument parsing, configuration files, and help texts. It may not be a great fit for Guix now, but I wonder if it could. In the long run I think it would be good for Guix to become a little less special — no matter if that’s monad macros, records, argparsing, or configuration files. This is not a recommendation either way. I just wonder if in the long term we could benefit from moving all this to a separate package. >> • Changed the label for development commands to “commands for >> development”, and changed “advanced” to “plumbing”. >> >> • Added a “packaging” category. >> >> • Fixed the typos you reported. > > I pushed this v2 as 3794ce93be8216d8378df7b808ce7f53b1e05a53. Excellent! Thank you! -- Ricardo ^ permalink raw reply [flat|nested] 17+ messages in thread
* [bug#43159] [PATCH 0/2] Make 'guix help' helpful 2020-09-01 20:35 [bug#43159] [PATCH 0/2] Make 'guix help' helpful Ludovic Courtès 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-02 8:06 ` Efraim Flashner 2020-09-02 9:50 ` Ludovic Courtès 2020-09-03 16:40 ` zimoun 2 siblings, 1 reply; 17+ messages in thread From: Efraim Flashner @ 2020-09-02 8:06 UTC (permalink / raw) To: Ludovic Courtès; +Cc: 43159 [-- Attachment #1: Type: text/plain, Size: 6249 bytes --] On Tue, Sep 01, 2020 at 10:35:20PM +0200, Ludovic Courtès wrote: > 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?): > I dislike the idea that some commands are only for developers and some commands are "too advanced for the common user" (my words, not yours). Before bikeshedding about where the options should be, how about: commands for developers -> commands related to building advanced usage -> commands related to verification This way they're still "commands for everybody" and they're more descriptive than just "advanced" "expert" and "debug" style headers. > --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 > > > > -- Efraim Flashner <efraim@flashner.co.il> אפרים פלשנר GPG key = A28B F40C 3E55 1372 662D 14F7 41AA E7DC CA3D 8351 Confidentiality cannot be guaranteed on emails sent or received unencrypted [-- Attachment #2: signature.asc --] [-- Type: application/pgp-signature, Size: 833 bytes --] ^ permalink raw reply [flat|nested] 17+ messages in thread
* [bug#43159] [PATCH 0/2] Make 'guix help' helpful 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 0 siblings, 1 reply; 17+ messages in thread From: Ludovic Courtès @ 2020-09-02 9:50 UTC (permalink / raw) To: Efraim Flashner; +Cc: 43159 Hi, Efraim Flashner <efraim@flashner.co.il> skribis: > On Tue, Sep 01, 2020 at 10:35:20PM +0200, Ludovic Courtès wrote: >> 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?): >> > > I dislike the idea that some commands are only for developers and some > commands are "too advanced for the common user" (my words, not yours). Yeah, I’m ambivalent about this as well. > Before bikeshedding about where the options should be, how about: > commands for developers -> commands related to building Rather, “commands for development“, because that’s really what ‘guix environment’ is about, for instance, but saying ‘development’ rather than ‘developers’ is probably wise. > advanced usage -> commands related to verification Well that only works for ‘challenge’ (which I’d like to put in the hands of ‘normal’ users, so I’m not comfortable with the ‘advanced’ label, but OTOH, it’s clearly not one of the commands you’d begin with.) What about archive, copy, download, etc.? > This way they're still "commands for everybody" and they're more > descriptive than just "advanced" "expert" and "debug" style headers. Understood. Thanks for your feedback! Ludo’. ^ permalink raw reply [flat|nested] 17+ messages in thread
* [bug#43159] [PATCH 0/2] Make 'guix help' helpful 2020-09-02 9:50 ` Ludovic Courtès @ 2020-09-02 11:09 ` Efraim Flashner 0 siblings, 0 replies; 17+ messages in thread From: Efraim Flashner @ 2020-09-02 11:09 UTC (permalink / raw) To: Ludovic Courtès; +Cc: 43159 [-- Attachment #1: Type: text/plain, Size: 2207 bytes --] On Wed, Sep 02, 2020 at 11:50:17AM +0200, Ludovic Courtès wrote: > Hi, > > Efraim Flashner <efraim@flashner.co.il> skribis: > > > On Tue, Sep 01, 2020 at 10:35:20PM +0200, Ludovic Courtès wrote: > >> 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?): > >> > > > > I dislike the idea that some commands are only for developers and some > > commands are "too advanced for the common user" (my words, not yours). > > Yeah, I’m ambivalent about this as well. > > > Before bikeshedding about where the options should be, how about: > > commands for developers -> commands related to building > > Rather, “commands for development“, because that’s really what ‘guix > environment’ is about, for instance, but saying ‘development’ rather > than ‘developers’ is probably wise. > > > advanced usage -> commands related to verification > > Well that only works for ‘challenge’ (which I’d like to put in the hands > of ‘normal’ users, so I’m not comfortable with the ‘advanced’ label, but > OTOH, it’s clearly not one of the commands you’d begin with.) > > What about archive, copy, download, etc.? > It seemed loosely related. If you're running 'guix pull; guix upgrade' you're not first running 'guix download https://path/to/source.tar.xz' or copying packages between machines or challenging the reproducibility of the packages. That's for after you have the packages you want in your profile or environment. > > This way they're still "commands for everybody" and they're more > > descriptive than just "advanced" "expert" and "debug" style headers. > > Understood. > > Thanks for your feedback! > > Ludo’. -- Efraim Flashner <efraim@flashner.co.il> אפרים פלשנר GPG key = A28B F40C 3E55 1372 662D 14F7 41AA E7DC CA3D 8351 Confidentiality cannot be guaranteed on emails sent or received unencrypted [-- Attachment #2: signature.asc --] [-- Type: application/pgp-signature, Size: 833 bytes --] ^ permalink raw reply [flat|nested] 17+ messages in thread
* [bug#43159] [PATCH 0/2] Make 'guix help' helpful 2020-09-01 20:35 [bug#43159] [PATCH 0/2] Make 'guix help' helpful Ludovic Courtès 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-02 8:06 ` [bug#43159] [PATCH 0/2] Make 'guix help' helpful Efraim Flashner @ 2020-09-03 16:40 ` zimoun 2020-09-07 12:58 ` Ludovic Courtès 2 siblings, 1 reply; 17+ messages in thread From: zimoun @ 2020-09-03 16:40 UTC (permalink / raw) To: Ludovic Courtès; +Cc: 43159 Hi Ludo, On Tue, 1 Sep 2020 at 22:36, Ludovic Courtès <ludo@gnu.org> wrote: > remove removed installed packages s/removed/remove > environment spawn one-off software environments spawn one-off? > PS: We can talk about categories, but make sure to turn on the > bikeshedding limitation mode of your mail client. :-) Looking for "bikeshedder"? ;-) Category theory is always complicated. :-) It depends what do you mean by developers (or development)? To me, download, hash, lint, repl and size are also commands used on a daily basis for developing. On the other hand, container is claimed to be "experimental" in the manual so it should go in the "advanced" section. Well, instead of "advanced usage", I propose "plumbing commands" Thank you for this change. Cheers, simon ^ permalink raw reply [flat|nested] 17+ messages in thread
* [bug#43159] [PATCH 0/2] Make 'guix help' helpful 2020-09-03 16:40 ` zimoun @ 2020-09-07 12:58 ` Ludovic Courtès 0 siblings, 0 replies; 17+ messages in thread From: Ludovic Courtès @ 2020-09-07 12:58 UTC (permalink / raw) To: zimoun; +Cc: 43159 Hi, zimoun <zimon.toutoune@gmail.com> skribis: >> environment spawn one-off software environments > > spawn one-off? “One-off” is used as an adjective to mean a software environment that is used once and then thrown away. Per WordNet: --8<---------------cut here---------------start------------->8--- Overview of noun one-off The noun one-off has 1 sense (no senses from tagged texts) 1. one-off -- (a happening that occurs only once and is not repeated) --8<---------------cut here---------------end--------------->8--- Thanks for your suggestions! Ludo’. ^ permalink raw reply [flat|nested] 17+ messages in thread
end of thread, other threads:[~2020-09-13 23:33 UTC | newest] Thread overview: 17+ messages (download: mbox.gz follow: Atom feed -- links below jump to the message on this page -- 2020-09-01 20:35 [bug#43159] [PATCH 0/2] Make 'guix help' helpful Ludovic Courtès 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
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).