You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@solr.apache.org by "Eric Pugh (Jira)" <ji...@apache.org> on 2024/10/07 10:35:00 UTC
[jira] [Commented] (SOLR-17383) CLI: Resolve overlapping arguments
[ https://issues.apache.org/jira/browse/SOLR-17383?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17887313#comment-17887313 ]
Eric Pugh commented on SOLR-17383:
----------------------------------
We are closing in on getting this done!
> CLI: Resolve overlapping arguments
> ----------------------------------
>
> Key: SOLR-17383
> URL: https://issues.apache.org/jira/browse/SOLR-17383
> Project: Solr
> Issue Type: Improvement
> Reporter: Christos Malliaridis
> Priority: Major
>
> With the changes from SOLR-16757 arguments were moved to java source code to simplify and merge shell script logic. We noticed many overlappings in arguments' short and long forms that cause confusion and possible unexpected results.
> Since commands are executed with "bin/solr", the user has a hard time learning the short form of each argument and the long form of the same argument may vary too, because it is often context-specific.
> See [Solr Arguments - Migration Overview|https://docs.google.com/spreadsheets/d/1ws44kN51WnGwQzOXc8KKRQ93TMgHSqIGb02MRWFel_U/edit?usp=sharing] for more details about conflicting arguments.
>
> Noticable confusions for beginners may be:
> *
> {code:java}
> bin/solr start -c -e techproducts # "creates" and starts a solr cloud instance with example data, -c does not receive an argument
> bin/solr create -c mycollection # "creates" a new collection in an existing solr, -c requires a value{code}
> *
> {code:java}
> bin/solr create -c mycollection # succeeds
> bin/solr create --collection mycollection (fails?)
> bin/solr create --name mycollection (succeeds){code}
> *
> {code:java}
> bin/solr config -c ... --action set-user-property --property update.autoCreateFields -v false # Does this set property to false or execute command in verbose mode, or both{code}
> We should consider for which arguments it is fine to have overlapping short forms, which arguments can be unified and use same short and long-form to improve learnability and which arguments should maybe not have a short form or should use different wording to use different abbreviations.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org