aboutsummaryrefslogtreecommitdiff
path: root/src/liblzma/api/lzma/lzma12.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/liblzma/api/lzma/lzma12.h')
-rw-r--r--src/liblzma/api/lzma/lzma12.h5
1 files changed, 5 insertions, 0 deletions
diff --git a/src/liblzma/api/lzma/lzma12.h b/src/liblzma/api/lzma/lzma12.h
index 3d3723f9..e7d00fcc 100644
--- a/src/liblzma/api/lzma/lzma12.h
+++ b/src/liblzma/api/lzma/lzma12.h
@@ -555,6 +555,11 @@ do { \
* This function is available only if LZMA1 or LZMA2 encoder has been enabled
* when building liblzma.
*
+ * If features (like certain match finders) have been disabled at build time,
+ * then the function may return success (false) even though the resulting
+ * LZMA1/LZMA2 options may not be usable for encoder initialization
+ * (LZMA_OPTIONS_ERROR).
+ *
* \param[out] options Pointer to LZMA1 or LZMA2 options to be filled
* \param preset Preset level bitwse-ORed with preset flags
*