Skip to content

Consistent case in CLI option descriptions#49635

Merged
rjernst merged 4 commits intoelastic:masterfrom
orhantoy:cli-consistent-case-in-descriptions
Dec 5, 2019
Merged

Consistent case in CLI option descriptions#49635
rjernst merged 4 commits intoelastic:masterfrom
orhantoy:cli-consistent-case-in-descriptions

Conversation

@orhantoy
Copy link
Copy Markdown
Contributor

@orhantoy orhantoy commented Nov 27, 2019 •
edited
Loading

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
Copy Markdown
Collaborator

elasticmachine commented Nov 28, 2019

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

@orhantoy
Copy link
Copy Markdown
Contributor Author

orhantoy commented Nov 28, 2019

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
Copy Markdown
Collaborator

elasticmachine commented Dec 5, 2019

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

@rjernst
Copy link
Copy Markdown
Member

rjernst commented Dec 5, 2019

@elasticmachine ok to test

@rjernst
Copy link
Copy Markdown
Member

rjernst commented Dec 5, 2019

@elasticmachine update branch

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

rjernst commented Dec 5, 2019

Thanks for the contribution @orhantoy.

rjernst pushed a commit that referenced this pull request Dec 5, 2019
@orhantoy @rjernst
Consistent case in CLI option descriptions (#49635)
0f02e02 
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
@orhantoy @SivagurunathanV
Consistent case in CLI option descriptions (elastic#49635)
65114f7 
This commit improves the casing of messages in the CLI help descriptions.
This was referenced Feb 3, 2020
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

:Core/Infra/Core Core issues without another label >enhancement v7.6.0 v8.0.0-alpha1

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@orhantoy @elasticmachine @rjernst @jakelandis @matriv