janhoy commented on code in PR #4271: URL: https://github.com/apache/solr/pull/4271#discussion_r3050775826
########## solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk.adoc: ########## @@ -0,0 +1,92 @@ +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. +// DO NOT EDIT -- this page is auto-generated from picocli annotations. +// To update: modify the @Command/@Option annotations in the Java source, then run: +// ./gradlew :solr:solr-ref-guide:generateCliDocs + += bin/solr zk +:page-toclevels: 2 + +// tag::picocli-generated-man-section-name[] +== Name + +bin/solr zk - Sub commands for working with ZooKeeper. + +// end::picocli-generated-man-section-name[] + +// tag::picocli-generated-man-section-synopsis[] +== Synopsis + +*bin/solr zk* [*-hV*] [COMMAND] + +// end::picocli-generated-man-section-synopsis[] + +// tag::picocli-generated-man-section-description[] +== Description + +Sub commands for working with ZooKeeper. + +// end::picocli-generated-man-section-description[] + +// tag::picocli-generated-man-section-options[] +== Options + +*-h*, *--help*:: + Show this help message and exit. + +*-V*, *--version*:: + Print version information and exit. + +// end::picocli-generated-man-section-options[] + +// tag::picocli-generated-man-section-arguments[] +// end::picocli-generated-man-section-arguments[] + +// tag::picocli-generated-man-section-commands[] +== Commands + +xref:bin/solr zk-downconfig.adoc[*downconfig*]:: + Download a configset from ZooKeeper to the local filesystem. Review Comment: Unfortunately these links will not work as the tool-name `bin/solr` contains a slash. I propose we change the tool name to simply `solr` (it is obvious that it is in the bin folder), which will fix this. Only reason I flipped it to `bin/solr` is that the BATS tests currently assert for that string in outputs, and we want the BATS tests to run green on both commons-cli and picocli parsers. WDYT? -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
