Jason Gerlowski commented on SOLR-11902:

Thanks for the help guys.  I verified the behavior that Shawn laid out above.

I've attached a patch with some modifications to the help text for the various 
bin/solr commands.  I wasn't able to take things as far as I initially thought; 
some of the bin/solr commands are missing help text altogether, and others 
(such as {{assert}}) have their help text generated from the {{commons-cli}} 
library parsing the {{Options}} over in SolrCLI.java.

I'm happy to add the missing help text for those commands that need it.  I'm 
also happy to tweak the SolrCLI-generated help text to look more like that 
output by the scripts.  But I wasn't sure whether to tack on that work here, or 
have them as separate JIRAs.

Don't have a strong preference personally, but didn't want to assume.  Might 
help this doc change to get in quicker if those slightly-related issues are 
handled elsewhere.  OTOH it might be easier to review them together.  Unless I 
hear otherwise, I'll split them off into different JIRA's I guess.

> bin/solr help text should mention when commands must be run from Solr host
> --------------------------------------------------------------------------
>                 Key: SOLR-11902
>                 URL: https://issues.apache.org/jira/browse/SOLR-11902
>             Project: Solr
>          Issue Type: Improvement
>      Security Level: Public(Default Security Level. Issues are Public) 
>          Components: documentation, scripts and tools
>    Affects Versions: master (8.0)
>            Reporter: Jason Gerlowski
>            Priority: Minor
>              Labels: documentation
>         Attachments: SOLR-11902.patch
> The {{bin/solr}} scripts contain a number of useful tools.  Some of these can 
> be pointed at a Solr host through config, and can be run on the Solr host, an 
> admin's laptop, or anywhere else.  Others make assumptions that require them 
> to be run from the same box where Solr is running.
> These commands should document any such restrictions in their help text, to 
> avoid any potential confusion.

This message was sent by Atlassian JIRA

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

Reply via email to