liblzma: Reword lzma_str_list_filters() documentation.

Reword "options required" to "options read". The previous wording
may have suggested that the options listed were all required when
the filters are used for encoding or decoding. Now it should be
more clear that the options listed are the ones relevant for
encoding or decoding.
This commit is contained in:
Jia Tan 2023-05-13 21:21:54 +08:00
parent 1ac79b4cba
commit 98fc14541e
1 changed files with 1 additions and 1 deletions

View File

@ -731,7 +731,7 @@ extern LZMA_API(lzma_ret) lzma_str_from_filters(
* *
* If a filter_id is given then only one line is created which contains the * If a filter_id is given then only one line is created which contains the
* filter name. If LZMA_STR_ENCODER or LZMA_STR_DECODER is used then the * filter name. If LZMA_STR_ENCODER or LZMA_STR_DECODER is used then the
* options required for encoding or decoding are listed on the same line too. * options read by the encoder or decoder are printed on the same line.
* *
* If filter_id is LZMA_VLI_UNKNOWN then all supported .xz-compatible filters * If filter_id is LZMA_VLI_UNKNOWN then all supported .xz-compatible filters
* are listed: * are listed: