NEWS

   1
   2 XZ Utils Release Notes
   3 ======================
   4
   5 5.1.1alpha (2011-04-12)
   6
   7     * All fixes from 5.0.2
   8
   9     * liblzma fixes that will also be included in 5.0.3:
  10
  11         - A memory leak was fixed.
  12
  13         - lzma_stream_buffer_encode() no longer creates an empty .xz
  14           Block if encoding an empty buffer. Such an empty Block with
  15           LZMA2 data would trigger a bug in 5.0.1 and older (see the
  16           first bullet point in 5.0.2 notes). When releasing 5.0.2,
  17           I thought that no encoder creates this kind of files but
  18           I was wrong.
  19
  20         - Validate function arguments better in a few functions. Most
  21           importantly, specifying an unsupported integrity check to
  22           lzma_stream_buffer_encode() no longer creates a corrupt .xz
  23           file. Probably no application tries to do that, so this
  24           shouldn't be a big problem in practice.
  25
  26         - Document that lzma_block_buffer_encode(),
  27           lzma_easy_buffer_encode(), lzma_stream_encoder(), and
  28           lzma_stream_buffer_encode() may return LZMA_UNSUPPORTED_CHECK.
  29
  30         - The return values of the _memusage() functions are now
  31           documented better.
  32
  33     * Support for multithreaded compression was added using the simplest
  34       method, which splits the input data into blocks and compresses
  35       them independently. Other methods will be added in the future.
  36       The current method has room for improvement, e.g. it is possible
  37       to reduce the memory usage.
  38
  39     * Added the options --single-stream and --block-size=SIZE to xz.
  40
  41     * xzdiff and xzgrep now support .lzo files if lzop is installed.
  42       The .tzo suffix is also recognized as a shorthand for .tar.lzo.
  43
  44     * Support for short 8.3 filenames under DOS was added to xz. It is
  45       experimental and may change before it gets into a stable release.
  46
  47
  48 5.0.3 (2011-05-21)
  49
  50     * liblzma fixes:
  51
  52         - A memory leak was fixed.
  53
  54         - lzma_stream_buffer_encode() no longer creates an empty .xz
  55           Block if encoding an empty buffer. Such an empty Block with
  56           LZMA2 data would trigger a bug in 5.0.1 and older (see the
  57           first bullet point in 5.0.2 notes). When releasing 5.0.2,
  58           I thought that no encoder creates this kind of files but
  59           I was wrong.
  60
  61         - Validate function arguments better in a few functions. Most
  62           importantly, specifying an unsupported integrity check to
  63           lzma_stream_buffer_encode() no longer creates a corrupt .xz
  64           file. Probably no application tries to do that, so this
  65           shouldn't be a big problem in practice.
  66
  67         - Document that lzma_block_buffer_encode(),
  68           lzma_easy_buffer_encode(), lzma_stream_encoder(), and
  69           lzma_stream_buffer_encode() may return LZMA_UNSUPPORTED_CHECK.
  70
  71         - The return values of the _memusage() functions are now
  72           documented better.
  73
  74     * Fix command name detection in xzgrep. xzegrep and xzfgrep now
  75       correctly use egrep and fgrep instead of grep.
  76
  77     * French translation was added.
  78
  79
  80 5.0.2 (2011-04-01)
  81
  82     * LZMA2 decompressor now correctly accepts LZMA2 streams with no
  83       uncompressed data. Previously it considered them corrupt. The
  84       bug can affect applications that use raw LZMA2 streams. It is
  85       very unlikely to affect .xz files because no compressor creates
  86       .xz files with empty LZMA2 streams. (Empty .xz files are a
  87       different thing than empty LZMA2 streams.)
  88
  89     * "xz --suffix=.foo filename.foo" now refuses to compress the
  90       file due to it already having the suffix .foo. It was already
  91       documented on the man page, but the code lacked the test.
  92
  93     * "xzgrep -l foo bar.xz" works now.
  94
  95     * Polish translation was added.
  96
  97
  98 5.0.1 (2011-01-29)
  99
 100     * xz --force now (de)compresses files that have setuid, setgid,
 101       or sticky bit set and files that have multiple hard links.
 102       The man page had it documented this way already, but the code
 103       had a bug.
 104
 105     * gzip and bzip2 support in xzdiff was fixed.
 106
 107     * Portability fixes
 108
 109     * Minor fix to Czech translation
 110
 111
 112 5.0.0 (2010-10-23)
 113
 114     Only the most important changes compared to 4.999.9beta are listed
 115     here. One change is especially important:
 116
 117       * The memory usage limit is now disabled by default. Some scripts
 118         written before this change may have used --memory=max on xz command
 119         line or in XZ_OPT. THESE USES OF --memory=max SHOULD BE REMOVED
 120         NOW, because they interfere with user's ability to set the memory
 121         usage limit himself. If user-specified limit causes problems to
 122         your script, blame the user.
 123
 124     Other significant changes:
 125
 126       * Added support for XZ_DEFAULTS environment variable. This variable
 127         allows users to set default options for xz, e.g. default memory
 128         usage limit or default compression level. Scripts that use xz
 129         must never set or unset XZ_DEFAULTS. Scripts should use XZ_OPT
 130         instead if they need a way to pass options to xz via an
 131         environment variable.
 132
 133       * The compression settings associated with the preset levels
 134         -0 ... -9 have been changed. --extreme was changed a little too.
 135         It is now less likely to make compression worse, but with some
 136         files the new --extreme may compress slightly worse than the old
 137         --extreme.
 138
 139       * If a preset level (-0 ... -9) is specified after a custom filter
 140         chain options have been used (e.g. --lzma2), the custom filter
 141         chain will be forgotten. Earlier the preset options were
 142         completely ignored after custom filter chain options had been
 143         seen.
 144
 145       * xz will create sparse files when decompressing if the uncompressed
 146         data contains long sequences of binary zeros. This is done even
 147         when writing to standard output that is connected to a regular
 148         file and certain additional conditions are met to make it safe.
 149
 150       * Support for "xz --list" was added. Combine with --verbose or
 151         --verbose --verbose (-vv) for detailed output.
 152
 153       * I had hoped that liblzma API would have been stable after
 154         4.999.9beta, but there have been a couple of changes in the
 155         advanced features, which don't affect most applications:
 156
 157           - Index handling code was revised. If you were using the old
 158             API, you will get a compiler error (so it's easy to notice).
 159
 160           - A subtle but important change was made to the Block handling
 161             API. lzma_block.version has to be initialized even for
 162             lzma_block_header_decode(). Code that doesn't do it will work
 163             for now, but might break in the future, which makes this API
 164             change easy to miss.
 165
 166       * The major soname has been bumped to 5.0.0. liblzma API and ABI
 167         are now stable, so the need to recompile programs linking against
 168         liblzma shouldn't arise soon.
 169