From e9c47e79c9584ba1126f5fa0dbe6c96e67411aa6 Mon Sep 17 00:00:00 2001 From: Jia Tan Date: Tue, 24 Jan 2023 20:48:50 +0800 Subject: [PATCH] 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. --- src/liblzma/api/lzma/filter.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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).