From dd006a67e593cb5d3dec5180face7e3010fe78da Mon Sep 17 00:00:00 2001 From: Lasse Collin Date: Thu, 17 Apr 2025 18:30:26 +0300 Subject: [PATCH] liblzma: Update the lzma_lzip_decoder() docs about sync flush marker --- src/liblzma/api/lzma/container.h | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/src/liblzma/api/lzma/container.h b/src/liblzma/api/lzma/container.h index dbd414cb..a5beaf54 100644 --- a/src/liblzma/api/lzma/container.h +++ b/src/liblzma/api/lzma/container.h @@ -843,8 +843,7 @@ extern LZMA_API(lzma_ret) lzma_alone_decoder( /** * \brief Initialize .lz (lzip) decoder (a foreign file format) * - * This decoder supports the .lz format version 0 and the unextended .lz - * format version 1: + * This decoder supports the .lz format versions 0 and 1: * * - Files in the format version 0 were produced by lzip 1.3 and older. * Such files aren't common but may be found from file archives @@ -853,12 +852,12 @@ extern LZMA_API(lzma_ret) lzma_alone_decoder( * support for the format version 0 was removed in lzip 1.18. * * - lzip 1.3 added decompression support for .lz format version 1 files. - * Compression support was added in lzip 1.4. In lzip 1.6 the .lz format - * version 1 was extended to support the Sync Flush marker. This extension - * is not supported by liblzma. lzma_code() will return LZMA_DATA_ERROR - * at the location of the Sync Flush marker. In practice files with - * the Sync Flush marker are very rare and thus liblzma can decompress - * almost all .lz files. + * Compression support was added in lzip 1.4. + * + * - lzlib extends version 1 format with the Sync Flush marker. This + * extension is only meant for lzlib use; it's not valid in normal .lz + * files. This extension is not supported by liblzma. lzma_code() will + * return LZMA_DATA_ERROR at the location of the Sync Flush marker. * * Just like with lzma_stream_decoder() for .xz files, LZMA_CONCATENATED * should be used when decompressing normal standalone .lz files.