Multiple usages #652
Merged
Multiple usages #652
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sometimes, for mutually exclusive arguments, it is better to specify each of the command line versions on its own line. This is explained in https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap12.html, bullet point 8, and it's a technique used by many CLI utils. For example, the following is the beginning of the man's man page: ``` NAME man - an interface to the on-line reference manuals SYNOPSIS man [-C file] [-d] [-D] [--warnings[=warnings]] [-R encoding] [-L locale] [-m system[,...]] [-M path] [-S list] [-e extension] [-i|-I] [--regex|--wildcard] [--names-only] [-a] [-u] [--no-subpages] [-P pager] [-r prompt] [-7] [-E encoding] [--no-hyphenation] [--no-justification] [-p string] [-t] [-T[device]] [-H[browser]] [-X[dpi]] [-Z] [[section] page[.section] ...] ... man -k [apropos options] regexp ... man -K [-w|-W] [-S list] [-i|-I] [--regex] [section] term ... man -f [whatis options] page ... man -l [-C file] [-d] [-D] [--warnings[=warnings]] [-R encoding] [-L locale] [-P pager] [-r prompt] [-7] [-E encoding] [-p string] [-t] [-T[device]] [-H[browser]] [-X[dpi]] [-Z] file ... man -w|-W [-C file] [-d] [-D] page ... man -c [-C file] [-d] [-D] page ... man [-?V] ``` This commit implements support for that, by passing an array of "usages" instead of a single one.
|
Thoughts about this? |
|
Friendly ping :) |
|
I'm getting ready in bundler for an eventual thor release, and I see that this PR seems to have caused some issues. I'll investigate those and provide a follow-up as soon as possible 👍. |
|
Actually, nevermind, it's #679 causing problems. I'll investigate. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
On bundler, we have some commands with quite complicated synopsis. For example,
bundle update, which has different valid combinations of arguments and command line flags, pretty hard to express on a single usage line without making it look like an understandable mess.Instead, I would like to be able to specify multiple synopsis, so that
thorwould give a error of the following type when an invalid command line is specified:In general, this is useful for mutually exclusive combinations of flags and arguments.
This is explained in https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap12.html, bullet point 8, and it's a technique used by many CLI utils.
For example, the following is the beginning of the man's man page:
This commit implements support for this kind of synopsis, by allowing passing an array of "usages" instead of a single one.