[ 
https://issues.apache.org/jira/browse/SOLR-17423?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17877324#comment-17877324
 ] 

Eric Pugh commented on SOLR-17423:
----------------------------------

I poked around RunExampleTool and bin/solr invocation of it and learned two 
things:

 

1) The fact that SolrCLI just blindly force adds the --help option means that 
commands that don't need it, like RunExampleTool, end up getting it.  

2) Interesting you never actually see the existence of the "run_example" / 
RunExampleTool when you do bin/solr --help.  run_example is basically a special 
case tool that is used by the bin/solr start -e MYEXAMPLE flag!

3) Because of 3, as long as we don't change the bin/solr start experience we 
can do what we want to RunExampleTool.  So saying --hostname option doesnt have 
a short cut is just fine!

> CLI: Resolve -h argument conflict (help/host)
> ---------------------------------------------
>
>                 Key: SOLR-17423
>                 URL: https://issues.apache.org/jira/browse/SOLR-17423
>             Project: Solr
>          Issue Type: Sub-task
>      Security Level: Public(Default Security Level. Issues are Public) 
>          Components: cli, examples
>    Affects Versions: main (10.0), 9.7
>            Reporter: Christos Malliaridis
>            Priority: Major
>              Labels: cli
>
> At the moment RunExampleTool uses -h for providing the hostname. -h is 
> commonly known for printing the help / usage. To avoid any confusion for 
> beginners and improve the learnability of the CLI, we should deprecate -h in 
> RunExampleTool for future 9.X releases and remove it in 10.0 (two PRs 
> expected). -h should only be used for printing the help information.
> Note that -h is used via Option.builder("h") and in a raw string as "-h" 
> inside RunExampleTool, and deprecation would require both to be updated. 
> Please review for any documentation references as well.
> Once the conflict is resolved, the tracking table in [Solr Arguments - 
> Migration 
> Overview|https://docs.google.com/spreadsheets/d/1ws44kN51WnGwQzOXc8KKRQ93TMgHSqIGb02MRWFel_U/edit?usp=sharing]
>  can be updated.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@solr.apache.org
For additional commands, e-mail: issues-h...@solr.apache.org

Reply via email to