Skip to content

armgit / solr

Public Imported from GitHub
0

Apache Solr open-source search software

SOLR-17442: Resolve -v flag conflict (version, value, verbose) (#2721)

Eric Pugheda5ec35e6ca
diff --git a/solr/CHANGES.txt b/solr/CHANGES.txt
index bac9c16ec23..bd9cf256425 100644
--- a/solr/CHANGES.txt
+++ b/solr/CHANGES.txt
@@ -123,6 +123,8 @@ Improvements
* SOLR-17431: Deprecate -p parameter where it doesn't refer to a port in bin/solr. (Eric Pugh, Christos Malliaridis)
+* SOLR-17442: Resolve -v flag conflict (version, value, verbose) in bin/solr. (Eric Pugh, Christos Malliaridis)
+
Optimizations
---------------------
* SOLR-14985: Solrj CloudSolrClient with Solr URLs had serious performance regressions (since the
diff --git a/solr/bin/solr b/solr/bin/solr
index d02d2c6545f..040192548d8 100755
--- a/solr/bin/solr
+++ b/solr/bin/solr
@@ -425,13 +425,11 @@ function print_usage() {
echo " --force If attempting to start Solr as the root user, the script will exit with a warning that running Solr as \"root\" can cause problems."
echo " It is possible to override this warning with the '--force' parameter."
echo ""
- echo " -v and -q Verbose (-v) or quiet (-q) logging. Sets default log level of Solr to DEBUG or WARN instead of INFO"
- echo ""
- echo " -V/--verbose Verbose messages from this script"
+ echo " --verbose or --quiet/-q Verbose or quiet logging. Sets default log level of Solr to DEBUG or WARN instead of INFO"
echo ""
elif [ "$CMD" == "stop" ]; then
echo ""
- echo "Usage: solr stop [-k key] [-p port] [-V]"
+ echo "Usage: solr stop [-k key] [-p port] [--all]"
echo ""
echo " -k <key> Stop key; default is solrrocks"
echo ""
@@ -439,7 +437,7 @@ function print_usage() {
echo ""
echo " --all Find and stop all running Solr servers on this host"
echo ""
- echo " -V/--verbose Verbose messages from this script"
+ echo " --verbose Verbose messages from this script"
echo ""
echo " NOTE: To see if any Solr servers are running, do: solr status"
echo ""
@@ -861,16 +859,13 @@ if [ $# -gt 0 ]; then
PASS_TO_RUN_EXAMPLE+=("--no-prompt")
shift
;;
- -V|--verbose|-verbose)
+ -V|--verbose|-verbose|-v)
verbose=true
- PASS_TO_RUN_EXAMPLE+=("--verbose")
- shift
- ;;
- -v)
SOLR_LOG_LEVEL=DEBUG
+ PASS_TO_RUN_EXAMPLE+=("--verbose")
shift
;;
- -q)
+ -q|--quiet)
SOLR_LOG_LEVEL=WARN
shift
;;
diff --git a/solr/bin/solr.cmd b/solr/bin/solr.cmd
index 287daec0834..ae51b74d8cf 100755
--- a/solr/bin/solr.cmd
+++ b/solr/bin/solr.cmd
@@ -362,15 +362,13 @@ goto done
@echo.
@echo --no-prompt Don't prompt for input; accept all defaults when running examples that accept user input
@echo.
-@echo -v and -q Verbose (-v) or quiet (-q) logging. Sets default log level to DEBUG or WARN instead of INFO
-@echo.
-@echo -V/--verbose Verbose messages from this script
+@echo --verbose and -q/--quiet Verbose or quiet logging. Sets default log level to DEBUG or WARN instead of INFO
@echo.
goto done
:stop_usage
@echo.
-@echo Usage: solr stop [-k key] [-p port] [-V]
+@echo Usage: solr stop [-k key] [-p port] [--verbose]
@echo.
@echo -k key Stop key; default is solrrocks
@echo.
@@ -378,7 +376,7 @@ goto done
@echo.
@echo --all Find and stop all running Solr servers on this host
@echo.
-@echo -V/--verbose Verbose messages from this script
+@echo --verbose Verbose messages from this script
@echo.
@echo NOTE: To see if any Solr servers are running, do: solr status
@echo.
@@ -400,8 +398,9 @@ IF "%1"=="-f" goto set_foreground_mode
IF "%1"=="--foreground" goto set_foreground_mode
IF "%1"=="-V" goto set_verbose
IF "%1"=="--verbose" goto set_verbose
-IF "%1"=="-v" goto set_debug
+IF "%1"=="-v" goto set_verbose
IF "%1"=="-q" goto set_warn
+IF "%1"=="--quiet" goto set_warn
IF "%1"=="-c" goto set_cloud_mode
IF "%1"=="-cloud" goto set_cloud_mode
IF "%1"=="--cloud" goto set_cloud_mode
@@ -451,12 +450,8 @@ goto parse_args
:set_verbose
set verbose=1
-set "PASS_TO_RUN_EXAMPLE=--verbose !PASS_TO_RUN_EXAMPLE!"
-SHIFT
-goto parse_args
-
-:set_debug
set SOLR_LOG_LEVEL=DEBUG
+set "PASS_TO_RUN_EXAMPLE=--verbose !PASS_TO_RUN_EXAMPLE!"
SHIFT
goto parse_args
diff --git a/solr/core/src/java/org/apache/solr/cli/ConfigTool.java b/solr/core/src/java/org/apache/solr/cli/ConfigTool.java
index bc2a8b7dbc0..51d7b114de0 100644
--- a/solr/core/src/java/org/apache/solr/cli/ConfigTool.java
+++ b/solr/core/src/java/org/apache/solr/cli/ConfigTool.java
@@ -92,12 +92,24 @@ public class ConfigTool extends ToolBase {
"Name of the Config API property to apply the action to, such as: 'updateHandler.autoSoftCommit.maxTime'.")
.build(),
Option.builder("v")
- .longOpt("value")
+ .deprecated(
+ DeprecatedAttributes.builder()
+ .setForRemoval(true)
+ .setSince("9.8")
+ .setDescription("Use --value instead")
+ .get())
.argName("VALUE")
.hasArg()
.required(false)
.desc("Set the property to this value; accepts JSON objects and strings.")
.build(),
+ Option.builder()
+ .longOpt("value")
+ .argName("VALUE")
+ .hasArg()
+ .required(false) // should be true when -v is removed.
+ .desc("Set the property to this value; accepts JSON objects and strings.")
+ .build(),
SolrCLI.OPTION_SOLRURL,
SolrCLI.OPTION_SOLRURL_DEPRECATED,
SolrCLI.OPTION_ZKHOST,
@@ -111,12 +123,14 @@ public class ConfigTool extends ToolBase {
String action = cli.getOptionValue("action", "set-property");
String collection = cli.getOptionValue("name");
String property = SolrCLI.getOptionWithDeprecatedAndDefault(cli, "property", "p", null);
- String value = cli.getOptionValue("value");
+ String value = SolrCLI.getOptionWithDeprecatedAndDefault(cli, "value", "v", null);
if (property == null) {
throw new MissingArgumentException("'property' is a required option.");
}
-
+ if (value == null) {
+ throw new MissingArgumentException("'value' is a required option.");
+ }
Map<String, Object> jsonObj = new HashMap<>();
if (value != null) {
Map<String, String> setMap = new HashMap<>();
@@ -133,7 +147,7 @@ public class ConfigTool extends ToolBase {
String updatePath = "/" + collection + "/config";
echo("\nPOSTing request to Config API: " + solrUrl + updatePath);
- echo(jsonBody);
+ echoIfVerbose(jsonBody, cli);
try (SolrClient solrClient =
SolrCLI.getSolrClient(
diff --git a/solr/core/src/java/org/apache/solr/cli/CreateTool.java b/solr/core/src/java/org/apache/solr/cli/CreateTool.java
index 222440afd11..282046750ec 100644
--- a/solr/core/src/java/org/apache/solr/cli/CreateTool.java
+++ b/solr/core/src/java/org/apache/solr/cli/CreateTool.java
@@ -234,7 +234,7 @@ public class CreateTool extends ToolBase {
try {
CoreAdminResponse res = CoreAdminRequest.createCore(coreName, coreName, solrClient);
- if (cli.hasOption(SolrCLI.OPTION_VERBOSE.getOpt())) {
+ if (verbose) {
echo(res.jsonStr());
echo("\n");
} else {
@@ -362,7 +362,7 @@ public class CreateTool extends ToolBase {
"Failed to create collection '" + collectionName + "' due to: " + sse.getMessage());
}
- if (cli.hasOption(SolrCLI.OPTION_VERBOSE.getOpt())) {
+ if (verbose) {
// pretty-print the response to stdout
CharArr arr = new CharArr();
new JSONWriter(arr, 2).write(response.asMap());
diff --git a/solr/core/src/java/org/apache/solr/cli/RunExampleTool.java b/solr/core/src/java/org/apache/solr/cli/RunExampleTool.java
index 13154438aa2..1cbb77e1141 100644
--- a/solr/core/src/java/org/apache/solr/cli/RunExampleTool.java
+++ b/solr/core/src/java/org/apache/solr/cli/RunExampleTool.java
@@ -708,7 +708,7 @@ public class RunExampleTool extends ToolBase {
if (code != 0) throw new Exception("Failed to start Solr using command: " + startCmd);
return getNodeStatus(
- solrUrl, cli.getOptionValue(SolrCLI.OPTION_CREDENTIALS.getLongOpt()), maxWaitSecs);
+ solrUrl, cli.getOptionValue(SolrCLI.OPTION_CREDENTIALS.getLongOpt()), maxWaitSecs, cli);
}
protected Map<String, Object> checkPortConflict(
@@ -887,10 +887,10 @@ public class RunExampleTool extends ToolBase {
return configDir.isDirectory();
}
- protected Map<String, Object> getNodeStatus(String solrUrl, String credentials, int maxWaitSecs)
- throws Exception {
+ protected Map<String, Object> getNodeStatus(
+ String solrUrl, String credentials, int maxWaitSecs, CommandLine cli) throws Exception {
StatusTool statusTool = new StatusTool();
- if (verbose) echo("\nChecking status of Solr at " + solrUrl + " ...");
+ echoIfVerbose("\nChecking status of Solr at " + solrUrl + " ...", cli);
URI solrURI = new URI(solrUrl);
Map<String, Object> nodeStatus =
@@ -899,14 +899,10 @@ public class RunExampleTool extends ToolBase {
CharArr arr = new CharArr();
new JSONWriter(arr, 2).write(nodeStatus);
String mode = (nodeStatus.get("cloud") != null) ? "cloud" : "standalone";
- if (verbose)
- echo(
- "\nSolr is running on "
- + solrURI.getPort()
- + " in "
- + mode
- + " mode with status:\n"
- + arr);
+
+ echoIfVerbose(
+ "\nSolr is running on " + solrURI.getPort() + " in " + mode + " mode with status:\n" + arr,
+ cli);
return nodeStatus;
}
diff --git a/solr/core/src/java/org/apache/solr/cli/SnapshotCreateTool.java b/solr/core/src/java/org/apache/solr/cli/SnapshotCreateTool.java
index 41a5cf13a6b..d80dfbc61ea 100644
--- a/solr/core/src/java/org/apache/solr/cli/SnapshotCreateTool.java
+++ b/solr/core/src/java/org/apache/solr/cli/SnapshotCreateTool.java
@@ -59,8 +59,7 @@ public class SnapshotCreateTool extends ToolBase {
.required(true)
.desc("Name of the snapshot to produce")
.build(),
- SolrCLI.OPTION_CREDENTIALS,
- SolrCLI.OPTION_VERBOSE);
+ SolrCLI.OPTION_CREDENTIALS);
}
@Override
diff --git a/solr/core/src/java/org/apache/solr/cli/SnapshotDeleteTool.java b/solr/core/src/java/org/apache/solr/cli/SnapshotDeleteTool.java
index ee8a0506492..d172391183e 100644
--- a/solr/core/src/java/org/apache/solr/cli/SnapshotDeleteTool.java
+++ b/solr/core/src/java/org/apache/solr/cli/SnapshotDeleteTool.java
@@ -59,8 +59,7 @@ public class SnapshotDeleteTool extends ToolBase {
.required(true)
.desc("Name of the snapshot to delete")
.build(),
- SolrCLI.OPTION_CREDENTIALS,
- SolrCLI.OPTION_VERBOSE);
+ SolrCLI.OPTION_CREDENTIALS);
}
@Override
diff --git a/solr/core/src/java/org/apache/solr/cli/SnapshotDescribeTool.java b/solr/core/src/java/org/apache/solr/cli/SnapshotDescribeTool.java
index 94ef6d98a9e..a007b75f075 100644
--- a/solr/core/src/java/org/apache/solr/cli/SnapshotDescribeTool.java
+++ b/solr/core/src/java/org/apache/solr/cli/SnapshotDescribeTool.java
@@ -72,8 +72,7 @@ public class SnapshotDescribeTool extends ToolBase {
.required(true)
.desc("Name of the snapshot to describe")
.build(),
- SolrCLI.OPTION_CREDENTIALS,
- SolrCLI.OPTION_VERBOSE);
+ SolrCLI.OPTION_CREDENTIALS);
}
@Override
diff --git a/solr/core/src/java/org/apache/solr/cli/SnapshotExportTool.java b/solr/core/src/java/org/apache/solr/cli/SnapshotExportTool.java
index d38a1b19b69..066f980b4d0 100644
--- a/solr/core/src/java/org/apache/solr/cli/SnapshotExportTool.java
+++ b/solr/core/src/java/org/apache/solr/cli/SnapshotExportTool.java
@@ -84,8 +84,7 @@ public class SnapshotExportTool extends ToolBase {
.desc(
"Specifies the async request identifier to be used during snapshot export preparation.")
.build(),
- SolrCLI.OPTION_CREDENTIALS,
- SolrCLI.OPTION_VERBOSE);
+ SolrCLI.OPTION_CREDENTIALS);
}
@Override
diff --git a/solr/core/src/java/org/apache/solr/cli/SnapshotListTool.java b/solr/core/src/java/org/apache/solr/cli/SnapshotListTool.java
index 04cd0738825..a1db955b0c0 100644
--- a/solr/core/src/java/org/apache/solr/cli/SnapshotListTool.java
+++ b/solr/core/src/java/org/apache/solr/cli/SnapshotListTool.java
@@ -54,8 +54,7 @@ public class SnapshotListTool extends ToolBase {
.required(true)
.desc("Name of collection to list snapshots for.")
.build(),
- SolrCLI.OPTION_CREDENTIALS,
- SolrCLI.OPTION_VERBOSE);
+ SolrCLI.OPTION_CREDENTIALS);
}
@Override
diff --git a/solr/core/src/java/org/apache/solr/cli/SolrCLI.java b/solr/core/src/java/org/apache/solr/cli/SolrCLI.java
index dc4045ef90d..3b09ee91cce 100755
--- a/solr/core/src/java/org/apache/solr/cli/SolrCLI.java
+++ b/solr/core/src/java/org/apache/solr/cli/SolrCLI.java
@@ -145,9 +145,16 @@ public class SolrCLI implements CLIO {
+ getDefaultSolrUrl()
+ '.')
.build();
+
public static final Option OPTION_VERBOSE =
Option.builder("v")
.longOpt("verbose")
+ .deprecated(
+ DeprecatedAttributes.builder()
+ .setForRemoval(true)
+ .setSince("9.8")
+ .setDescription("Use --debug instead")
+ .get())
.required(false)
.desc("Enable verbose command output.")
.build();
@@ -192,7 +199,12 @@ public class SolrCLI implements CLIO {
exit(1);
}
- if (Arrays.asList("-v", "-version", "version").contains(args[0])) {
+ if (Arrays.asList("-version", "version").contains(args[0])) {
+ // select the version tool to be run
+ CLIO.out("Deprecated operation as of 9.8. Please use -v or --version.");
+ args[0] = "version";
+ }
+ if (Arrays.asList("-v", "--version").contains(args[0])) {
// select the version tool to be run
args[0] = "version";
}
@@ -222,7 +234,7 @@ public class SolrCLI implements CLIO {
args = remappedArgs;
}
} else {
- // chop the leading zk argument so we invoke the correct zk sub tool
+ // chop the leading zk argument, so we invoke the correct zk sub tool
String[] trimmedArgs = new String[args.length - 1];
System.arraycopy(args, 1, trimmedArgs, 0, trimmedArgs.length);
args = trimmedArgs;
@@ -308,7 +320,7 @@ public class SolrCLI implements CLIO {
}
public static void raiseLogLevelUnlessVerbose(CommandLine cli) {
- if (!cli.hasOption(OPTION_VERBOSE.getOpt())) {
+ if (!cli.hasOption(SolrCLI.OPTION_VERBOSE.getOpt())) {
StartupLoggingUtils.changeLogLevel("WARN");
}
}
@@ -362,6 +374,7 @@ public class SolrCLI implements CLIO {
Options options = new Options();
options.addOption(OPTION_HELP);
options.addOption(OPTION_VERBOSE);
+
List<Option> toolOpts = tool.getOptions();
for (Option toolOpt : toolOpts) {
if (!toolOpt.isDeprecated()) {
@@ -452,7 +465,7 @@ public class SolrCLI implements CLIO {
public static void printToolHelp(Tool tool) {
HelpFormatter formatter = getFormatter();
Options optionsNoDeprecated = new Options();
- tool.getOptions().stream()
+ SolrCLI.getToolOptions(tool).getOptions().stream()
.filter(option -> !option.isDeprecated())
.forEach(optionsNoDeprecated::addOption);
String usageString = tool.getUsage() == null ? "bin/solr " + tool.getName() : tool.getUsage();
@@ -622,8 +635,10 @@ public class SolrCLI implements CLIO {
private static void printHelp() {
print("Usage: solr COMMAND OPTIONS");
+ print(" where COMMAND is one of: start, stop, restart, status, ");
print(
- " where COMMAND is one of: start, stop, restart, status, healthcheck, create, delete, version, auth, assert, config, export, api, package, post, ");
+ " healthcheck, create, delete, auth, assert, config, export, api, package, post, ");
+
print(
" zk ls, zk cp, zk rm , zk mv, zk mkroot, zk upconfig, zk downconfig,");
print(
@@ -642,8 +657,13 @@ public class SolrCLI implements CLIO {
print(
" Omit '-z localhost:2181' from the above command if you have defined ZK_HOST in solr.in.sh.");
print("");
- print("Pass --help or -h after any COMMAND to see command-specific usage information,");
- print("such as: ./solr start --help or ./solr stop -h");
+ print("Global Options:");
+ print(" -v, --version Print version information and quit");
+ print(" --verbose Enable verbose mode");
+ print("");
+ print("Run 'solr COMMAND --help' for more information on a command.");
+ print("");
+ print("For more help on how to use Solr, head to https://solr.apache.org/");
}
/**
@@ -857,7 +877,7 @@ public class SolrCLI implements CLIO {
String RESET = "\u001B[0m";
if (color != null) {
- CLIO.out(color + String.valueOf(message) + RESET);
+ CLIO.out(color + message + RESET);
} else {
CLIO.out(String.valueOf(message));
}
diff --git a/solr/core/src/java/org/apache/solr/cli/ZkLsTool.java b/solr/core/src/java/org/apache/solr/cli/ZkLsTool.java
index 27907c691c7..94b1b329290 100644
--- a/solr/core/src/java/org/apache/solr/cli/ZkLsTool.java
+++ b/solr/core/src/java/org/apache/solr/cli/ZkLsTool.java
@@ -45,8 +45,7 @@ public class ZkLsTool extends ToolBase {
SolrCLI.OPTION_SOLRURL_DEPRECATED,
SolrCLI.OPTION_ZKHOST,
SolrCLI.OPTION_ZKHOST_DEPRECATED,
- SolrCLI.OPTION_CREDENTIALS,
- SolrCLI.OPTION_VERBOSE);
+ SolrCLI.OPTION_CREDENTIALS);
}
@Override
diff --git a/solr/core/src/java/org/apache/solr/cli/ZkMkrootTool.java b/solr/core/src/java/org/apache/solr/cli/ZkMkrootTool.java
index 8fb343a4e65..a7bf9acf09f 100644
--- a/solr/core/src/java/org/apache/solr/cli/ZkMkrootTool.java
+++ b/solr/core/src/java/org/apache/solr/cli/ZkMkrootTool.java
@@ -52,8 +52,7 @@ public class ZkMkrootTool extends ToolBase {
SolrCLI.OPTION_SOLRURL_DEPRECATED,
SolrCLI.OPTION_ZKHOST,
SolrCLI.OPTION_ZKHOST_DEPRECATED,
- SolrCLI.OPTION_CREDENTIALS,
- SolrCLI.OPTION_VERBOSE);
+ SolrCLI.OPTION_CREDENTIALS);
}
@Override
diff --git a/solr/core/src/java/org/apache/solr/cli/ZkMvTool.java b/solr/core/src/java/org/apache/solr/cli/ZkMvTool.java
index 65e2fdc511b..06dfff25b47 100644
--- a/solr/core/src/java/org/apache/solr/cli/ZkMvTool.java
+++ b/solr/core/src/java/org/apache/solr/cli/ZkMvTool.java
@@ -48,8 +48,7 @@ public class ZkMvTool extends ToolBase {
SolrCLI.OPTION_SOLRURL_DEPRECATED,
SolrCLI.OPTION_ZKHOST,
SolrCLI.OPTION_ZKHOST_DEPRECATED,
- SolrCLI.OPTION_CREDENTIALS,
- SolrCLI.OPTION_VERBOSE);
+ SolrCLI.OPTION_CREDENTIALS);
}
@Override
diff --git a/solr/core/src/java/org/apache/solr/cli/ZkRmTool.java b/solr/core/src/java/org/apache/solr/cli/ZkRmTool.java
index fbedfc77868..10648ee0c8c 100644
--- a/solr/core/src/java/org/apache/solr/cli/ZkRmTool.java
+++ b/solr/core/src/java/org/apache/solr/cli/ZkRmTool.java
@@ -47,8 +47,7 @@ public class ZkRmTool extends ToolBase {
SolrCLI.OPTION_SOLRURL_DEPRECATED,
SolrCLI.OPTION_ZKHOST,
SolrCLI.OPTION_ZKHOST_DEPRECATED,
- SolrCLI.OPTION_CREDENTIALS,
- SolrCLI.OPTION_VERBOSE);
+ SolrCLI.OPTION_CREDENTIALS);
}
@Override
diff --git a/solr/packaging/test/test_bats.bats b/solr/packaging/test/test_bats.bats
index f2983f4edcd..024a7b5d81b 100644
--- a/solr/packaging/test/test_bats.bats
+++ b/solr/packaging/test/test_bats.bats
@@ -35,7 +35,7 @@ teardown_file() {
# Conversely, on shutdown, we do need this to execute strictly
# because using "run" will eat failing test exit codes
solr stop --all
- # DEBUG : (echo -n "# " ; solr stop -V --all) >&3
+ # DEBUG : (echo -n "# " ; solr stop --verbose --all) >&3
}
teardown() {
diff --git a/solr/packaging/test/test_config.bats b/solr/packaging/test/test_config.bats
index 1467e06be7f..9a7e5cb2855 100644
--- a/solr/packaging/test/test_config.bats
+++ b/solr/packaging/test/test_config.bats
@@ -50,6 +50,7 @@ teardown() {
run solr config -c COLL_NAME --property updateHandler.autoCommit.maxDocs -v 100
assert_output --partial "Successfully set-property updateHandler.autoCommit.maxDocs to 100"
+ assert_output --partial "Deprecated for removal since 9.8: Use --value instead"
assert_output --partial "assuming solr url is http://localhost:${SOLR_PORT}."
}
diff --git a/solr/packaging/test/test_help.bats b/solr/packaging/test/test_help.bats
index f131cba0bce..ee32052271a 100644
--- a/solr/packaging/test/test_help.bats
+++ b/solr/packaging/test/test_help.bats
@@ -84,12 +84,6 @@ setup() {
refute_output --partial 'ERROR'
}
-@test "version help flag prints help" {
- run solr version -h
- assert_output --partial 'usage: bin/solr version'
- refute_output --partial 'ERROR'
-}
-
@test "zk help flag prints help" {
run solr zk --help
assert_output --partial 'usage:'
diff --git a/solr/packaging/test/test_version.bats b/solr/packaging/test/test_version.bats
new file mode 100644
index 00000000000..abaf181eb2f
--- /dev/null
+++ b/solr/packaging/test/test_version.bats
@@ -0,0 +1,42 @@
+#!/usr/bin/env bats
+
+# 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.
+
+load bats_helper
+
+setup() {
+ common_clean_setup
+}
+
+@test "--version and -v both return Solr version" {
+ run solr --version
+ assert_output --partial "Solr version is:"
+
+ run solr -v
+ assert_output --partial "Solr version is:"
+
+}
+
+@test "-version and version both return Solr version and deprecation" {
+ run solr -version
+ assert_output --partial "Solr version is:"
+ assert_output --partial "Deprecated operation as of 9.8. Please use -v or --version."
+
+ run solr version
+ assert_output --partial "Solr version is:"
+ assert_output --partial "Deprecated operation as of 9.8. Please use -v or --version."
+
+}
diff --git a/solr/packaging/test/test_zk.bats b/solr/packaging/test/test_zk.bats
index 6c776c411ed..a87d8130911 100644
--- a/solr/packaging/test/test_zk.bats
+++ b/solr/packaging/test/test_zk.bats
@@ -172,7 +172,7 @@ teardown() {
run solr zk cp afile.txt zk:/afile.txt -z localhost:${ZK_PORT} --verbose --solr-home ${SOLR_TIP}/server/solr
assert_output --partial "Using SolrHome: ${SOLR_TIP}/server/solr"
refute_output --partial 'Failed to load solr.xml from ZK or SolrHome'
-
+
# The -DminStateByteLenForCompression variable substitution on solr start is not seen
# by the ZkCpTool.java, so therefore we do not have compression unless solr.xml is directly edited.
#assert_output --partial 'Compression of state.json has been enabled'
diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/configuring-logging.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/configuring-logging.adoc
index 27f74d02fdb..ba303745656 100644
--- a/solr/solr-ref-guide/modules/deployment-guide/pages/configuring-logging.adoc
+++ b/solr/solr-ref-guide/modules/deployment-guide/pages/configuring-logging.adoc
@@ -115,10 +115,10 @@ Examples:
[source,bash]
----
-# Start with verbose (DEBUG) looging
-bin/solr start -f -v
+# Start with detailed (DEBUG) logging
+bin/solr start -f --verbose
# Start with quiet (WARN) logging
-bin/solr start -f -q
+bin/solr start -f --quiet
----
== Permanent Logging Settings
diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/solr-control-script-reference.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/solr-control-script-reference.adoc
index 027bd365de2..9a80caa2735 100644
--- a/solr/solr-ref-guide/modules/deployment-guide/pages/solr-control-script-reference.adoc
+++ b/solr/solr-ref-guide/modules/deployment-guide/pages/solr-control-script-reference.adoc
@@ -223,19 +223,19 @@ If passed relative dir, validation with current dir will be done, before trying
Sets the `solr.data.home` system property, where Solr will store index data in <instance_dir>/data subdirectories.
If not set, Solr uses solr.solr.home for config and data.
-`-v`::
+`--verbose`::
+
[%autowidth,frame=none]
|===
|Optional |Default: none
|===
+
-Be more verbose.
-This changes the logging level of Log4j in Solr from `INFO` to `DEBUG`, having the same effect as if you edited `log4j2.xml`.
+This does two things. It provides additional debugging information on how the script is configured to start Solr.
+It also changes the logging level of Log4j in Solr from `INFO` to `DEBUG`, having the same effect as if you edited `log4j2.xml`.
+
-*Example*: `bin/solr start -f -v`
+*Example*: `bin/solr start -f --verbose`
-`-q`::
+`-q` or `--quiet`::
+
[%autowidth,frame=none]
|===
@@ -248,17 +248,6 @@ This can be useful in a production setting where you want to limit logging to wa
+
*Example*: `bin/solr start -f -q`
-`-V` or `--verbose`::
-+
-[%autowidth,frame=none]
-|===
-|Optional |Default: none
-|===
-+
-Verbose messages from this script.
-+
-*Example*: `bin/solr start -V`
-
`-z <zkHost>` or `--zk-host <zkHost>`::
+
[%autowidth,frame=none]
@@ -426,7 +415,7 @@ Stop key used to protect from stopping Solr inadvertently; default is "solrrocks
+
*Example*: `bin/solr stop -k solrrocks`
-`-V` or `--verbose`::
+`-d` or `--verbose`::
+
[%autowidth,frame=none]
|===
@@ -435,17 +424,17 @@ Stop key used to protect from stopping Solr inadvertently; default is "solrrocks
+
Stop Solr with verbose messages from this script.
+
-*Example*: `bin/solr stop -V`
+*Example*: `bin/solr stop --verbose`
== System Information
=== Version
-The `version` command simply returns the version of Solr currently installed and immediately exists.
+The `--version` command simply returns the version of Solr currently installed and immediately exists.
[source,bash]
----
-$ bin/solr version
+$ bin/solr --version
X.Y.0
----
@@ -519,7 +508,6 @@ usage: bin/solr assert [-m <message>] [-e] [-rR] [-s <url>] [-S <url>] [-c
should be for root Solr path.
-e,--exitcode Return an exit code instead of printing
error message on assert fail.
- -h,--help Print this message.
-m,--message <message> Exception message to be used in place of
the default error message.
-R,--not-root Asserts that we are NOT the root user.
@@ -532,7 +520,6 @@ usage: bin/solr assert [-m <message>] [-e] [-rR] [-s <url>] [-S <url>] [-c
timeout.
-u,--same-user <directory> Asserts that we run as same user that owns
<directory>.
- -v,--verbose Enable more verbose command output.
-x,--exists <directory> Asserts that directory <directory> exists.
-X,--not-exists <directory> Asserts that directory <directory> does NOT
exist.