NEWS

   1
   2 XZ Utils Release Notes
   3 ======================
   4
   5 5.0.6 (2014-09-14)
   6
   7     * xzgrep now exits with status 0 if at least one file matched.
   8
   9     * A few minor portability and build system fixes
  10
  11
  12 5.0.5 (2013-06-30)
  13
  14     * lzmadec and liblzma's lzma_alone_decoder(): Support decompressing
  15       .lzma files that have less common settings in the headers
  16       (dictionary size other than 2^n or 2^n + 2^(n-1), or uncompressed
  17       size greater than 256 GiB). The limitations existed to avoid false
  18       positives when detecting .lzma files. The lc + lp <= 4 limitation
  19       still remains since liblzma's LZMA decoder has that limitation.
  20
  21       NOTE: xz's .lzma support or liblzma's lzma_auto_decoder() are NOT
  22       affected by this change. They still consider uncommon .lzma headers
  23       as not being in the .lzma format. Changing this would give way too
  24       many false positives.
  25
  26     * xz:
  27
  28         - Interaction of preset and custom filter chain options was
  29           made less illogical. This affects only certain less typical
  30           uses cases so few people are expected to notice this change.
  31
  32           Now when a custom filter chain option (e.g. --lzma2) is
  33           specified, all preset options (-0 ... -9, -e) earlier are on
  34           the command line are completely forgotten. Similarly, when
  35           a preset option is specified, all custom filter chain options
  36           earlier on the command line are completely forgotten.
  37
  38           Example 1: "xz -9 --lzma2=preset=5 -e" is equivalent to "xz -e"
  39           which is equivalent to "xz -6e". Earlier -e didn't put xz back
  40           into preset mode and thus the example command was equivalent
  41           to "xz --lzma2=preset=5".
  42
  43           Example 2: "xz -9e --lzma2=preset=5 -7" is equivalent to
  44           "xz -7". Earlier a custom filter chain option didn't make
  45           xz forget the -e option so the example was equivalent to
  46           "xz -7e".
  47
  48         - Fixes and improvements to error handling.
  49
  50         - Various fixes to the man page.
  51
  52     * xzless: Fixed to work with "less" versions 448 and later.
  53
  54     * xzgrep: Made -h an alias for --no-filename.
  55
  56     * Include the previously missing debug/translation.bash which can
  57       be useful for translators.
  58
  59     * Include a build script for Mac OS X. This has been in the Git
  60       repository since 2010 but due to a mistake in Makefile.am the
  61       script hasn't been included in a release tarball before.
  62
  63
  64 5.0.4 (2012-06-22)
  65
  66     * liblzma:
  67
  68         - Fix lzma_index_init(). It could crash if memory allocation
  69           failed.
  70
  71         - Fix the possibility of an incorrect LZMA_BUF_ERROR when a BCJ
  72           filter is used and the application only provides exactly as
  73           much output space as is the uncompressed size of the file.
  74
  75         - Fix a bug in doc/examples_old/xz_pipe_decompress.c. It didn't
  76           check if the last call to lzma_code() really returned
  77           LZMA_STREAM_END, which made the program think that truncated
  78           files are valid.
  79
  80         - New example programs in doc/examples (old programs are now in
  81           doc/examples_old). These have more comments and more detailed
  82           error handling.
  83
  84     * Fix "xz -lvv foo.xz". It could crash on some corrupted files.
  85
  86     * Fix output of "xz --robot -lv" and "xz --robot -lvv" which
  87       incorrectly printed the filename also in the "foo (x/x)" format.
  88
  89     * Fix exit status of "xzdiff foo.xz bar.xz".
  90
  91     * Fix exit status of "xzgrep foo binary_file".
  92
  93     * Fix portability to EBCDIC systems.
  94
  95     * Fix a configure issue on AIX with the XL C compiler. See INSTALL
  96       for details.
  97
  98     * Update French, German, Italian, and Polish translations.
  99
 100
 101 5.0.3 (2011-05-21)
 102
 103     * liblzma fixes:
 104
 105         - A memory leak was fixed.
 106
 107         - lzma_stream_buffer_encode() no longer creates an empty .xz
 108           Block if encoding an empty buffer. Such an empty Block with
 109           LZMA2 data would trigger a bug in 5.0.1 and older (see the
 110           first bullet point in 5.0.2 notes). When releasing 5.0.2,
 111           I thought that no encoder creates this kind of files but
 112           I was wrong.
 113
 114         - Validate function arguments better in a few functions. Most
 115           importantly, specifying an unsupported integrity check to
 116           lzma_stream_buffer_encode() no longer creates a corrupt .xz
 117           file. Probably no application tries to do that, so this
 118           shouldn't be a big problem in practice.
 119
 120         - Document that lzma_block_buffer_encode(),
 121           lzma_easy_buffer_encode(), lzma_stream_encoder(), and
 122           lzma_stream_buffer_encode() may return LZMA_UNSUPPORTED_CHECK.
 123
 124         - The return values of the _memusage() functions are now
 125           documented better.
 126
 127     * Fix command name detection in xzgrep. xzegrep and xzfgrep now
 128       correctly use egrep and fgrep instead of grep.
 129
 130     * French translation was added.
 131
 132
 133 5.0.2 (2011-04-01)
 134
 135     * LZMA2 decompressor now correctly accepts LZMA2 streams with no
 136       uncompressed data. Previously it considered them corrupt. The
 137       bug can affect applications that use raw LZMA2 streams. It is
 138       very unlikely to affect .xz files because no compressor creates
 139       .xz files with empty LZMA2 streams. (Empty .xz files are a
 140       different thing than empty LZMA2 streams.)
 141
 142     * "xz --suffix=.foo filename.foo" now refuses to compress the
 143       file due to it already having the suffix .foo. It was already
 144       documented on the man page, but the code lacked the test.
 145
 146     * "xzgrep -l foo bar.xz" works now.
 147
 148     * Polish translation was added.
 149
 150
 151 5.0.1 (2011-01-29)
 152
 153     * xz --force now (de)compresses files that have setuid, setgid,
 154       or sticky bit set and files that have multiple hard links.
 155       The man page had it documented this way already, but the code
 156       had a bug.
 157
 158     * gzip and bzip2 support in xzdiff was fixed.
 159
 160     * Portability fixes
 161
 162     * Minor fix to Czech translation
 163
 164
 165 5.0.0 (2010-10-23)
 166
 167     Only the most important changes compared to 4.999.9beta are listed
 168     here. One change is especially important:
 169
 170       * The memory usage limit is now disabled by default. Some scripts
 171         written before this change may have used --memory=max on xz command
 172         line or in XZ_OPT. THESE USES OF --memory=max SHOULD BE REMOVED
 173         NOW, because they interfere with user's ability to set the memory
 174         usage limit himself. If user-specified limit causes problems to
 175         your script, blame the user.
 176
 177     Other significant changes:
 178
 179       * Added support for XZ_DEFAULTS environment variable. This variable
 180         allows users to set default options for xz, e.g. default memory
 181         usage limit or default compression level. Scripts that use xz
 182         must never set or unset XZ_DEFAULTS. Scripts should use XZ_OPT
 183         instead if they need a way to pass options to xz via an
 184         environment variable.
 185
 186       * The compression settings associated with the preset levels
 187         -0 ... -9 have been changed. --extreme was changed a little too.
 188         It is now less likely to make compression worse, but with some
 189         files the new --extreme may compress slightly worse than the old
 190         --extreme.
 191
 192       * If a preset level (-0 ... -9) is specified after a custom filter
 193         chain options have been used (e.g. --lzma2), the custom filter
 194         chain will be forgotten. Earlier the preset options were
 195         completely ignored after custom filter chain options had been
 196         seen.
 197
 198       * xz will create sparse files when decompressing if the uncompressed
 199         data contains long sequences of binary zeros. This is done even
 200         when writing to standard output that is connected to a regular
 201         file and certain additional conditions are met to make it safe.
 202
 203       * Support for "xz --list" was added. Combine with --verbose or
 204         --verbose --verbose (-vv) for detailed output.
 205
 206       * I had hoped that liblzma API would have been stable after
 207         4.999.9beta, but there have been a couple of changes in the
 208         advanced features, which don't affect most applications:
 209
 210           - Index handling code was revised. If you were using the old
 211             API, you will get a compiler error (so it's easy to notice).
 212
 213           - A subtle but important change was made to the Block handling
 214             API. lzma_block.version has to be initialized even for
 215             lzma_block_header_decode(). Code that doesn't do it will work
 216             for now, but might break in the future, which makes this API
 217             change easy to miss.
 218
 219       * The major soname has been bumped to 5.0.0. liblzma API and ABI
 220         are now stable, so the need to recompile programs linking against
 221         liblzma shouldn't arise soon.
 222