Details
-
Improvement
-
Status: Open
-
Major
-
Resolution: Unresolved
-
None
-
None
-
None
-
None
Description
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 for more details about conflicting arguments.
Noticable confusions for beginners may be:
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
bin/solr create -c mycollection # succeeds bin/solr create --collection mycollection (fails?) bin/solr create --name mycollection (succeeds)
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
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.
Attachments
Issue Links
- is a child of
-
SOLR-16757 Umbrella Ticket for Revamping Solr CLI's for the Future
- Open
- is a parent of
-
SOLR-17384 Update ExportTool's argument representation
- Open
-
SOLR-17382 CLI: Deprecate addlopts in RunExampleTool.java
- Resolved
- relates to
-
SOLR-16757 Umbrella Ticket for Revamping Solr CLI's for the Future
- Open
1.
|
CLI: Resolve -f flag conflicts | Open | Unassigned | |
2.
|
CLI: Resolve -s flag conflicts | Open | Unassigned |