aboutsummaryrefslogtreecommitdiff
path: root/src/liblzma/api
diff options
context:
space:
mode:
authorJia Tan <jiat0218@gmail.com>2023-01-24 20:48:50 +0800
committerJia Tan <jiat0218@gmail.com>2023-01-24 20:48:50 +0800
commitf35d98e20609e0be6a04ae2604bfb7cb9d5bd5e4 (patch)
treecb364a456b21006cc976918438ea5a094e181441 /src/liblzma/api
parentRevert "tuklib_common: Define __has_warning if it is not defined." (diff)
downloadxz-f35d98e20609e0be6a04ae2604bfb7cb9d5bd5e4.tar.xz
liblzma: Fix documentation in filter.h for lzma_str_to_filters()
The previous documentation for lzma_str_to_filters() was technically correct, but misleading. lzma_str_to_filters() returns NULL on success, which is in practice always defined to 0. This is the same value as LZMA_OK, but lzma_str_to_filters() does not return lzma_ret so we should be more clear.
Diffstat (limited to 'src/liblzma/api')
-rw-r--r--src/liblzma/api/lzma/filter.h2
1 files changed, 1 insertions, 1 deletions
diff --git a/src/liblzma/api/lzma/filter.h b/src/liblzma/api/lzma/filter.h
index 4c83b2b3..d5054c24 100644
--- a/src/liblzma/api/lzma/filter.h
+++ b/src/liblzma/api/lzma/filter.h
@@ -589,7 +589,7 @@ extern LZMA_API(lzma_ret) lzma_filter_flags_decode(
* be LZMA_FILTERS_MAX + 1 (that is, five) elements
* in the array. The old contents are ignored so it
* doesn't need to be initialized. This array is
- * modified only if this function returns LZMA_OK.
+ * modified only if this function returns NULL.
* Once the allocated filter options are no longer
* needed, lzma_filters_free() can be used to free the
* options (it doesn't free the filters array itself).