wchevreuil commented on a change in pull request #6: HBASE-22680 [HBCK2] 
OfflineMetaRepair for hbase2/hbck2
URL: https://github.com/apache/hbase-operator-tools/pull/6#discussion_r303840456
 
 

 ##########
 File path: hbase-hbck2/src/main/java/org/apache/hbase/HBCK2.java
 ##########
 @@ -307,29 +309,28 @@ private static final String getCommandUsage() {
     writer.println("   To read current table state, in the hbase shell run: ");
     writer.println("     hbase> get 'hbase:meta', '<TABLENAME>', 
'table:state'");
     writer.println("   A value of \\x08\\x00 == ENABLED, \\x08\\x01 == 
DISABLED, etc.");
+    writer.println("   Can also run a 'describe \"<TABLENAME>\"' at the shell 
prompt.");
     writer.println("   An example making table name 'user' ENABLED:");
     writer.println("     $ HBCK2 setTableState users ENABLED");
     writer.println("   Returns whatever the previous table state was.");
     writer.println();
     writer.println(" " + SET_REGION_STATE + " <ENCODED_REGIONNAME> <STATE>");
-    writer.println("   Possible region states: " + 
Arrays.stream(RegionState.State.values()).
-      map(i -> i.toString()).collect(Collectors.joining(", ")));
+    writer.println("   Possible region states:");
+    writer.println("      " + Arrays.stream(RegionState.State.values()).map(i 
-> i.toString()).
+        collect(Collectors.joining(", ")));
     writer.println("   WARNING: This is a very risky option intended for use 
as last resort.");
-    writer.println("    Example scenarios are when unassigns/assigns can't 
move forward ");
-    writer.println("     due to region being in an inconsistent state in META. 
For example, ");
-    writer.println("     'unassigns' command can only proceed ");
-    writer.println("      if passed in region is in one of following states: 
");
-    writer.println("                [SPLITTING|SPLIT|MERGING|OPEN|CLOSING]");
-    writer.println("   Before manually setting a region state with this 
command,");
-    writer.println("   please certify that this region is not being handled 
by");
-    writer.println("   by a running procedure, such as Assign or Split. You 
can get a view of ");
-    writer.println("   running procedures from hbase shell, using 
'list_procedures' command. ");
-    writer.println("   An example setting region 
'de00010733901a05f5a2a3a382e27dd4' to CLOSING:");
+    writer.println("   Example scenarios include unassigns/assigns that can't 
move forward");
+    writer.println("   because region is in an inconsistent state in 
'hbase:meta'. For");
+    writer.println("   example, the 'unassigns' command can only proceed if 
passed a region");
+    writer.println("   in one of the following states: 
SPLITTING|SPLIT|MERGING|OPEN|CLOSING");
+    writer.println("   Before manually setting a region state with this 
command, please");
+    writer.println("   certify that this region is not being handled by a 
running procedure,");
+    writer.println("   such as 'assign' or 'split'. You can get a view of 
running procedures");
+    writer.println("   in the hbase shell using the 'list_procedures' command. 
An example");
+    writer.println("   setting region 'de00010733901a05f5a2a3a382e27dd4' to 
CLOSING:");
     writer.println("     $ HBCK2 setRegionState 
de00010733901a05f5a2a3a382e27dd4 CLOSING");
-    writer.println("   Returns \"0\" SUCCESS code if it informed region state 
is changed, "
-      + "\"1\" FAIL code otherwise.");
+    writer.println("   Returns \"0\" if region state changed and \"1\" 
otherwise.");
     writer.println();
 
 Review comment:
   Although part of hbck2 project, OMR has its own main class. I see we are 
already explaining this on the README, but operators already acquainted with 
current hbck2 may take _HBCK2_ class as the single hbck2 executable, and rely 
only on its help output as a documentation. Maybe worth add a sort of _SEE 
ALSO_ section in this help, referring the OMR executable?

----------------------------------------------------------------
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.
 
For queries about this service, please contact Infrastructure at:
[email protected]


With regards,
Apache Git Services

Reply via email to