]> git.ipfire.org Git - thirdparty/xz.git/commitdiff
liblzma: Fix docs: lzma_block_decoder() cannot return LZMA_UNSUPPORTED_CHECK.
authorLasse Collin <lasse.collin@tukaani.org>
Sun, 6 Mar 2022 14:54:23 +0000 (16:54 +0200)
committerLasse Collin <lasse.collin@tukaani.org>
Sun, 6 Mar 2022 14:54:23 +0000 (16:54 +0200)
If Check is unsupported, it will be silently ignored.
It's the caller's job to handle it.

src/liblzma/api/lzma/block.h

index 962f38779cc7052f73a70fbe8fde5426cd077afb..082e55833e70c6af093c3e1e9e1f7b9f64bf15af 100644 (file)
@@ -464,9 +464,6 @@ extern LZMA_API(lzma_ret) lzma_block_encoder(
  * LZMA_FINISH is not required. It is supported only for convenience.
  *
  * \return      - LZMA_OK: All good, continue with lzma_code().
- *              - LZMA_UNSUPPORTED_CHECK: Initialization was successful, but
- *                the given Check ID is not supported, thus Check will be
- *                ignored.
  *              - LZMA_PROG_ERROR
  *              - LZMA_MEM_ERROR
  */