5.4.6 (2024-01-26)

    * Fixed a bug involving internal function pointers in liblzma not
      being initialized to NULL. The bug can only be triggered if
      lzma_filters_update() is called on a LZMA1 encoder, so it does
      not affect xz or any application known to us that uses liblzma.

    * xz:

        - Fixed a regression introduced in 5.4.2 that caused encoding
          in the raw format to unnecessarily fail if --suffix was not
          used. For instance, the following command no longer reports
          that --suffix must be used:

              echo foo | xz --format=raw --lzma2 | wc -c

        - Fixed an issue on MinGW-w64 builds that prevented reading
          from or writing to non-terminal character devices like NUL.

    * Added a new test.

5.4.5 (2023-11-01)

    * liblzma:

        - Use __attribute__((__no_sanitize_address__)) to avoid address
          sanitization with CRC64 CLMUL. It uses 16-byte-aligned reads
          which can extend past the bounds of the input buffer and
          inherently trigger address sanitization errors. This isn't
          a bug.

        - Fixed an assertion failure that could be triggered by a large
          unpadded_size argument. It was verified that there was no
          other bug than the assertion failure.

        - Fixed a bug that prevented building with Windows Vista
          threading when __attribute__((__constructor__)) is not
          supported.

    * xz now properly handles special files such as "con" or "nul" on
      Windows. Before this fix, the following wrote "foo" to the
      console and deleted the input file "con_xz":

          echo foo | xz > con_xz
          xz --suffix=_xz --decompress con_xz

    * Build systems:

        - Allow builds with Windows win95 threading and small mode when
          __attribute__((__constructor__)) is supported.

        - Added a new line to liblzma.pc for MSYS2 (Windows):

              Cflags.private: -DLZMA_API_STATIC

          When compiling code that will link against static liblzma,
          the LZMA_API_STATIC macro needs to be defined on Windows.

        - CMake specific changes:

            * Fixed a bug that allowed CLOCK_MONOTONIC to be used even
              if the check for it failed.

            * Fixed a bug where configuring CMake multiple times
              resulted in HAVE_CLOCK_GETTIME and HAVE_CLOCK_MONOTONIC
              not being set.

            * Fixed the build with MinGW-w64-based Clang/LLVM 17.
              llvm-windres now has more accurate GNU windres emulation
              so the GNU windres workaround from 5.4.1 is needed with
              llvm-windres version 17 too.

            * The import library on Windows is now properly named
              "liblzma.dll.a" instead of "libliblzma.dll.a"

            * Fixed a bug causing the Ninja Generator to fail on
              UNIX-like systems. This bug was introduced in 5.4.0.

            * Added a new option to disable CLMUL CRC64.

            * A module-definition (.def) file is now created when
              building liblzma.dll with MinGW-w64.

            * The pkg-config liblzma.pc file is now installed on all
              builds except when using MSVC on Windows.

            * Added large file support by default for platforms that
              need it to handle files larger than 2 GiB. This includes
              MinGW-w64, even 64-bit builds.

    * Small fixes and improvements to the tests.

    * Updated translations: Chinese (simplified) and Esperanto.

5.4.4 (2023-08-02)

    * liblzma and xzdec can now build against WASI SDK when threading
      support is disabled. xz and tests don't build yet.

    * CMake:

        - Fixed a bug preventing other projects from including liblzma
          multiple times using find_package().

        - Don't create broken symlinks in Cygwin and MSYS2 unless
          supported by the environment. This prevented building for the
          default MSYS2 environment. The problem was introduced in
          xz 5.4.0.

    * Documentation:

        - Small improvements to man pages.

        - Small improvements and typo fixes for liblzma API
          documentation.

    * Tests:

        - Added a new section to INSTALL to describe basic test usage
          and address recent questions about building the tests when
          cross compiling.

        - Small fixes and improvements to the tests.

    * Translations:

        - Fixed a mistake that caused one of the error messages to not
          be translated. This only affected versions 5.4.2 and 5.4.3.

        - Updated the Chinese (simplified), Croatian, Esperanto, German,
          Korean, Polish, Romanian, Spanish, Swedish, Ukrainian, and
          Vietnamese translations.

        - Updated the German, Korean, Romanian, and Ukrainian man page
          translations.

5.4.3 (2023-05-04)

    * All fixes from 5.2.12

    * Features in the CMake build can now be disabled as CMake cache
      variables, similar to the Autotools build.

    * Minor update to the Croatian translation.

