aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJia Tan <jiat0218@gmail.com>2023-11-09 01:21:53 +0800
committerJia Tan <jiat0218@gmail.com>2023-12-22 20:02:03 +0800
commit84196e8c094402cb71b669fb9e984c56ebabb145 (patch)
treecf13557be8b07866e5bb68e91a4b985666c9b75e
parentBump version and soname for 5.4.5. (diff)
downloadxz-84196e8c094402cb71b669fb9e984c56ebabb145.tar.xz
liblzma: Add missing comments to lz_encoder.h.
-rw-r--r--src/liblzma/lz/lz_encoder.h6
1 files changed, 5 insertions, 1 deletions
diff --git a/src/liblzma/lz/lz_encoder.h b/src/liblzma/lz/lz_encoder.h
index ffcba02c..8d9c6d6e 100644
--- a/src/liblzma/lz/lz_encoder.h
+++ b/src/liblzma/lz/lz_encoder.h
@@ -153,9 +153,13 @@ typedef struct {
/// Maximum search depth
uint32_t depth;
- /// TODO: Comment
+ /// Initial dictionary for the match finder to search.
const uint8_t *preset_dict;
+ /// If the preset dictionary is NULL, this value is ignored.
+ /// Otherwise this member must indicate the preset dictionary's
+ /// buffer size. If this size is larger than dict_size, then only
+ /// the dict_size sized tail of the preset_dict will be used.
uint32_t preset_dict_size;
} lzma_lz_options;