From: Lasse Collin <lasse.collin@tukaani.org>
Date: Tue, 26 Nov 2013 16:20:09 +0000 (+0200)
Subject: liblzma: Document the need for block->check for lzma_block_header_decode().
X-Git-Tag: v5.0.6~16
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=05192b32e553eac5dfbd646b6102d10187f29a05;p=xz

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

Thanks to Tomer Chachamu.
---

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).
  *