Browse Source

HDFS-7156. Update fsck documentation. Contributed by Masahiro Yamaguch.

Konstantin V Shvachko 10 years ago
parent
commit
400e1bb4ef

+ 2 - 0
hadoop-hdfs-project/hadoop-hdfs/CHANGES.txt

@@ -512,6 +512,8 @@ Release 2.6.0 - UNRELEASED
     HDFS-6956. Allow dynamically changing the tracing level in Hadoop servers
     HDFS-6956. Allow dynamically changing the tracing level in Hadoop servers
     (cmccabe)
     (cmccabe)
 
 
+    HDFS-7156. Update fsck documentation. (Masahiro Yamaguch via shv)
+
   OPTIMIZATIONS
   OPTIMIZATIONS
 
 
     HDFS-6690. Deduplicate xattr names in memory. (wang)
     HDFS-6690. Deduplicate xattr names in memory. (wang)

+ 2 - 1
hadoop-hdfs-project/hadoop-hdfs/src/main/java/org/apache/hadoop/hdfs/tools/DFSck.java

@@ -77,7 +77,8 @@ public class DFSck extends Configured implements Tool {
   private static final String USAGE = "Usage: DFSck <path> "
   private static final String USAGE = "Usage: DFSck <path> "
       + "[-list-corruptfileblocks | "
       + "[-list-corruptfileblocks | "
       + "[-move | -delete | -openforwrite] "
       + "[-move | -delete | -openforwrite] "
-      + "[-files [-blocks [-locations | -racks]]]] [-showprogress]\n"
+      + "[-files [-blocks [-locations | -racks]]]] "
+      + "[-includeSnapshots] [-showprogress]\n"
       + "\t<path>\tstart checking from this path\n"
       + "\t<path>\tstart checking from this path\n"
       + "\t-move\tmove corrupted files to /lost+found\n"
       + "\t-move\tmove corrupted files to /lost+found\n"
       + "\t-delete\tdelete corrupted files\n"
       + "\t-delete\tdelete corrupted files\n"

+ 32 - 24
hadoop-hdfs-project/hadoop-hdfs/src/site/apt/HDFSCommands.apt.vm

@@ -82,32 +82,40 @@ HDFS Commands Guide
    See {{{./HdfsUserGuide.html#fsck}fsck}} for more info.
    See {{{./HdfsUserGuide.html#fsck}fsck}} for more info.
 
 
    Usage: <<<hdfs fsck [GENERIC_OPTIONS] <path>
    Usage: <<<hdfs fsck [GENERIC_OPTIONS] <path>
+          [-list-corruptfileblocks | 
           [-move | -delete | -openforwrite]
           [-move | -delete | -openforwrite]
           [-files [-blocks [-locations | -racks]]]
           [-files [-blocks [-locations | -racks]]]
-          [-showprogress]>>>
-
-*------------------+---------------------------------------------+
-||  COMMAND_OPTION || Description
-*------------------+---------------------------------------------+
-|   <path>         | Start checking from this path.
-*------------------+---------------------------------------------+
-|   -move          | Move corrupted files to /lost+found
-*------------------+---------------------------------------------+
-|   -delete        | Delete corrupted files.
-*------------------+---------------------------------------------+
-|   -openforwrite  | Print out files opened for write.
-*------------------+---------------------------------------------+
-|   -files         | Print out files being checked.
-*------------------+---------------------------------------------+
-|   -blocks        | Print out block report.
-*------------------+---------------------------------------------+
-|   -locations     | Print out locations for every block.
-*------------------+---------------------------------------------+
-|   -racks         | Print out network topology for data-node locations.
-*------------------+---------------------------------------------+
-|   -showprogress  | Print out dots for progress in output. Default is OFF
-|                  | (no progress).
-*------------------+---------------------------------------------+
+          [-includeSnapshots] [-showprogress]>>>
+
+*------------------------+---------------------------------------------+
+||  COMMAND_OPTION       || Description
+*------------------------+---------------------------------------------+
+|   <path>               | Start checking from this path.
+*------------------------+---------------------------------------------+
+| -move                  | Move corrupted files to /lost+found.
+*------------------------+---------------------------------------------+
+| -delete                | Delete corrupted files.
+*------------------------+---------------------------------------------+
+| -files                 | Print out files being checked.
+*------------------------+---------------------------------------------+
+| -openforwrite          | Print out files opened for write.
+*------------------------+---------------------------------------------+
+|                        | Include snapshot data if the given path 
+| -includeSnapshots      | indicates a snapshottable directory or 
+|                        | there are snapshottable directories under it.
+*------------------------+---------------------------------------------+
+| -list-corruptfileblocks| Print out list of missing blocks and 
+|                        | files they belong to.
+*------------------------+---------------------------------------------+
+| -blocks                | Print out block report.
+*------------------------+---------------------------------------------+
+| -locations             | Print out locations for every block.
+*------------------------+---------------------------------------------+
+| -racks                 | Print out network topology for data-node locations.
+*------------------------+---------------------------------------------+
+| -showprogress          | Print out dots for progress in output. Default is OFF
+|                        | (no progress).
+*------------------------+---------------------------------------------+
 
 
 * Administration Commands
 * Administration Commands