liblzma: Document the need for block->check for lzma_block_header_decode().

Thanks to Tomer Chachamu.
This commit is contained in:
Lasse Collin 2013-11-26 18:20:09 +02:00
parent d1cd8b1cb8
commit b22e94d8d1
1 changed files with 3 additions and 0 deletions

View File

@ -318,6 +318,9 @@ extern LZMA_API(lzma_ret) lzma_block_header_encode(
* The size of the Block Header must have already been decoded with * The size of the Block Header must have already been decoded with
* lzma_block_header_size_decode() macro and stored to block->header_size. * lzma_block_header_size_decode() macro and stored to block->header_size.
* *
* The integrity check type from Stream Header must have been stored
* to block->check.
*
* block->filters must have been allocated, but they don't need to be * block->filters must have been allocated, but they don't need to be
* initialized (possible existing filter options are not freed). * initialized (possible existing filter options are not freed).
* *