Skip to content
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

Consistent case in CLI option descriptions #49635

Merged
merged 4 commits into from
Dec 5, 2019
Merged

Consistent case in CLI option descriptions #49635

merged 4 commits into from
Dec 5, 2019

Conversation

orhantoy
Copy link
Contributor

@orhantoy orhantoy commented Nov 27, 2019

I noticed a few inconsistencies in the CLI option descriptions:

$ bin/elasticsearch --help
OpenJDK 64-Bit Server VM warning: Option UseConcMarkSweepGC was deprecated in version 9.0 and will likely be removed in a future release.
starts elasticsearch

Option                Description
------                -----------
-E <KeyValuePair>     Configure a setting
-V, --version         Prints elasticsearch version information and exits
-d, --daemonize       Starts Elasticsearch in the background
-h, --help            show help
-p, --pidfile <Path>  Creates a pid file in the specified path on start
-q, --quiet           Turns off standard output/error streams logging in console
-s, --silent          show minimal output
-v, --verbose         show verbose output
  1. Prints elasticsearch [...] vs Starts Elasticsearch [...]
  2. Starting with lowercase in show help, show minimal output and show verbose output
  3. Also, command description is currently all lowercase: starts elasticsearch

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-core-features (:Core/Features/Features)

@orhantoy
Copy link
Contributor Author

Noticed that the other CLIs like bin/elasticsearch-setup-passwords, bin/elasticsearch-certgen etc also have inconsistencies. Might be worth looking into those as well.

@jakelandis jakelandis added :Core/Infra/Core Core issues without another label and removed :Core/Features/Features labels Dec 5, 2019
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-core-infra (:Core/Infra/Core)

@rjernst
Copy link
Member

rjernst commented Dec 5, 2019

@elasticmachine ok to test

@rjernst
Copy link
Member

rjernst commented Dec 5, 2019

@elasticmachine update branch

@rjernst rjernst merged commit 8b3c599 into elastic:master Dec 5, 2019
@rjernst
Copy link
Member

rjernst commented Dec 5, 2019

Thanks for the contribution @orhantoy.

rjernst pushed a commit that referenced this pull request Dec 5, 2019
This commit improves the casing of messages in the CLI help descriptions.
SivagurunathanV pushed a commit to SivagurunathanV/elasticsearch that referenced this pull request Jan 23, 2020
This commit improves the casing of messages in the CLI help descriptions.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants