diff --git a/hadoop-hdfs-project/hadoop-hdfs/CHANGES.txt b/hadoop-hdfs-project/hadoop-hdfs/CHANGES.txt
index da99034bfe..26ba597314 100644
--- a/hadoop-hdfs-project/hadoop-hdfs/CHANGES.txt
+++ b/hadoop-hdfs-project/hadoop-hdfs/CHANGES.txt
@@ -416,6 +416,8 @@ Release 2.4.0 - UNRELEASED
HDFS-5759. Web UI does not show up during the period of loading FSImage.
(Haohui Mai via Arpit Agarwal)
+ HDFS-5942. Fix javadoc in OfflineImageViewer. (Akira Ajisaka via cnauroth)
+
BREAKDOWN OF HDFS-5698 SUBTASKS AND RELATED JIRAS
HDFS-5717. Save FSImage header in protobuf. (Haohui Mai via jing9)
diff --git a/hadoop-hdfs-project/hadoop-hdfs/src/main/java/org/apache/hadoop/hdfs/tools/offlineImageViewer/LsrPBImage.java b/hadoop-hdfs-project/hadoop-hdfs/src/main/java/org/apache/hadoop/hdfs/tools/offlineImageViewer/LsrPBImage.java
index 61c4d5e22c..b697057169 100644
--- a/hadoop-hdfs-project/hadoop-hdfs/src/main/java/org/apache/hadoop/hdfs/tools/offlineImageViewer/LsrPBImage.java
+++ b/hadoop-hdfs-project/hadoop-hdfs/src/main/java/org/apache/hadoop/hdfs/tools/offlineImageViewer/LsrPBImage.java
@@ -51,28 +51,16 @@
import com.google.common.io.LimitInputStream;
/**
- * This is the tool for analyzing file sizes in the namespace image. In order to
- * run the tool one should define a range of integers [0, maxSize] by
- * specifying maxSize and a step. The range of integers is
- * divided into segments of size step:
- * [0, s1, ..., sn-1, maxSize], and the visitor
- * calculates how many files in the system fall into each segment
- * [si-1, si). Note that files larger than
- * maxSize always fall into the very last segment.
+ * LsrPBImage displays the blocks of the namespace in a format very similar
+ * to the output of ls/lsr. Entries are marked as directories or not,
+ * permissions listed, replication, username and groupname, along with size,
+ * modification date and full path.
*
- *
Input.
- *
- * - filename specifies the location of the image file;
- * - maxSize determines the range [0, maxSize] of files
- * sizes considered by the visitor;
- * - step the range is divided into segments of size step.
- *
- *
- * Output.
The output file is formatted as a tab separated two column
- * table: Size and NumFiles. Where Size represents the start of the segment, and
- * numFiles is the number of files form the image which size falls in this
- * segment.
- *
+ * Note: A significant difference between the output of the lsr command
+ * and this image visitor is that this class cannot sort the file entries;
+ * they are listed in the order they are stored within the fsimage file.
+ * Therefore, the output of this class cannot be directly compared to the
+ * output of the lsr command.
*/
final class LsrPBImage {
private final Configuration conf;
diff --git a/hadoop-hdfs-project/hadoop-hdfs/src/main/java/org/apache/hadoop/hdfs/tools/offlineImageViewer/PBImageXmlWriter.java b/hadoop-hdfs-project/hadoop-hdfs/src/main/java/org/apache/hadoop/hdfs/tools/offlineImageViewer/PBImageXmlWriter.java
index d70f63710b..659f13394e 100644
--- a/hadoop-hdfs-project/hadoop-hdfs/src/main/java/org/apache/hadoop/hdfs/tools/offlineImageViewer/PBImageXmlWriter.java
+++ b/hadoop-hdfs-project/hadoop-hdfs/src/main/java/org/apache/hadoop/hdfs/tools/offlineImageViewer/PBImageXmlWriter.java
@@ -55,28 +55,8 @@
import com.google.common.io.LimitInputStream;
/**
- * This is the tool for analyzing file sizes in the namespace image. In order to
- * run the tool one should define a range of integers [0, maxSize] by
- * specifying maxSize and a step. The range of integers is
- * divided into segments of size step:
- * [0, s1, ..., sn-1, maxSize], and the visitor
- * calculates how many files in the system fall into each segment
- * [si-1, si). Note that files larger than
- * maxSize always fall into the very last segment.
- *
- * Input.
- *
- * - filename specifies the location of the image file;
- * - maxSize determines the range [0, maxSize] of files
- * sizes considered by the visitor;
- * - step the range is divided into segments of size step.
- *
- *
- * Output.
The output file is formatted as a tab separated two column
- * table: Size and NumFiles. Where Size represents the start of the segment, and
- * numFiles is the number of files form the image which size falls in this
- * segment.
- *
+ * PBImageXmlWriter walks over an fsimage structure and writes out
+ * an equivalent XML document that contains the fsimage's components.
*/
@InterfaceAudience.Private
public final class PBImageXmlWriter {