liblzma: Clarify lzma_lzma_preset() documentation in lzma12.h.
commit2caba3efe3e0c2d7c6dca00e22c56812326a34e6
authorJia Tan <jiat0218@gmail.com>
Fri, 24 Feb 2023 15:46:23 +0000 (24 23:46 +0800)
committerJia Tan <jiat0218@gmail.com>
Tue, 7 Mar 2023 15:25:17 +0000 (7 23:25 +0800)
tree83be61f7291ed181c0b12e0917f35ff9dcd12464
parent594f904673ba55a833adfa60bbab6b60d4902d08
liblzma: Clarify lzma_lzma_preset() documentation in lzma12.h.

lzma_lzma_preset() does not guarentee that the lzma_options_lzma are
usable in an encoder even if it returns false (success). If liblzma
is built with default configurations, then the options will always be
usable. However if the match finders hc3, hc4, or bt4 are disabled, then
the options may not be usable depending on the preset level requested.

The documentation was updated to reflect this complexity, since this
behavior was unclear before.
src/liblzma/api/lzma/lzma12.h