HDDS-15420. Update Ozone command help menu

hadoop-hdds/docs/content/tools/_index.md

@@ -54,7 +54,7 @@ Admin commands:
    * **classpath** - Prints the class path needed to get the hadoop jar and the
     required libraries.
    * **dtutil**    - Operations related to delegation tokens
-   * **envvars** - Display computed Hadoop environment variables.
+   * **envvars** - Display computed Ozone environment variables.
    * **getconf** -  Reads ozone config values from configuration.
    * **genconf** -  Generate minimally required ozone configs and output to
    ozone-site.xml.

hadoop-ozone/cli-shell/src/main/java/org/apache/hadoop/ozone/shell/OzoneShell.java

@@ -30,7 +30,7 @@
 /**
  * Shell commands for native rpc object manipulation.
  */
-@Command(name = "ozone sh", aliases = "sh",
+@Command(name = "ozone sh", aliases = {"sh", "shell"},
     description = "Shell for Ozone object store",
     subcommands = {
         BucketCommands.class,

hadoop-ozone/dist/src/shell/ozone/ozone

@@ -35,13 +35,13 @@ function ozone_usage
   ozone_add_option "--hosts filename" "list of hosts to use in worker mode"
   ozone_add_option "--loglevel level" "set the log4j level for this command"
   ozone_add_option "--workers" "turn on worker mode"
-  ozone_add_option "--jvmargs arguments" "append JVM options to any existing options defined in the OZONE_OPTS environment variable. Any defined in OZONE_CLIENT_OPTS will be append after these jvmargs"
-  ozone_add_option "--validate (continue)" "validates if all jars as indicated in the corresponding OZONE_RUN_ARTIFACT_NAME classpath file are present, command execution shall continue post validation failure if 'continue' is passed"
+  ozone_add_option "--jvmargs arguments" "append JVM options to any existing options defined in the OZONE_OPTS environment variable. Any defined in OZONE_CLIENT_OPTS will be appended after these jvmargs"
+  ozone_add_option "--validate [continue]" "validate that all required jars are present on the classpath; with 'continue', keep running even if validation fails"
 
   ozone_add_subcommand "classpath" client "prints the class path needed for running ozone commands"
   ozone_add_subcommand "completion" client "generate autocompletion script for bash/zsh"
   ozone_add_subcommand "datanode" daemon "run a HDDS datanode"
-  ozone_add_subcommand "envvars" client "display computed Hadoop environment variables"
+  ozone_add_subcommand "envvars" client "display computed Ozone environment variables"
   ozone_add_subcommand "daemonlog" admin "get/set the log level for each daemon"
   ozone_add_subcommand "freon" client "runs an ozone data generator"
   ozone_add_subcommand "fs" client "run a filesystem command on Ozone file system. Equivalent to 'hadoop fs'"
@@ -53,7 +53,7 @@ function ozone_usage
   ozone_add_subcommand "httpfs" daemon "run the HTTPFS compatible REST gateway"
   ozone_add_subcommand "csi" daemon "run the standalone CSI daemon"
   ozone_add_subcommand "recon" daemon "run the Recon service"
-  ozone_add_subcommand "sh" client "command line interface for object store operations"
+  ozone_add_subcommand "sh" client "command line interface for object store operations (alias: shell)"
   ozone_add_subcommand "s3" client "command line interface for s3 related operations"
   ozone_add_subcommand "tenant" client "command line interface for multi-tenant related operations"
   ozone_add_subcommand "insight" client "tool to get runtime operation information"

hadoop-ozone/dist/src/shell/ozone/ozone-functions.sh

@@ -48,14 +48,14 @@ function ozone_debug
 ## @replaceable yes
 function ozone_validate_classpath_usage
 {
-  description=$'The --validate flag validates if all jars as indicated in the corresponding OZONE_RUN_ARTIFACT_NAME classpath file are present\n\n'
+  description=$'The --validate flag checks that all jars required for the command are present on the classpath\n\n'
   usage_text=$'Usage I: ozone --validate classpath <ARTIFACTNAME>\nUsage II: ozone --validate [OPTIONS] --daemon start|status|stop csi|datanode|om|recon|s3g|scm\n\n'
   options=$'  OPTIONS is none or any of:\n\ncontinue\tcommand execution shall continue even if validation fails'
   ozone_error "${description}${usage_text}${options}"
   exit 1
 }
 
-## @description Validates if all jars as indicated in the corresponding OZONE_RUN_ARTIFACT_NAME classpath file are present
+## @description Validates that all jars required for the command are present on the classpath
 ## @audience private
 ## @stability evolving
 ## @replaceable yes

hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/utils/AutoCompletion.java

@@ -139,7 +139,7 @@ private static final class Ozone {
     private String debug;
 
     @Option(names = {"--daemon"},
-        description = "attempt to add class files from build tree")
+        description = "operate on a daemon")
     private String daemon;
 
     @Option(names = {"--help"},
@@ -168,8 +168,8 @@ private static final class Ozone {
     private String jvmargs;
 
     @Option(names = {"--validate"},
-        description = "validates if all jars as indicated in the corresponding OZONE_RUN_ARTIFACT_NAME classpath " +
-            "file are present, command execution shall continue post validation failure if 'continue' is passed")
+        description = "validate that all required jars are present on the classpath; " +
+            "with 'continue', keep running even if validation fails")
     private String validate;
   }
 }