[RFC] Add sketch of specifying option groups #486
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
The POSIX Utility argument syntax specifies a single OPTIONS section. If there are options make sense only with some set of operands (commands), then it currently seems to be required to list these for each operand. This example explores the potential of define multiple option groups, which would hopefully help both the command line interface designer and user to specify and select the correct options for each operand. Signed-off-by: Eero Aaltonen <eero.aaltonen@vaisala.com>
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.
This proposal explores the idea of grouping related options to allow the CLI designer to more precisely determine which options make sense with given commands. This is particularly relevant for mid-to-large CLI utilities, such as
rsyncandgit, for example.Commit
The POSIX Utility argument syntax specifies a single OPTIONS section.
If there are options make sense only with some set of operands
(commands), then it currently seems to be required to list these for
each operand.
This example explores the potential of define multiple option groups,
which would hopefully help both the command line interface designer and
user to specify and select the correct options for each operand.
Signed-off-by: Eero Aaltonen eero.aaltonen@vaisala.com
Additional Notes:
This would change the current behavior of
"[options] can be expanded to any options listed in the "Options:" section"
to
"any option group listed in help message can be expanded to the options in that group". Of course the details of what is considered an option group would have to hashed out.