aboutsummaryrefslogtreecommitdiff
path: root/src/liblzma/lz/lz_encoder.h
diff options
context:
space:
mode:
authorJia Tan <jiat0218@gmail.com>2023-11-09 01:21:53 +0800
committerJia Tan <jiat0218@gmail.com>2023-11-09 01:21:53 +0800
commit2ade7246e7ba729a91460d2fab0f4c7b89d3998b (patch)
tree8c921e0cefa36bd9d4d5a348f30841bd47ee95c0 /src/liblzma/lz/lz_encoder.h
parentAdd NEWS for 5.4.5. (diff)
downloadxz-2ade7246e7ba729a91460d2fab0f4c7b89d3998b.tar.xz
liblzma: Add missing comments to lz_encoder.h.
Diffstat (limited to 'src/liblzma/lz/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 80cdcf63..8bd21322 100644
--- a/src/liblzma/lz/lz_encoder.h
+++ b/src/liblzma/lz/lz_encoder.h
@@ -161,9 +161,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;