root
/
xz
mirror of https://git.tukaani.org/xz.git
1
0
Fork 0
Code Issues Releases Wiki Activity

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.
This commit is contained in:
Jia Tan 2023-01-24 20:48:50 +08:00
parent 99575947a5
commit e9c47e79c9
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/liblzma/api/lzma/filter.h
View File

@ -589,7 +589,7 @@ extern LZMA_API(lzma_ret) lzma_filter_flags_decode(
* be LZMA_FILTERS_MAX + 1 (that is, five) elements * be LZMA_FILTERS_MAX + 1 (that is, five) elements
* in the array. The old contents are ignored so it * in the array. The old contents are ignored so it
* doesn't need to be initialized. This array is * 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 * Once the allocated filter options are no longer
* needed, lzma_filters_free() can be used to free the * needed, lzma_filters_free() can be used to free the
* options (it doesn't free the filters array itself). * options (it doesn't free the filters array itself).