Hadoop Common
  1. Hadoop Common
  2. HADOOP-7048

Wrong description of Block-Compressed SequenceFile Format in SequenceFile's javadoc

    Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: 0.21.0
    • Fix Version/s: 0.23.0
    • Component/s: io
    • Labels:
      None
    • Hadoop Flags:
      Reviewed

      Description

      Here is the following description for Block-Compressed SequenceFile Format in SequenceFile's javadoc:

      • <li>
      • Record <i>Block</i>
      • <ul>
      • <li>Compressed key-lengths block-size</li>
      • <li>Compressed key-lengths block</li>
      • <li>Compressed keys block-size</li>
      • <li>Compressed keys block</li>
      • <li>Compressed value-lengths block-size</li>
      • <li>Compressed value-lengths block</li>
      • <li>Compressed values block-size</li>
      • <li>Compressed values block</li>
      • </ul>
      • </li>
      • <li>
      • A sync-marker every few <code>100</code> bytes or so.
      • </li>

      This description misses "Uncompressed record number in the block". And "A sync-marker every few <code>100</code> bytes or so" is not the case for Block-Compressed SequenceFile Format. Correct description should be:

      • <li>
      • Record <i>Block</i>
      • <ul>
      • <li>Uncompressed record number in the block</li>
      • <li>Compressed key-lengths block-size</li>
      • <li>Compressed key-lengths block</li>
      • <li>Compressed keys block-size</li>
      • <li>Compressed keys block</li>
      • <li>Compressed value-lengths block-size</li>
      • <li>Compressed value-lengths block</li>
      • <li>Compressed values block-size</li>
      • <li>Compressed values block</li>
      • </ul>
      • </li>
      • <li>
      • A sync-marker every block.
      • </li>
      1. HADOOP-7048.patch
        0.7 kB
        Jingguo Yao

        Activity

        Hide
        Jingguo Yao added a comment -

        Patch available.

        Show
        Jingguo Yao added a comment - Patch available.
        Hide
        Hadoop QA added a comment -

        -1 overall. Here are the results of testing the latest attachment
        http://issues.apache.org/jira/secure/attachment/12460267/HADOOP-7048.patch
        against trunk revision 1038003.

        +1 @author. The patch does not contain any @author tags.

        -1 tests included. The patch doesn't appear to include any new or modified tests.
        Please justify why no new tests are needed for this patch.
        Also please list what manual steps were performed to verify this patch.

        +1 javadoc. The javadoc tool did not generate any warning messages.

        +1 javac. The applied patch does not increase the total number of javac compiler warnings.

        +1 findbugs. The patch does not introduce any new Findbugs (version 1.3.9) warnings.

        +1 release audit. The applied patch does not increase the total number of release audit warnings.

        +1 core tests. The patch passed core unit tests.

        +1 contrib tests. The patch passed contrib unit tests.

        +1 system test framework. The patch passed system test framework compile.

        Test results: https://hudson.apache.org/hudson/job/PreCommit-HADOOP-Build/118//testReport/
        Findbugs warnings: https://hudson.apache.org/hudson/job/PreCommit-HADOOP-Build/118//artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html
        Console output: https://hudson.apache.org/hudson/job/PreCommit-HADOOP-Build/118//console

        This message is automatically generated.

        Show
        Hadoop QA added a comment - -1 overall. Here are the results of testing the latest attachment http://issues.apache.org/jira/secure/attachment/12460267/HADOOP-7048.patch against trunk revision 1038003. +1 @author. The patch does not contain any @author tags. -1 tests included. The patch doesn't appear to include any new or modified tests. Please justify why no new tests are needed for this patch. Also please list what manual steps were performed to verify this patch. +1 javadoc. The javadoc tool did not generate any warning messages. +1 javac. The applied patch does not increase the total number of javac compiler warnings. +1 findbugs. The patch does not introduce any new Findbugs (version 1.3.9) warnings. +1 release audit. The applied patch does not increase the total number of release audit warnings. +1 core tests. The patch passed core unit tests. +1 contrib tests. The patch passed contrib unit tests. +1 system test framework. The patch passed system test framework compile. Test results: https://hudson.apache.org/hudson/job/PreCommit-HADOOP-Build/118//testReport/ Findbugs warnings: https://hudson.apache.org/hudson/job/PreCommit-HADOOP-Build/118//artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html Console output: https://hudson.apache.org/hudson/job/PreCommit-HADOOP-Build/118//console This message is automatically generated.
        Hide
        Tom White added a comment -

        I've just committed this. Thanks Jingguo Yao!

        Show
        Tom White added a comment - I've just committed this. Thanks Jingguo Yao!
        Hide
        Hudson added a comment -

        Integrated in Hadoop-Common-trunk-Commit #498 (See https://hudson.apache.org/hudson/job/Hadoop-Common-trunk-Commit/498/)
        HADOOP-7048. Wrong description of Block-Compressed SequenceFile Format in SequenceFile's javadoc. Contributed by Jingguo Yao.

        Show
        Hudson added a comment - Integrated in Hadoop-Common-trunk-Commit #498 (See https://hudson.apache.org/hudson/job/Hadoop-Common-trunk-Commit/498/ ) HADOOP-7048 . Wrong description of Block-Compressed SequenceFile Format in SequenceFile's javadoc. Contributed by Jingguo Yao.
        Hide
        Hudson added a comment -

        Integrated in Hadoop-Common-trunk #603 (See https://hudson.apache.org/hudson/job/Hadoop-Common-trunk/603/)
        HADOOP-7048. Wrong description of Block-Compressed SequenceFile Format in SequenceFile's javadoc. Contributed by Jingguo Yao.

        Show
        Hudson added a comment - Integrated in Hadoop-Common-trunk #603 (See https://hudson.apache.org/hudson/job/Hadoop-Common-trunk/603/ ) HADOOP-7048 . Wrong description of Block-Compressed SequenceFile Format in SequenceFile's javadoc. Contributed by Jingguo Yao.

          People

          • Assignee:
            Jingguo Yao
            Reporter:
            Jingguo Yao
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Time Tracking

              Estimated:
              Original Estimate - 10m
              10m
              Remaining:
              Remaining Estimate - 10m
              10m
              Logged:
              Time Spent - Not Specified
              Not Specified

                Development