-
Notifications
You must be signed in to change notification settings - Fork 893
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[tools] improve bkctl help message #1793
Merged
Merged
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
*Motivation* Currently `bin/bktcl help` will output all command groups all together. It is a bit hard to tell what command groups to use, especially some commands are used for table service. *Changes* Introduce `category` in the cli spec to define which category that a command group belongs to. So when it prints out the help message, it can use that information to categorize the command groups together to provide better user experience. *Results* ``` $ bin/bkctl help bkctl interacts and operates Apache BookKeeper clusters Usage: bkctl [flags] [command group] [commands] Infrastructure commands : bookie Commands on operating a single bookie bookies Commands on operating a cluster of bookies cluster Commands on administrating bookkeeper clusters Ledger service commands : ledger Commands on interacting with ledgers Table service commands : namespace Commands on operating namespaces table Commands on interacting with tables tables Commands on operating tables Other commands : help Display help information about it ```
merlimat
approved these changes
Nov 7, 2018
eolivelli
approved these changes
Nov 7, 2018
run pr validation |
run bookkeeper-server remaining tests |
run bookkeeper-server replication tests |
sijie
added a commit
that referenced
this pull request
Nov 10, 2018
Descriptions of the changes in this PR: *Motivation* Currently `bin/bktcl help` will output all command groups all together. It is a bit hard to tell what command groups to use, especially some commands are used for table service. *Changes* Introduce `category` in the cli spec to define which category that a command group belongs to. So when it prints out the help message, it can use that information to categorize the command groups together to provide better user experience. *Results* ``` $ bin/bkctl help bkctl interacts and operates Apache BookKeeper clusters Usage: bkctl [flags] [command group] [commands] Infrastructure commands : bookie Commands on operating a single bookie bookies Commands on operating a cluster of bookies cluster Commands on administrating bookkeeper clusters Ledger service commands : ledger Commands on interacting with ledgers Table service commands : namespace Commands on operating namespaces table Commands on interacting with tables tables Commands on operating tables Other commands : help Display help information about it ``` Reviewers: Enrico Olivelli <eolivelli@gmail.com>, Matteo Merli <mmerli@apache.org> This closes #1793 from sijie/add_groups (cherry picked from commit 843c0cc) Signed-off-by: Sijie Guo <sijie@apache.org>
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.
Descriptions of the changes in this PR:
Motivation
Currently
bin/bktcl help
will output all command groups all together.It is a bit hard to tell what command groups to use, especially some
commands are used for table service.
Changes
Introduce
category
in the cli spec to define which category that acommand group belongs to. So when it prints out the help message, it
can use that information to categorize the command groups together
to provide better user experience.
Results