You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@solr.apache.org by "bszabo97 (via GitHub)" <gi...@apache.org> on 2023/05/10 14:00:38 UTC
[GitHub] [solr] bszabo97 opened a new pull request, #1637: SOLR-16766: Remove -usage as option, and ensure both -help and -h work
bszabo97 opened a new pull request, #1637:
URL: https://github.com/apache/solr/pull/1637
https://issues.apache.org/jira/browse/SOLR-16766
<!--
_(If you are a project committer then you may remove some/all of the following template.)_
Before creating a pull request, please file an issue in the ASF Jira system for Solr:
* https://issues.apache.org/jira/projects/SOLR
For something minor (i.e. that wouldn't be worth putting in release notes), you can skip JIRA.
To create a Jira issue, you will need to create an account there first.
The title of the PR should reference the Jira issue number in the form:
* SOLR-####: <short description of problem or changes>
SOLR must be fully capitalized. A short description helps people scanning pull requests for items they can work on.
Properly referencing the issue in the title ensures that Jira is correctly updated with code review comments and commits. -->
# Description
Nowhere do we mention `-usage` as a parameter, and it's not one that I ever use. `-help` is common, as is `-h`, so make sure that works everywhere. There are places where `-h` doesn't work!
# Solution
Deleted appearances of `-usage` and added `-h` where it was not present. Also made some "beautification" here and there to make the help more consistent and complete.
# Tests
Please describe the tests you've developed or run to confirm this patch implements the feature or solves the problem.
# Checklist
Please review the following and check all that apply:
- [x] I have reviewed the guidelines for [How to Contribute](https://wiki.apache.org/solr/HowToContribute) and my code conforms to the standards described there to the best of my ability.
- [x] I have created a Jira issue and added the issue ID to my pull request title.
- [x] I have given Solr maintainers [access](https://help.github.com/en/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork) to contribute to my PR branch. (optional but recommended)
- [x] I have developed this patch against the `main` branch.
- [x] I have run `./gradlew check`.
- [ ] I have added tests for my changes.
- [x] I have added documentation for the [Reference Guide](https://github.com/apache/solr/tree/main/solr/solr-ref-guide)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] epugh commented on pull request #1637: SOLR-16766: Remove -usage as option, and ensure both -help and -h work
Posted by "epugh (via GitHub)" <gi...@apache.org>.
epugh commented on PR #1637:
URL: https://github.com/apache/solr/pull/1637#issuecomment-1542315926
It would be great to make sure that all the text improvements that you get when you run a `-h` also are in the Ref Guide page ;-)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] epugh merged pull request #1637: SOLR-16766: Remove -usage as option, and ensure both -help and -h work
Posted by "epugh (via GitHub)" <gi...@apache.org>.
epugh merged PR #1637:
URL: https://github.com/apache/solr/pull/1637
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] epugh commented on pull request #1637: SOLR-16766: Remove -usage as option, and ensure both -help and -h work
Posted by "epugh (via GitHub)" <gi...@apache.org>.
epugh commented on PR #1637:
URL: https://github.com/apache/solr/pull/1637#issuecomment-1542307813
in the not too distant future, I think all that detailed "help" information is going to move to the Ref Guide, and we'll only have the help that the commons-cli (or the other tool that @elyograg found) being generated in bin/solr -h... That way we can put all the tips and tricks and examples in one place, the Ref Guide!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] bszabo97 commented on pull request #1637: SOLR-16766: Remove -usage as option, and ensure both -help and -h work
Posted by "bszabo97 (via GitHub)" <gi...@apache.org>.
bszabo97 commented on PR #1637:
URL: https://github.com/apache/solr/pull/1637#issuecomment-1542324337
I was a bit uncertain to add all of the options to the ref guide as well (for example all the `-verbose` options for every command). But if I understand correctly you would suggest to add all of these options and descriptions (where it is more detailed) to the ref guide?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] epugh commented on pull request #1637: SOLR-16766: Remove -usage as option, and ensure both -help and -h work
Posted by "epugh (via GitHub)" <gi...@apache.org>.
epugh commented on PR #1637:
URL: https://github.com/apache/solr/pull/1637#issuecomment-1542327166
a good example is how the `bin/solr package -h` tool works, it has it's own home grown help format that is different then other tools....
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] epugh commented on pull request #1637: SOLR-16766: Remove -usage as option, and ensure both -help and -h work
Posted by "epugh (via GitHub)" <gi...@apache.org>.
epugh commented on PR #1637:
URL: https://github.com/apache/solr/pull/1637#issuecomment-1542326316
> I was a bit uncertain to add all of the options to the ref guide as well (for example all the `-verbose` options for every command). But if I understand correctly you would suggest to add all of these options and descriptions (where it is more detailed) to the ref guide?
I think so.... We should point users to the ref guide for detailed help information when using our various bin/solr XXX tools... Otehrwise, what we see is that we duplicate content and it gets out of alignment...
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] bszabo97 commented on pull request #1637: SOLR-16766: Remove -usage as option, and ensure both -help and -h work
Posted by "bszabo97 (via GitHub)" <gi...@apache.org>.
bszabo97 commented on PR #1637:
URL: https://github.com/apache/solr/pull/1637#issuecomment-1542332793
So you suggest to add everything to the ref guide and change the help of the tools to a link which points the users to the corresponding ref guide paragraph instead of having the whole description duplicated?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org