svn commit: r1575580 - /hbase/trunk/hbase-client/src/main/java/org/apache/hadoop/hbase/client/HBaseAdmin.java

[ra...@apache.org]

Author: rajeshbabu
Date: Sat Mar  8 18:04:30 2014
New Revision: 1575580

URL: http://svn.apache.org/r1575580
Log:
HBASE-8076 add better doc for HBaseAdmin#offline API.(Rajesh)

Modified:
    hbase/trunk/hbase-client/src/main/java/org/apache/hadoop/hbase/client/HBaseAdmin.java

Modified: hbase/trunk/hbase-client/src/main/java/org/apache/hadoop/hbase/client/HBaseAdmin.java
URL: http://svn.apache.org/viewvc/hbase/trunk/hbase-client/src/main/java/org/apache/hadoop/hbase/client/HBaseAdmin.java?rev=1575580&r1=1575579&r2=1575580&view=diff
==============================================================================
--- hbase/trunk/hbase-client/src/main/java/org/apache/hadoop/hbase/client/HBaseAdmin.java (original)
+++ hbase/trunk/hbase-client/src/main/java/org/apache/hadoop/hbase/client/HBaseAdmin.java Sat Mar  8 18:04:30 2014
@@ -1754,7 +1754,16 @@ public class HBaseAdmin implements Abort
   }
 
   /**
-   * Special method, only used by hbck.
+   * Offline specified region from master's in-memory state. It will not attempt to reassign the
+   * region as in unassign. This API can be used when a region not served by any region server and
+   * still online as per Master's in memory state. If this API is incorrectly used on active region
+   * then master will loose track of that region.
+   * 
+   * This is a special method that should be used by experts or hbck.
+   * 
+   * @param regionName
+   *          Region to offline.
+   * @throws IOException
    */
   public void offline(final byte [] regionName)
   throws IOException {