5.2.12 (2023-05-04)

    * Fixed a build system bug that prevented building liblzma as a
      shared library when configured with --disable-threads. This bug
      affected releases 5.2.6 to 5.2.11 and 5.4.0 to 5.4.2.

    * Include <intrin.h> for Windows intrinsic functions where they are
      needed. This fixed a bug that prevented building liblzma using
      clang-cl on Windows.

    * Minor update to the Croatian translation. The small change
      applies to a string in both 5.2 and 5.4 branches.

5.4.2 (2023-03-18)

    * All fixes from 5.2.11 that were not included in 5.4.1.

    * If xz is built with support for the Capsicum sandbox but running
      in an environment that doesn't support Capsicum, xz now runs
      normally without sandboxing instead of exiting with an error.

    * liblzma:

        - Documentation was updated to improve the style, consistency,
          and completeness of the liblzma API headers.

        - The Doxygen-generated HTML documentation for the liblzma API
          header files is now included in the source release and is
          installed as part of "make install". All JavaScript is
          removed to simplify license compliance and to reduce the
          install size.

        - Fixed a minor bug in lzma_str_from_filters() that produced
          too many filters in the output string instead of reporting
          an error if the input array had more than four filters. This
          bug did not affect xz.

    * Build systems:

        - autogen.sh now invokes the doxygen tool via the new wrapper
          script doxygen/update-doxygen, unless the command line option
          --no-doxygen is used.

        - Added microlzma_encoder.c and microlzma_decoder.c to the
          VS project files for Windows and to the CMake build. These
          should have been included in 5.3.2alpha.

    * Tests:

        - Added a test to the CMake build that was forgotten in the
          previous release.

        - Added and refactored a few tests.

    * Translations:

        - Updated the Brazilian Portuguese translation.

        - Added Brazilian Portuguese man page translation.

5.2.11 (2023-03-18)

    * Removed all possible cases of null pointer + 0. It is undefined
      behavior in C99 and C17. This was detected by a sanitizer and had
      not caused any known issues.

    * Build systems:

        - Added a workaround for building with GCC on MicroBlaze Linux.
          GCC 12 on MicroBlaze doesn't support the __symver__ attribute
          even though __has_attribute(__symver__) returns true. The
          build is now done without the extra RHEL/CentOS 7 symbols
          that were added in XZ Utils 5.2.7. The workaround only
          applies to the Autotools build (not CMake).

        - CMake: Ensure that the C compiler language is set to C99 or
          a newer standard.

        - CMake changes from XZ Utils 5.4.1:

            * Added a workaround for a build failure with
              windres from GNU binutils.

            * Included the Windows resource files in the xz
              and xzdec build rules.

5.4.1 (2023-01-11)

    * liblzma:

        - Fixed the return value of lzma_microlzma_encoder() if the
          LZMA options lc/lp/pb are invalid. Invalid lc/lp/pb options
          made the function return LZMA_STREAM_END without encoding
          anything instead of returning LZMA_OPTIONS_ERROR.

        - Windows / Visual Studio: Workaround a possible compiler bug
          when targeting 32-bit x86 and compiling the CLMUL version of
          the CRC64 code. The CLMUL code isn't enabled by the Windows
          project files but it is in the CMake-based builds.

    * Build systems:

        - Windows-specific CMake changes:

            * Don't try to enable CLMUL CRC64 code if _mm_set_epi64x()
              isn't available. This fixes CMake-based build with Visual
              Studio 2013.

            * Created a workaround for a build failure with windres
              from GNU binutils. It is used only when the C compiler
              is GCC (not Clang). The workaround is incompatible
              with llvm-windres, resulting in "XZx20Utils" instead
              of "XZ Utils" in the resource file, but without the
              workaround llvm-windres works correctly. See the
              comment in CMakeLists.txt for details.

            * Included the resource files in the xz and xzdec build
              rules. Building the command line tools is still
              experimental but possible with MinGW-w64.

        - Visual Studio: Added stream_decoder_mt.c to the project
          files. Now the threaded decompressor lzma_stream_decoder_mt()
          gets built. CMake-based build wasn't affected.

        - Updated windows/INSTALL-MSVC.txt to mention that CMake-based
          build is now the preferred method with Visual Studio. The
          project files will probably be removed after 5.4.x releases.

        - Changes to #defines in config.h:

            * HAVE_DECL_CLOCK_MONOTONIC was replaced by
              HAVE_CLOCK_MONOTONIC. The old macro was always defined
              in configure-generated config.h to either 0 or 1. The
              new macro is defined (to 1) only if the declaration of
              CLOCK_MONOTONIC is available. This matches the way most
              other config.h macros work and makes things simpler with
              other build systems.

            * HAVE_DECL_PROGRAM_INVOCATION_NAME was replaced by
              HAVE_PROGRAM_INVOCATION_NAME for the same reason.

    * Tests:

        - Fixed test script compatibility with ancient /bin/sh
          versions. Now the five test_compress_* tests should
          no longer fail on Solaris 10.

        - Added and refactored a few tests.

    * Translations:

        - Updated the Catalan and Esperanto translations.

        - Added Korean and Ukrainian man page translations.

