]> _ Git - alire.git/commit
Rename switch arguments to indicate expected type (#1650)
authorFrancesc Rocher <rocher@users.noreply.github.com>
Mon, 18 Mar 2024 17:59:49 +0000 (18:59 +0100)
committerGitHub <noreply@github.com>
Mon, 18 Mar 2024 17:59:49 +0000 (18:59 +0100)
commit8aaefabc5777ce6ebeba8adec761cbc40a171de8
treecd733ab26efe06dddf64416d5bd729e519feea5b
parent2b663e87bdc3d4ba808149bad97bac5c60889b6b
Rename switch arguments to indicate expected type (#1650)

In commands with options that admit arguments, like '--prefix' in
'alr install', is useful to provide an argument name in the command
help that gives a hint of the expected type.

For example, 'alr install -h' shows the message:
====
OPTIONS
   --prefix=ARG   Override installation prefix (default is ...)
====

When changed to:
====
OPTIONS
   --prefix=DIR   Override installation prefix (default is ...)
====

the 'DIR' name of the argument immediately says what is expected in this
option. In cases where this is not so obvious, it helps even more.
For example, in 'alr build -h':
====
OPTIONS
   --profiles=LIST     Comma-separated list of <crate>=<profile> values (see description)
   --stop-after=STAGE  Build stage after which to stop (see description)
====

is a quick remainder of what is expected in that options.
src/alr/alr-commands-build.adb
src/alr/alr-commands-edit.adb
src/alr/alr-commands-exec.adb
src/alr/alr-commands-install.adb
src/alr/alr-commands-publish.adb
src/alr/alr-commands-show.adb
src/alr/alr-commands.adb