aboutsummaryrefslogtreecommitdiff
path: root/src/liblzma/api
diff options
context:
space:
mode:
authorLasse Collin <lasse.collin@tukaani.org>2014-12-02 20:04:07 +0200
committerLasse Collin <lasse.collin@tukaani.org>2014-12-02 20:04:07 +0200
commit1190c641af09cde85f8bd0fbe5c4906f4a29431b (patch)
tree86aa72276997214b17ea1e95b8d1f386b689f46a /src/liblzma/api
parentUpdate INSTALL about a "make check" failure in test_scripts.sh. (diff)
downloadxz-1190c641af09cde85f8bd0fbe5c4906f4a29431b.tar.xz
liblzma: Document how lzma_mt.block_size affects memory usage.
Diffstat (limited to 'src/liblzma/api')
-rw-r--r--src/liblzma/api/lzma/container.h4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/liblzma/api/lzma/container.h b/src/liblzma/api/lzma/container.h
index 34cf6f48..86991add 100644
--- a/src/liblzma/api/lzma/container.h
+++ b/src/liblzma/api/lzma/container.h
@@ -96,6 +96,10 @@ typedef struct {
* Set this to 0 to let liblzma choose the block size depending
* on the compression options. For LZMA2 it will be 3*dict_size
* or 1 MiB, whichever is more.
+ *
+ * For each thread, about 3 * block_size bytes of memory will be
+ * allocated. This may change in later liblzma versions. If so,
+ * the memory usage will probably be reduced, not increased.
*/
uint64_t block_size;