]> git.ipfire.org Git - thirdparty/xz.git/commitdiff
liblzma: Reword lzma_str_list_filters() documentation.
authorJia Tan <jiat0218@gmail.com>
Tue, 18 Jul 2023 14:52:25 +0000 (22:52 +0800)
committerJia Tan <jiat0218@gmail.com>
Tue, 18 Jul 2023 14:57:58 +0000 (22:57 +0800)
This further improves the documentation from commit
f36ca7982f6bd5e9827219ed4f3c5a1fbf5d7bdf. The previous wording of
"supported options" was slightly misleading since the options that are
printed are the ones that are relevant for encoding/decoding. It is not
about which options can or must be specified.

src/liblzma/api/lzma/filter.h

index 98b46df87afdb6c9178ca7bde3e4bad59cc17794..b38bc6ac9a6058bbd22cbc46236e671c87a0beec 100644 (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
  * filter name. If LZMA_STR_ENCODER or LZMA_STR_DECODER is used then the
- * supported options 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
  * are listed: