[
https://issues.apache.org/jira/browse/SOLR-16824?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17868970#comment-17868970
]
Christos Malliaridis edited comment on SOLR-16824 at 8/3/24 12:19 AM:
----------------------------------------------------------------------
Notes while working on this issue (moved from Github, new issues may be created
and linked here):
* Between {{{}-noprompt-{}}}, {{-noprompt-}} and {{{}-no-prompt{}}}, which
option will be maintained?
** From the virtual meetup, {{--no-prompt}} is correct
* Is {{-collection}} a valid argument, or is there only the plural form?
(eventual typo)
* We have to clarify the difference between {{-V-}} and {{{}-v{}}}, since the
long form of both is {{-verbose}}
** Should we distinguish between the long forms, or merge them to avoid any
confusion about capitalization?
* There are multiple overlapping short-arguments
** {{{}--value{-}{-}{}}}, {{--verbose}} and {{--version}} all use {{-v}} as
short form
** {{--dir}} and {{--conf-dir}} use both {{{}-d{}}}, are they different?
** {{--solr-url}} (I think) and {{--solr-home}} use both {{-s}} as short form
* The multicharacter command `url` is still used as `{{{}-url{}}}` and
resolves to {{--solr-url}} (probably), {{{}--solr-update-url{}}}, and
{{-solr-colleciton-url}}
** We should consider merging them together if all of them are setting the
same kind of value (the SOLR instance URL the command is executed against)
* {{solr/docker/scripts/docker-entrypoint.sh}} Line 37 to 40 requires
attention (may not work with {{--help}}
* {{solr/bin/instal_solr_service.sh}} - Script may be migrated too to use
double-dashed arguments
* We should consider removing support for {{{}-?{}}}, {{--usage}} and
{{--usage}} and only use {{--help}} and {{-h}}
* In {{bin/solr}} line 249 and follow, {{--version}} is not included. Do we
have to add it too?
* {{bin/solr.cmd}} line 530 and follow contains a list of arguments, but list
seems incomplete. Is this a problem? (e.g. {{--help}} is missing)
** Same applies for lines 1409 and follow and 1648 and follow
* We should unify the arguments passed in java code to either use the long
form or the short form (exception only if the test explicitly tests the short
or long form)
** Example are {{{}TestSolrCLIRunExample.java{}}},
{{{}TestExportTool.java{}}}, {{{}DeleteToolTest.java{}}},
{{CreateToolTest.java}} and {{SolrExporter.java}}
* There are some conditions like {{TestSolrCLIRunExample.java}} line 117 that
may need to be expanded with all / additional argument variants (those are hard
to find)
* SolrExporter.java does not list deprecated single-dash-argument in
{{{}ARG_***_FLAGS{}}}, does this break backwards copmatibility?
* *For proper deprecation and backwards compatibility, we need to also check
branch_9X and make sure changes are correctly reflected everywhere*
was (Author: JIRAUSER305622):
Notes while working on this issue (moved from Github, new issues may be created
and linked here):
* Between {{{}-noprompt-{}}}, {{-noprompt-}} and {{{}-no-prompt{}}}, which
option will be maintained?
*
** From the virtual meetup, {{--no-prompt}} is correct
* Is {{-collection}} a valid argument, or is there only the plural form?
(eventual typo)
* We have to clarify the difference between {{-V-}} and {{{}-v{}}}, since the
long form of both is {{-verbose}}
** Should we distinguish between the long forms, or merge them to avoid any
confusion about capitalization?
* There are multiple overlapping short-arguments
** {{{}-{-}value{-}{}}}, {{-verbose-}} and {{-version}} all use {{-v}} as
short form
** {{-{-}dir{-}}} and {{-conf-dir}} use both {{{}-d{}}}, are they different?
** {{-{-}solr-url{-}}} (I think) and {{-solr-home}} use both {{-s}} as short
form
* The multicharacter command `url` is still used as `{{{}-url-{}}}` and
resolves to {{-solr-url-}} (probably), {{{}-solr-udpate-url-{}}}, and
{{-solr-colleciton-url}}
** We should consider merging them together if all of them are setting the
same kind of value (the SOLR instance URL the command is executed against)
* {{solr/docker/scripts/docker-entrypoint.sh}} Line 37 to 40 requires
attention (may not work with {{--help}}
* {{solr/bin/instal_solr_service.sh}} - Script ma ybe migrated too to use
double-dashed arguments
* We should consider removing support for {{{}-?-{}}}, {{-usage-}} and
{{-usage}} and only use {{-help}} and {{-h}}
* In {{bin/solr}} line 249 and follow, {{--version}} is not included. Do we
have to add it too?
* {{bin/solr.cmd}} line 530 and follow contains a list of arguments, but list
seems incomplete. Is this a problem? (e.g. {{--help}} is missing)
** Same applies for lines 1409 and follow and 1648 and follow
* We should unify the arguments passed in java code to either use the long
form or the short form (exception only if the test explicitly tests the short
or long form)
** Example are {{{}TestSolrCLIRunExample.java{}}},
{{{}TestExportTool.java{}}}, {{{}DeleteToolTest.java{}}},
{{CreateToolTest.java}} and {{SolrExporter.java}}
* There are some conditions like {{TestSolrCLIRunExample.java}} line 117 that
may need to be expanded with all / additional argument variants (those are hard
to find)
* SolrExporter.java does not list deprecated single-dash-argument in
{{{}ARG_***_FLAGS{}}}, does this break backwards copmatibility?
* *For proper deprecation and backwards compatibility, we need to also check
branch_9X and make sure changes are correctly reflected everywhere*
> Adopt Linux Command line tool pattern of -- for multi character commands.
> -------------------------------------------------------------------------
>
> Key: SOLR-16824
> URL: https://issues.apache.org/jira/browse/SOLR-16824
> Project: Solr
> Issue Type: Sub-task
> Components: cli
> Environment: sweep through and have --get instead of -get etc through
> all our command options.
> Reporter: Eric Pugh
> Assignee: Eric Pugh
> Priority: Major
> Labels: pull-request-available
> Fix For: 9.7
>
> Time Spent: 12h
> Remaining Estimate: 0h
>
--
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
