[GitHub] [ozone] adoroszlai commented on a diff in pull request #3862: HDDS-5704. Ozone URI syntax description in help content needs to mention about ozone service id

[GitBox <gi...@apache.org>]

adoroszlai commented on code in PR #3862:
URL: https://github.com/apache/ozone/pull/3862#discussion_r1004662944


##########
hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/shell/Shell.java:
##########
@@ -29,11 +29,16 @@
  */
 public abstract class Shell extends GenericCli {
 
-  public static final String OZONE_URI_DESCRIPTION = "Ozone URI could start "
-      + "with o3:// or without prefix. URI may contain the host/serviceId "
-      + "and port of the OM server. Both are optional. "
-      + "If they are not specified it will be identified from "
-      + "the config files.";
+  public static final String OZONE_URI_DESCRIPTION = "Ozone URI could either " +
+      "be a full URI or short URI.\n" +
+      "Full URI should start with o3://serviceId/ " +
+      "and can optionally also contain " +
+      "the port number: o3://serviceId:9999/\n" +
+      "Example of a full URI for a key:\no3://om/vol1/bucket1/key1\n" +
+      "With port number for a volume:\no3://om:9862/vol1/\n" +
+      "Not specified information will be identified from the config files.\n" +

Review Comment:
   Instead of "Not specified information" I think one of the following would be better:
   
    * "Unspecified information"
    * "Any optional part omitted"



-- 
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: issues-unsubscribe@ozone.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@ozone.apache.org
For additional commands, e-mail: issues-help@ozone.apache.org