aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJia Tan <jiat0218@gmail.com>2023-02-03 00:10:34 +0800
committerJia Tan <jiat0218@gmail.com>2023-02-03 00:22:53 +0800
commit85ea0979adcf808a3830aefbe7a4ec884e542ea1 (patch)
tree89937634bcd8f5ed3977db3722230732a15cbbc0
parentliblzma: Improve documentation for block.h. (diff)
downloadxz-85ea0979adcf808a3830aefbe7a4ec884e542ea1.tar.xz
liblzma: Clarify comment in block.h.
-rw-r--r--src/liblzma/api/lzma/block.h3
1 files changed, 2 insertions, 1 deletions
diff --git a/src/liblzma/api/lzma/block.h b/src/liblzma/api/lzma/block.h
index b71b55b4..b4eff8b1 100644
--- a/src/liblzma/api/lzma/block.h
+++ b/src/liblzma/api/lzma/block.h
@@ -324,7 +324,8 @@ typedef struct {
* Note that if the first byte is 0x00, it indicates beginning of Index; use
* this macro only when the byte is not 0x00.
*
- * There is no encoding macro, because Block Header encoder is enough for that.
+ * There is no encoding macro, because lzma_block_header_size() and
+ * lzma_block_header_encode() should be used.
*/
#define lzma_block_header_size_decode(b) (((uint32_t)(b) + 1) * 4)