[HADOOP-7048] Wrong description of Block-Compressed SequenceFile Format in SequenceFile's javadoc

• Type: Improvement
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 0.21.0
• Fix Version/s: 0.23.0
• Component/s: io
• Hadoop Flags: Reviewed
• Assignee: Jingguo Yao
• Reporter: Jingguo Yao
• Created: 23/Nov/10 14:02
• Updated: 15/Nov/11 00:51
• Resolved: 11/Feb/11 05:55

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>