This bumps the minor version of liblzma because new features were
added. The API and ABI are still backward compatible with liblzma
5.2.x and 5.0.x.

Since 5.3.5beta:

* All fixes from 5.2.10.

* The ARM64 filter is now stable. The xz option is now --arm64.
  Decompression requires XZ Utils 5.4.0. In the future the ARM64
  filter will be supported by XZ for Java, XZ Embedded (including
  the version in Linux), LZMA SDK, and 7-Zip.

* Translations:

    - Updated Catalan, Croatian, German, Romanian, and Turkish
      translations.

    - Updated German man page translations.

    - Added Romanian man page translations.

Summary of new features added in the 5.3.x development releases:

* liblzma:

    - Added threaded .xz decompressor lzma_stream_decoder_mt().
      It can use multiple threads with .xz files that have multiple
      Blocks with size information in Block Headers. The threaded
      encoder in xz has always created such files.

      Single-threaded encoder cannot store the size information in
      Block Headers even if one used LZMA_FULL_FLUSH to create
      multiple Blocks, so this threaded decoder cannot use multiple
      threads with such files.

      If there are multiple Streams (concatenated .xz files), one
      Stream will be decompressed completely before starting the
      next Stream.

    - A new decoder flag LZMA_FAIL_FAST was added. It makes the
      threaded decompressor report errors soon instead of first
      flushing all pending data before the error location.

    - New Filter IDs:
        * LZMA_FILTER_ARM64 is for ARM64 binaries.
        * LZMA_FILTER_LZMA1EXT is for raw LZMA1 streams that don't
          necessarily use the end marker.

    - Added lzma_str_to_filters(), lzma_str_from_filters(), and
      lzma_str_list_filters() to convert a preset or a filter chain
      string to a lzma_filter[] and vice versa. These should make
      it easier to write applications that allow users to specify
      custom compression options.

    - Added lzma_filters_free() which can be convenient for freeing
      the filter options in a filter chain (an array of lzma_filter
      structures).

    - lzma_file_info_decoder() to makes it a little easier to get
      the Index field from .xz files. This helps in getting the
      uncompressed file size but an easy-to-use random access
      API is still missing which has existed in XZ for Java for
      a long time.

    - Added lzma_microlzma_encoder() and lzma_microlzma_decoder().
      It is used by erofs-utils and may be used by others too.

      The MicroLZMA format is a raw LZMA stream (without end marker)
      whose first byte (always 0x00) has been replaced with
      bitwise-negation of the LZMA properties (lc/lp/pb). It was
      created for use in EROFS but may be used in other contexts
      as well where it is important to avoid wasting bytes for
      stream headers or footers. The format is also supported by
      XZ Embedded (the XZ Embedded version in Linux got MicroLZMA
      support in Linux 5.16).

      The MicroLZMA encoder API in liblzma can compress into a
      fixed-sized output buffer so that as much data is compressed
      as can be fit into the buffer while still creating a valid
      MicroLZMA stream. This is needed for EROFS.

    - Added lzma_lzip_decoder() to decompress the .lz (lzip) file
      format version 0 and the original unextended version 1 files.
      Also lzma_auto_decoder() supports .lz files.

    - lzma_filters_update() can now be used with the multi-threaded
      encoder (lzma_stream_encoder_mt()) to change the filter chain
      after LZMA_FULL_BARRIER or LZMA_FULL_FLUSH.

    - In lzma_options_lzma, allow nice_len = 2 and 3 with the match
      finders that require at least 3 or 4. Now it is internally
      rounded up if needed.

    - CLMUL-based CRC64 on x86-64 and E2K with runtime processor
      detection. On 32-bit x86 it currently isn't available unless
      --disable-assembler is used which can make the non-CLMUL
      CRC64 slower; this might be fixed in the future.

    - Building with --disable-threads --enable-small
      is now thread-safe if the compiler supports
      __attribute__((__constructor__)).

