This is an automated email from the ASF dual-hosted git repository. janhoy pushed a commit to branch jira/SOLR-17697-picocli in repository https://gitbox.apache.org/repos/asf/solr.git
commit 4ab0149c086e57399ed33723bee0bf82a5c48ad8 Author: Jan Høydahl <[email protected]> AuthorDate: Thu Jul 30 17:30:57 2026 +0200 Fix CLI docs generation under Gradle 9 and regenerate CLI ref-guide pages Project.javaexec was removed in Gradle 9 (which arrived with the main merge); use injected ExecOperations as done in gradle/globals.gradle. Regenerated pages/cli to reflect the new -s/--solr-connection option group on status, create, delete and zk subcommands. --- solr/solr-ref-guide/build.gradle | 11 ++++++++++- .../modules/deployment-guide/pages/cli/solr-create.adoc | 9 ++++++--- .../modules/deployment-guide/pages/cli/solr-delete.adoc | 7 +++++-- .../modules/deployment-guide/pages/cli/solr-status.adoc | 15 +++++++++++---- .../modules/deployment-guide/pages/cli/solr-zk-cp.adoc | 11 +++++++---- .../deployment-guide/pages/cli/solr-zk-downconfig.adoc | 9 ++++++--- .../modules/deployment-guide/pages/cli/solr-zk-ls.adoc | 8 ++++++-- .../deployment-guide/pages/cli/solr-zk-mkroot.adoc | 9 ++++++--- .../modules/deployment-guide/pages/cli/solr-zk-mv.adoc | 8 ++++++-- .../modules/deployment-guide/pages/cli/solr-zk-rm.adoc | 8 ++++++-- .../deployment-guide/pages/cli/solr-zk-upconfig.adoc | 9 ++++++--- .../deployment-guide/pages/cli/solr-zk-updateacls.adoc | 8 ++++++-- 12 files changed, 81 insertions(+), 31 deletions(-) diff --git a/solr/solr-ref-guide/build.gradle b/solr/solr-ref-guide/build.gradle index 278bb56a57f..d3f519a54c8 100644 --- a/solr/solr-ref-guide/build.gradle +++ b/solr/solr-ref-guide/build.gradle @@ -16,6 +16,8 @@ */ import groovy.json.JsonOutput +import javax.inject.Inject +import org.gradle.process.ExecOperations import org.apache.tools.ant.util.TeeOutputStream apply plugin: 'java' @@ -740,8 +742,15 @@ List<String> buildCliNavEntries(File cliDir) { // Run ManPageGenerator and return the set of generated files (excluding the top-level solr.adoc). // SolrCLI is annotated @Command(name="solr"), so ManPageGenerator writes all files flat into outputDir. +interface CliDocsExecOperationsHolder { + @Inject + ExecOperations getExecOperations() +} + List<File> runManPageGenerator(File outputDir) { - javaexec { + // Project.javaexec was removed in Gradle 9; use injected ExecOperations instead + def execOps = project.objects.newInstance(CliDocsExecOperationsHolder).execOperations + execOps.javaexec { classpath = configurations.cliClasspath mainClass = 'picocli.codegen.docgen.manpage.ManPageGenerator' args = ['--outdir', outputDir.absolutePath, 'org.apache.solr.cli.SolrCLI'] diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-create.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-create.adoc index 74417d2a194..eb0537a83fb 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-create.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-create.adoc @@ -35,7 +35,7 @@ bin/solr create - Creates a core or collection depending on whether Solr is runn .... bin/solr create [-hvV] -c=<name> [-d=<confDir>] [-n=<confName>] [-rf=<replicationFactor>] [-sh=<shards>] [-u=<credentials>] - [-s=<solrUrl> | -z=<zkHost>] + [-s=<solrConnection> | --solr-url=<solrUrl> | -z=<zkHost>] .... // end::picocli-generated-man-section-synopsis[] @@ -65,12 +65,15 @@ Creates a core or collection depending on whether Solr is running in standalone *-rf, --replication-factor*=_<replicationFactor>_:: Number of copies of each document across the collection (replicas per shard); default is 1. -*-s*, *--solr-url*=_<solrUrl>_:: - Base Solr URL, which can be used to determine the zk-host if that's not known. +*-s*, *--solr-connection*=_<solrConnection>_:: + Zookeeper or HTTP(s) connection string; unnecessary if SOLR_CONNECTION is defined in solr.in.sh; otherwise, defaults to localhost:9983. *-sh, --shards*=_<shards>_:: Number of shards; default is 1. +*--solr-url*=_<solrUrl>_:: + Base Solr URL, which can be used to determine the zk-host if that's not known. + *-u*, *--credentials*=_<credentials>_:: Credentials in the format username:password. Example: --credentials solr:SolrRocks diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-delete.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-delete.adoc index a7601a9d606..beec9f271b5 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-delete.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-delete.adoc @@ -34,7 +34,7 @@ bin/solr delete - Deletes a collection or core depending on whether Solr is runn .... bin/solr delete [-fhvV] [--delete-config] -c=<name> [-u=<credentials>] - [-s=<solrUrl> | -z=<zkHost>] + [-s=<solrConnection> | --solr-url=<solrUrl> | -z=<zkHost>] .... // end::picocli-generated-man-section-synopsis[] @@ -61,7 +61,10 @@ Deletes a collection or core depending on whether Solr is running in SolrCloud o *-h*, *--help*:: Show this help message and exit. -*-s*, *--solr-url*=_<solrUrl>_:: +*-s*, *--solr-connection*=_<solrConnection>_:: + Zookeeper or HTTP(s) connection string; unnecessary if SOLR_CONNECTION is defined in solr.in.sh; otherwise, defaults to localhost:9983. + +*--solr-url*=_<solrUrl>_:: Base Solr URL, which can be used to determine the zk-host if that's not known. *-u*, *--credentials*=_<credentials>_:: diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-status.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-status.adoc index 59c45857277..cf5dd062ee6 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-status.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-status.adoc @@ -33,8 +33,9 @@ bin/solr status - Get the status of a Solr server. == Synopsis .... -bin/solr status [-v] [--short] [--max-wait-secs=<maxWaitSecs>] [-p=<port>] - [-s=<solrUrl>] [-u=<credentials>] +bin/solr status [-v] [--short] [--max-wait-secs=<maxWaitSecs>] [-u=<credentials>] + [-p=<port> | -s=<solrConnection> | --solr-url=<solrUrl> | + -z=<zkHost>] .... // end::picocli-generated-man-section-synopsis[] @@ -55,18 +56,24 @@ Get the status of a Solr server. *-p*, *--port*=_<port>_:: Port on localhost to check status for -*-s*, *--solr-url*=_<solrUrl>_:: - Base Solr URL, which can be used to determine the zk-host if that's not known +*-s*, *--solr-connection*=_<solrConnection>_:: + Zookeeper or HTTP(s) connection string; unnecessary if SOLR_CONNECTION is defined in solr.in.sh; otherwise, defaults to localhost:9983. *--short*:: Short format. Prints one URL per line for running instances +*--solr-url*=_<solrUrl>_:: + Base Solr URL, which can be used to determine the zk-host if that's not known + *-u*, *--credentials*=_<credentials>_:: Credentials in the format username:password. Example: --credentials solr:SolrRocks *-v*, *--verbose*:: Enable verbose mode. +*-z*, *--zk-host*=_<zkHost>_:: + Zookeeper connection string; unnecessary if ZK_HOST is defined in solr.in.sh; otherwise, defaults to localhost:9983. + // end::picocli-generated-man-section-options[] // tag::picocli-generated-man-section-arguments[] diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-cp.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-cp.adoc index 39fdfc642fb..deb508993cf 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-cp.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-cp.adoc @@ -33,8 +33,8 @@ bin/solr zk cp - Copy files or folders to/from ZooKeeper or ZooKeeper to ZooKeep == Synopsis .... -bin/solr zk cp [-rv] [-s=<solrUrl>] [--solr-home=DIR] [-u=<credentials>] - [-z=<zkHost>] <src> <dst> +bin/solr zk cp [-rv] [-s=<solrConnection>] [--solr-home=DIR] [--solr-url=<solrUrl>] + [-u=<credentials>] [-z=<zkHost>] <src> <dst> .... // end::picocli-generated-man-section-synopsis[] @@ -58,12 +58,15 @@ and the last element of the <src> path will be appended unless <src> also ends i *-r*, *--recursive*:: Apply the command recursively. -*-s*, *--solr-url*=_<solrUrl>_:: - Base Solr URL, which can be used to determine the zk-host if --zk-host is not known +*-s*, *--solr-connection*=_<solrConnection>_:: + Zookeeper or HTTP(s) connection string; unnecessary if SOLR_CONNECTION is defined in solr.in.sh; otherwise, defaults to localhost:9983. *--solr-home*=_DIR_:: Required to look up configuration for compressing state.json. +*--solr-url*=_<solrUrl>_:: + Base Solr URL, which can be used to determine the zk-host if --zk-host is not known + *-u*, *--credentials*=_<credentials>_:: Credentials in the format username:password. Example: --credentials solr:SolrRocks diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-downconfig.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-downconfig.adoc index 342566fcf6a..7ec72873a06 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-downconfig.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-downconfig.adoc @@ -33,8 +33,8 @@ bin/solr zk downconfig - Download a configset from ZooKeeper to the local filesy == Synopsis .... -bin/solr zk downconfig [-v] -d=DIR -n=<confName> [-s=<solrUrl>] [-u=<credentials>] - [-z=<zkHost>] +bin/solr zk downconfig [-v] -d=DIR -n=<confName> [-s=<solrConnection>] + [--solr-url=<solrUrl>] [-u=<credentials>] [-z=<zkHost>] .... // end::picocli-generated-man-section-synopsis[] @@ -87,7 +87,10 @@ If a pre-existing configuration set is specified, it will be overwritten in ZooK + -*-s*, *--solr-url*=_<solrUrl>_:: +*-s*, *--solr-connection*=_<solrConnection>_:: + Zookeeper or HTTP(s) connection string; unnecessary if SOLR_CONNECTION is defined in solr.in.sh; otherwise, defaults to localhost:9983. + +*--solr-url*=_<solrUrl>_:: Base Solr URL, which can be used to determine the zk-host if --zk-host is not known *-u*, *--credentials*=_<credentials>_:: diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-ls.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-ls.adoc index fe3588d5abd..8cf2382dc8b 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-ls.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-ls.adoc @@ -33,7 +33,8 @@ bin/solr zk ls - List the contents of a ZooKeeper node. == Synopsis .... -bin/solr zk ls [-rv] [-s=<solrUrl>] [-u=<credentials>] [-z=<zkHost>] <path> +bin/solr zk ls [-rv] [-s=<solrConnection>] [--solr-url=<solrUrl>] + [-u=<credentials>] [-z=<zkHost>] <path> .... // end::picocli-generated-man-section-synopsis[] @@ -51,7 +52,10 @@ List the contents of a ZooKeeper node. *-r*, *--recursive*:: Apply the command recursively. -*-s*, *--solr-url*=_<solrUrl>_:: +*-s*, *--solr-connection*=_<solrConnection>_:: + Zookeeper or HTTP(s) connection string; unnecessary if SOLR_CONNECTION is defined in solr.in.sh; otherwise, defaults to localhost:9983. + +*--solr-url*=_<solrUrl>_:: Base Solr URL, which can be used to determine the zk-host if --zk-host is not known *-u*, *--credentials*=_<credentials>_:: diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-mkroot.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-mkroot.adoc index 79582b93e27..7d6027666ae 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-mkroot.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-mkroot.adoc @@ -33,8 +33,8 @@ bin/solr zk mkroot - Make a znode in ZooKeeper with no data. Can be used to make == Synopsis .... -bin/solr zk mkroot [-v] [--fail-on-exists[=<failOnExists>]] [-s=<solrUrl>] - [-u=<credentials>] [-z=<zkHost>] <path> +bin/solr zk mkroot [-v] [--fail-on-exists[=<failOnExists>]] [-s=<solrConnection>] + [--solr-url=<solrUrl>] [-u=<credentials>] [-z=<zkHost>] <path> .... // end::picocli-generated-man-section-synopsis[] @@ -52,7 +52,10 @@ Make a znode in ZooKeeper with no data. Can be used to make a path of arbitrary *--fail-on-exists*[=_<failOnExists>_]:: Raise an error if the znode already exists. Defaults to false. -*-s*, *--solr-url*=_<solrUrl>_:: +*-s*, *--solr-connection*=_<solrConnection>_:: + Zookeeper or HTTP(s) connection string; unnecessary if SOLR_CONNECTION is defined in solr.in.sh; otherwise, defaults to localhost:9983. + +*--solr-url*=_<solrUrl>_:: Base Solr URL, which can be used to determine the zk-host if --zk-host is not known *-u*, *--credentials*=_<credentials>_:: diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-mv.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-mv.adoc index 1a86d32719a..5c8103a1383 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-mv.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-mv.adoc @@ -33,7 +33,8 @@ bin/solr zk mv - Move (rename) a znode on ZooKeeper. == Synopsis .... -bin/solr zk mv [-v] [-s=<solrUrl>] [-u=<credentials>] [-z=<zkHost>] <src> <dst> +bin/solr zk mv [-v] [-s=<solrConnection>] [--solr-url=<solrUrl>] [-u=<credentials>] + [-z=<zkHost>] <src> <dst> .... // end::picocli-generated-man-section-synopsis[] @@ -52,7 +53,10 @@ and the last element of the <src> path will be appended. // tag::picocli-generated-man-section-options[] == Options -*-s*, *--solr-url*=_<solrUrl>_:: +*-s*, *--solr-connection*=_<solrConnection>_:: + Zookeeper or HTTP(s) connection string; unnecessary if SOLR_CONNECTION is defined in solr.in.sh; otherwise, defaults to localhost:9983. + +*--solr-url*=_<solrUrl>_:: Base Solr URL, which can be used to determine the zk-host if --zk-host is not known *-u*, *--credentials*=_<credentials>_:: diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-rm.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-rm.adoc index b194510bbae..64d7a58e32f 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-rm.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-rm.adoc @@ -33,7 +33,8 @@ bin/solr zk rm - Remove a znode from ZooKeeper. == Synopsis .... -bin/solr zk rm [-rv] [-s=<solrUrl>] [-u=<credentials>] [-z=<zkHost>] <path> +bin/solr zk rm [-rv] [-s=<solrConnection>] [--solr-url=<solrUrl>] + [-u=<credentials>] [-z=<zkHost>] <path> .... // end::picocli-generated-man-section-synopsis[] @@ -51,7 +52,10 @@ Remove a znode from ZooKeeper. *-r*, *--recursive*:: Apply the command recursively. -*-s*, *--solr-url*=_<solrUrl>_:: +*-s*, *--solr-connection*=_<solrConnection>_:: + Zookeeper or HTTP(s) connection string; unnecessary if SOLR_CONNECTION is defined in solr.in.sh; otherwise, defaults to localhost:9983. + +*--solr-url*=_<solrUrl>_:: Base Solr URL, which can be used to determine the zk-host if --zk-host is not known *-u*, *--credentials*=_<credentials>_:: diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-upconfig.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-upconfig.adoc index 7353719867f..20708dfe678 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-upconfig.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-upconfig.adoc @@ -33,8 +33,8 @@ bin/solr zk upconfig - Upload a configset from the local filesystem to ZooKeeper == Synopsis .... -bin/solr zk upconfig [-v] -d=DIR -n=<confName> [-s=<solrUrl>] [-u=<credentials>] - [-z=<zkHost>] +bin/solr zk upconfig [-v] -d=DIR -n=<confName> [-s=<solrConnection>] + [--solr-url=<solrUrl>] [-u=<credentials>] [-z=<zkHost>] .... // end::picocli-generated-man-section-synopsis[] @@ -87,7 +87,10 @@ If a pre-existing configuration set is specified, it will be overwritten in ZooK + -*-s*, *--solr-url*=_<solrUrl>_:: +*-s*, *--solr-connection*=_<solrConnection>_:: + Zookeeper or HTTP(s) connection string; unnecessary if SOLR_CONNECTION is defined in solr.in.sh; otherwise, defaults to localhost:9983. + +*--solr-url*=_<solrUrl>_:: Base Solr URL, which can be used to determine the zk-host if --zk-host is not known *-u*, *--credentials*=_<credentials>_:: diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-updateacls.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-updateacls.adoc index da0c05f7437..43abe8ebeb7 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-updateacls.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cli/solr-zk-updateacls.adoc @@ -33,7 +33,8 @@ bin/solr zk updateacls - Recursively re-applies ZooKeeper ACLs to a znode and al == Synopsis .... -bin/solr zk updateacls [-v] [-s=<solrUrl>] [-u=<credentials>] [-z=<zkHost>] <path> +bin/solr zk updateacls [-v] [-s=<solrConnection>] [--solr-url=<solrUrl>] + [-u=<credentials>] [-z=<zkHost>] <path> .... // end::picocli-generated-man-section-synopsis[] @@ -48,7 +49,10 @@ Recursively re-applies ZooKeeper ACLs to a znode and all its descendants. The AC // tag::picocli-generated-man-section-options[] == Options -*-s*, *--solr-url*=_<solrUrl>_:: +*-s*, *--solr-connection*=_<solrConnection>_:: + Zookeeper or HTTP(s) connection string; unnecessary if SOLR_CONNECTION is defined in solr.in.sh; otherwise, defaults to localhost:9983. + +*--solr-url*=_<solrUrl>_:: Base Solr URL, which can be used to determine the zk-host if --zk-host is not known *-u*, *--credentials*=_<credentials>_::
