aboutsummaryrefslogtreecommitdiff
path: root/src/liblzma/api/lzma/block.h
diff options
context:
space:
mode:
authorLasse Collin <lasse.collin@tukaani.org>2013-11-26 18:20:09 +0200
committerLasse Collin <lasse.collin@tukaani.org>2014-04-26 08:31:43 +0300
commit05192b32e553eac5dfbd646b6102d10187f29a05 (patch)
treed0bbe992a8aaa98441ff9851b7c83fd6fae697f0 /src/liblzma/api/lzma/block.h
parentUpdate TODO. (diff)
downloadxz-05192b32e553eac5dfbd646b6102d10187f29a05.tar.xz
liblzma: Document the need for block->check for lzma_block_header_decode().
Thanks to Tomer Chachamu.
Diffstat (limited to '')
-rw-r--r--src/liblzma/api/lzma/block.h3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/liblzma/api/lzma/block.h b/src/liblzma/api/lzma/block.h
index 8a4bf232..e6710a7b 100644
--- a/src/liblzma/api/lzma/block.h
+++ b/src/liblzma/api/lzma/block.h
@@ -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
* 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
* initialized (possible existing filter options are not freed).
*