* xz:

    - Using -T0 (--threads=0) will now use multi-threaded encoder
      even on a single-core system. This is to ensure that output
      from the same xz binary is identical on both single-core and
      multi-core systems.

    - --threads=+1 or -T+1 is now a way to put xz into
      multi-threaded mode while using only one worker thread.
      The + is ignored if the number is not 1.

    - A default soft memory usage limit is now used for compression
      when -T0 is used and no explicit limit has been specified.
      This soft limit is used to restrict the number of threads
      but if the limit is exceeded with even one thread then xz
      will continue with one thread using the multi-threaded
      encoder and this limit is ignored. If the number of threads
      is specified manually then no default limit will be used;
      this affects only -T0.

      This change helps on systems that have very many cores and
      using all of them for xz makes no sense. Previously xz -T0
      could run out of memory on such systems because it attempted
      to reserve memory for too many threads.

      This also helps with 32-bit builds which don't have a large
      amount of address space that would be required for many
      threads. The default soft limit for -T0 is at most 1400 MiB
      on all 32-bit platforms.

    - Previously a low value in --memlimit-compress wouldn't cause
      xz to switch from multi-threaded mode to single-threaded mode
      if the limit cannot otherwise be met; xz failed instead. Now
      xz can switch to single-threaded mode and then, if needed,
      scale down the LZMA2 dictionary size too just like it already
      did when it was started in single-threaded mode.

    - The option --no-adjust no longer prevents xz from scaling down
      the number of threads as that doesn't affect the compressed
      output (only performance). Now --no-adjust only prevents
      adjustments that affect compressed output, that is, with
      --no-adjust xz won't switch from multi-threaded mode to
      single-threaded mode and won't scale down the LZMA2
      dictionary size.

    - Added a new option --memlimit-mt-decompress=LIMIT. This is
      used to limit the number of decompressor threads (possibly
      falling back to single-threaded mode) but it will never make
      xz refuse to decompress a file. This has a system-specific
      default value because without any limit xz could end up
      allocating memory for the whole compressed input file, the
      whole uncompressed output file, multiple thread-specific
      decompressor instances and so on. Basically xz could
      attempt to use an insane amount of memory even with fairly
      common files. The system-specific default value is currently
      the same as the one used for compression with -T0.

      The new option works together with the existing option
      --memlimit-decompress=LIMIT. The old option sets a hard limit
      that must not be exceeded (xz will refuse to decompress)
      while the new option only restricts the number of threads.
      If the limit set with --memlimit-mt-decompress is greater
      than the limit set with --memlimit-compress, then the latter
      value is used also for --memlimit-mt-decompress.

    - Added new information to the output of xz --info-memory and
      new fields to the output of xz --robot --info-memory.

    - In --lzma2=nice=NUMBER allow 2 and 3 with all match finders
      now that liblzma handles it.

    - Don't mention endianness for ARM and ARM-Thumb filters in
      --long-help. The filters only work for little endian
      instruction encoding but modern ARM processors using
      big endian data access still use little endian
      instruction encoding. So the help text was misleading.
      In contrast, the PowerPC filter is only for big endian
      32/64-bit PowerPC code. Little endian PowerPC would need
      a separate filter.

    - Added decompression support for the .lz (lzip) file format
      version 0 and the original unextended version 1. It is
      autodetected by default. See also the option --format on
      the xz man page.

    - Sandboxing enabled by default:
        * Capsicum (FreeBSD)
        * pledge(2) (OpenBSD)

* Scripts now support the .lz format using xz.

* A few new tests were added.

* The liblzma-specific tests are now supported in CMake-based
  builds too ("make test").

* xz: Don't modify argv[] when parsing the --memlimit* and
  --block-list command line options. This fixes confusing
  arguments in process listing (like "ps auxf").

* GNU/Linux only: Use __has_attribute(__symver__) to detect if
  that attribute is supported. This fixes build on Mandriva where
  Clang is patched to define __GNUC__ to 11 by default (instead
  of 4 as used by Clang upstream).