NEWS 71 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820
  1. XZ Utils Release Notes
  2. ======================
  3. 5.4.6 (2024-01-26)
  4. * Fixed a bug involving internal function pointers in liblzma not
  5. being initialized to NULL. The bug can only be triggered if
  6. lzma_filters_update() is called on a LZMA1 encoder, so it does
  7. not affect xz or any application known to us that uses liblzma.
  8. * xz:
  9. - Fixed a regression introduced in 5.4.2 that caused encoding
  10. in the raw format to unnecessarily fail if --suffix was not
  11. used. For instance, the following command no longer reports
  12. that --suffix must be used:
  13. echo foo | xz --format=raw --lzma2 | wc -c
  14. - Fixed an issue on MinGW-w64 builds that prevented reading
  15. from or writing to non-terminal character devices like NUL.
  16. * Added a new test.
  17. 5.4.5 (2023-11-01)
  18. * liblzma:
  19. - Use __attribute__((__no_sanitize_address__)) to avoid address
  20. sanitization with CRC64 CLMUL. It uses 16-byte-aligned reads
  21. which can extend past the bounds of the input buffer and
  22. inherently trigger address sanitization errors. This isn't
  23. a bug.
  24. - Fixed an assertion failure that could be triggered by a large
  25. unpadded_size argument. It was verified that there was no
  26. other bug than the assertion failure.
  27. - Fixed a bug that prevented building with Windows Vista
  28. threading when __attribute__((__constructor__)) is not
  29. supported.
  30. * xz now properly handles special files such as "con" or "nul" on
  31. Windows. Before this fix, the following wrote "foo" to the
  32. console and deleted the input file "con_xz":
  33. echo foo | xz > con_xz
  34. xz --suffix=_xz --decompress con_xz
  35. * Build systems:
  36. - Allow builds with Windows win95 threading and small mode when
  37. __attribute__((__constructor__)) is supported.
  38. - Added a new line to liblzma.pc for MSYS2 (Windows):
  39. Cflags.private: -DLZMA_API_STATIC
  40. When compiling code that will link against static liblzma,
  41. the LZMA_API_STATIC macro needs to be defined on Windows.
  42. - CMake specific changes:
  43. * Fixed a bug that allowed CLOCK_MONOTONIC to be used even
  44. if the check for it failed.
  45. * Fixed a bug where configuring CMake multiple times
  46. resulted in HAVE_CLOCK_GETTIME and HAVE_CLOCK_MONOTONIC
  47. not being set.
  48. * Fixed the build with MinGW-w64-based Clang/LLVM 17.
  49. llvm-windres now has more accurate GNU windres emulation
  50. so the GNU windres workaround from 5.4.1 is needed with
  51. llvm-windres version 17 too.
  52. * The import library on Windows is now properly named
  53. "liblzma.dll.a" instead of "libliblzma.dll.a"
  54. * Fixed a bug causing the Ninja Generator to fail on
  55. UNIX-like systems. This bug was introduced in 5.4.0.
  56. * Added a new option to disable CLMUL CRC64.
  57. * A module-definition (.def) file is now created when
  58. building liblzma.dll with MinGW-w64.
  59. * The pkg-config liblzma.pc file is now installed on all
  60. builds except when using MSVC on Windows.
  61. * Added large file support by default for platforms that
  62. need it to handle files larger than 2 GiB. This includes
  63. MinGW-w64, even 64-bit builds.
  64. * Small fixes and improvements to the tests.
  65. * Updated translations: Chinese (simplified) and Esperanto.
  66. 5.4.4 (2023-08-02)
  67. * liblzma and xzdec can now build against WASI SDK when threading
  68. support is disabled. xz and tests don't build yet.
  69. * CMake:
  70. - Fixed a bug preventing other projects from including liblzma
  71. multiple times using find_package().
  72. - Don't create broken symlinks in Cygwin and MSYS2 unless
  73. supported by the environment. This prevented building for the
  74. default MSYS2 environment. The problem was introduced in
  75. xz 5.4.0.
  76. * Documentation:
  77. - Small improvements to man pages.
  78. - Small improvements and typo fixes for liblzma API
  79. documentation.
  80. * Tests:
  81. - Added a new section to INSTALL to describe basic test usage
  82. and address recent questions about building the tests when
  83. cross compiling.
  84. - Small fixes and improvements to the tests.
  85. * Translations:
  86. - Fixed a mistake that caused one of the error messages to not
  87. be translated. This only affected versions 5.4.2 and 5.4.3.
  88. - Updated the Chinese (simplified), Croatian, Esperanto, German,
  89. Korean, Polish, Romanian, Spanish, Swedish, Ukrainian, and
  90. Vietnamese translations.
  91. - Updated the German, Korean, Romanian, and Ukrainian man page
  92. translations.
  93. 5.4.3 (2023-05-04)
  94. * All fixes from 5.2.12
  95. * Features in the CMake build can now be disabled as CMake cache
  96. variables, similar to the Autotools build.
  97. * Minor update to the Croatian translation.
  98. 5.4.2 (2023-03-18)
  99. * All fixes from 5.2.11 that were not included in 5.4.1.
  100. * If xz is built with support for the Capsicum sandbox but running
  101. in an environment that doesn't support Capsicum, xz now runs
  102. normally without sandboxing instead of exiting with an error.
  103. * liblzma:
  104. - Documentation was updated to improve the style, consistency,
  105. and completeness of the liblzma API headers.
  106. - The Doxygen-generated HTML documentation for the liblzma API
  107. header files is now included in the source release and is
  108. installed as part of "make install". All JavaScript is
  109. removed to simplify license compliance and to reduce the
  110. install size.
  111. - Fixed a minor bug in lzma_str_from_filters() that produced
  112. too many filters in the output string instead of reporting
  113. an error if the input array had more than four filters. This
  114. bug did not affect xz.
  115. * Build systems:
  116. - autogen.sh now invokes the doxygen tool via the new wrapper
  117. script doxygen/update-doxygen, unless the command line option
  118. --no-doxygen is used.
  119. - Added microlzma_encoder.c and microlzma_decoder.c to the
  120. VS project files for Windows and to the CMake build. These
  121. should have been included in 5.3.2alpha.
  122. * Tests:
  123. - Added a test to the CMake build that was forgotten in the
  124. previous release.
  125. - Added and refactored a few tests.
  126. * Translations:
  127. - Updated the Brazilian Portuguese translation.
  128. - Added Brazilian Portuguese man page translation.
  129. 5.4.1 (2023-01-11)
  130. * liblzma:
  131. - Fixed the return value of lzma_microlzma_encoder() if the
  132. LZMA options lc/lp/pb are invalid. Invalid lc/lp/pb options
  133. made the function return LZMA_STREAM_END without encoding
  134. anything instead of returning LZMA_OPTIONS_ERROR.
  135. - Windows / Visual Studio: Workaround a possible compiler bug
  136. when targeting 32-bit x86 and compiling the CLMUL version of
  137. the CRC64 code. The CLMUL code isn't enabled by the Windows
  138. project files but it is in the CMake-based builds.
  139. * Build systems:
  140. - Windows-specific CMake changes:
  141. * Don't try to enable CLMUL CRC64 code if _mm_set_epi64x()
  142. isn't available. This fixes CMake-based build with Visual
  143. Studio 2013.
  144. * Created a workaround for a build failure with windres
  145. from GNU binutils. It is used only when the C compiler
  146. is GCC (not Clang). The workaround is incompatible
  147. with llvm-windres, resulting in "XZx20Utils" instead
  148. of "XZ Utils" in the resource file, but without the
  149. workaround llvm-windres works correctly. See the
  150. comment in CMakeLists.txt for details.
  151. * Included the resource files in the xz and xzdec build
  152. rules. Building the command line tools is still
  153. experimental but possible with MinGW-w64.
  154. - Visual Studio: Added stream_decoder_mt.c to the project
  155. files. Now the threaded decompressor lzma_stream_decoder_mt()
  156. gets built. CMake-based build wasn't affected.
  157. - Updated windows/INSTALL-MSVC.txt to mention that CMake-based
  158. build is now the preferred method with Visual Studio. The
  159. project files will probably be removed after 5.4.x releases.
  160. - Changes to #defines in config.h:
  161. * HAVE_DECL_CLOCK_MONOTONIC was replaced by
  162. HAVE_CLOCK_MONOTONIC. The old macro was always defined
  163. in configure-generated config.h to either 0 or 1. The
  164. new macro is defined (to 1) only if the declaration of
  165. CLOCK_MONOTONIC is available. This matches the way most
  166. other config.h macros work and makes things simpler with
  167. other build systems.
  168. * HAVE_DECL_PROGRAM_INVOCATION_NAME was replaced by
  169. HAVE_PROGRAM_INVOCATION_NAME for the same reason.
  170. * Tests:
  171. - Fixed test script compatibility with ancient /bin/sh
  172. versions. Now the five test_compress_* tests should
  173. no longer fail on Solaris 10.
  174. - Added and refactored a few tests.
  175. * Translations:
  176. - Updated the Catalan and Esperanto translations.
  177. - Added Korean and Ukrainian man page translations.
  178. 5.4.0 (2022-12-13)
  179. This bumps the minor version of liblzma because new features were
  180. added. The API and ABI are still backward compatible with liblzma
  181. 5.2.x and 5.0.x.
  182. Since 5.3.5beta:
  183. * All fixes from 5.2.10.
  184. * The ARM64 filter is now stable. The xz option is now --arm64.
  185. Decompression requires XZ Utils 5.4.0. In the future the ARM64
  186. filter will be supported by XZ for Java, XZ Embedded (including
  187. the version in Linux), LZMA SDK, and 7-Zip.
  188. * Translations:
  189. - Updated Catalan, Croatian, German, Romanian, and Turkish
  190. translations.
  191. - Updated German man page translations.
  192. - Added Romanian man page translations.
  193. Summary of new features added in the 5.3.x development releases:
  194. * liblzma:
  195. - Added threaded .xz decompressor lzma_stream_decoder_mt().
  196. It can use multiple threads with .xz files that have multiple
  197. Blocks with size information in Block Headers. The threaded
  198. encoder in xz has always created such files.
  199. Single-threaded encoder cannot store the size information in
  200. Block Headers even if one used LZMA_FULL_FLUSH to create
  201. multiple Blocks, so this threaded decoder cannot use multiple
  202. threads with such files.
  203. If there are multiple Streams (concatenated .xz files), one
  204. Stream will be decompressed completely before starting the
  205. next Stream.
  206. - A new decoder flag LZMA_FAIL_FAST was added. It makes the
  207. threaded decompressor report errors soon instead of first
  208. flushing all pending data before the error location.
  209. - New Filter IDs:
  210. * LZMA_FILTER_ARM64 is for ARM64 binaries.
  211. * LZMA_FILTER_LZMA1EXT is for raw LZMA1 streams that don't
  212. necessarily use the end marker.
  213. - Added lzma_str_to_filters(), lzma_str_from_filters(), and
  214. lzma_str_list_filters() to convert a preset or a filter chain
  215. string to a lzma_filter[] and vice versa. These should make
  216. it easier to write applications that allow users to specify
  217. custom compression options.
  218. - Added lzma_filters_free() which can be convenient for freeing
  219. the filter options in a filter chain (an array of lzma_filter
  220. structures).
  221. - lzma_file_info_decoder() to makes it a little easier to get
  222. the Index field from .xz files. This helps in getting the
  223. uncompressed file size but an easy-to-use random access
  224. API is still missing which has existed in XZ for Java for
  225. a long time.
  226. - Added lzma_microlzma_encoder() and lzma_microlzma_decoder().
  227. It is used by erofs-utils and may be used by others too.
  228. The MicroLZMA format is a raw LZMA stream (without end marker)
  229. whose first byte (always 0x00) has been replaced with
  230. bitwise-negation of the LZMA properties (lc/lp/pb). It was
  231. created for use in EROFS but may be used in other contexts
  232. as well where it is important to avoid wasting bytes for
  233. stream headers or footers. The format is also supported by
  234. XZ Embedded (the XZ Embedded version in Linux got MicroLZMA
  235. support in Linux 5.16).
  236. The MicroLZMA encoder API in liblzma can compress into a
  237. fixed-sized output buffer so that as much data is compressed
  238. as can be fit into the buffer while still creating a valid
  239. MicroLZMA stream. This is needed for EROFS.
  240. - Added lzma_lzip_decoder() to decompress the .lz (lzip) file
  241. format version 0 and the original unextended version 1 files.
  242. Also lzma_auto_decoder() supports .lz files.
  243. - lzma_filters_update() can now be used with the multi-threaded
  244. encoder (lzma_stream_encoder_mt()) to change the filter chain
  245. after LZMA_FULL_BARRIER or LZMA_FULL_FLUSH.
  246. - In lzma_options_lzma, allow nice_len = 2 and 3 with the match
  247. finders that require at least 3 or 4. Now it is internally
  248. rounded up if needed.
  249. - CLMUL-based CRC64 on x86-64 and E2K with runtime processor
  250. detection. On 32-bit x86 it currently isn't available unless
  251. --disable-assembler is used which can make the non-CLMUL
  252. CRC64 slower; this might be fixed in the future.
  253. - Building with --disable-threads --enable-small
  254. is now thread-safe if the compiler supports
  255. __attribute__((__constructor__)).
  256. * xz:
  257. - Using -T0 (--threads=0) will now use multi-threaded encoder
  258. even on a single-core system. This is to ensure that output
  259. from the same xz binary is identical on both single-core and
  260. multi-core systems.
  261. - --threads=+1 or -T+1 is now a way to put xz into
  262. multi-threaded mode while using only one worker thread.
  263. The + is ignored if the number is not 1.
  264. - A default soft memory usage limit is now used for compression
  265. when -T0 is used and no explicit limit has been specified.
  266. This soft limit is used to restrict the number of threads
  267. but if the limit is exceeded with even one thread then xz
  268. will continue with one thread using the multi-threaded
  269. encoder and this limit is ignored. If the number of threads
  270. is specified manually then no default limit will be used;
  271. this affects only -T0.
  272. This change helps on systems that have very many cores and
  273. using all of them for xz makes no sense. Previously xz -T0
  274. could run out of memory on such systems because it attempted
  275. to reserve memory for too many threads.
  276. This also helps with 32-bit builds which don't have a large
  277. amount of address space that would be required for many
  278. threads. The default soft limit for -T0 is at most 1400 MiB
  279. on all 32-bit platforms.
  280. - Previously a low value in --memlimit-compress wouldn't cause
  281. xz to switch from multi-threaded mode to single-threaded mode
  282. if the limit cannot otherwise be met; xz failed instead. Now
  283. xz can switch to single-threaded mode and then, if needed,
  284. scale down the LZMA2 dictionary size too just like it already
  285. did when it was started in single-threaded mode.
  286. - The option --no-adjust no longer prevents xz from scaling down
  287. the number of threads as that doesn't affect the compressed
  288. output (only performance). Now --no-adjust only prevents
  289. adjustments that affect compressed output, that is, with
  290. --no-adjust xz won't switch from multi-threaded mode to
  291. single-threaded mode and won't scale down the LZMA2
  292. dictionary size.
  293. - Added a new option --memlimit-mt-decompress=LIMIT. This is
  294. used to limit the number of decompressor threads (possibly
  295. falling back to single-threaded mode) but it will never make
  296. xz refuse to decompress a file. This has a system-specific
  297. default value because without any limit xz could end up
  298. allocating memory for the whole compressed input file, the
  299. whole uncompressed output file, multiple thread-specific
  300. decompressor instances and so on. Basically xz could
  301. attempt to use an insane amount of memory even with fairly
  302. common files. The system-specific default value is currently
  303. the same as the one used for compression with -T0.
  304. The new option works together with the existing option
  305. --memlimit-decompress=LIMIT. The old option sets a hard limit
  306. that must not be exceeded (xz will refuse to decompress)
  307. while the new option only restricts the number of threads.
  308. If the limit set with --memlimit-mt-decompress is greater
  309. than the limit set with --memlimit-compress, then the latter
  310. value is used also for --memlimit-mt-decompress.
  311. - Added new information to the output of xz --info-memory and
  312. new fields to the output of xz --robot --info-memory.
  313. - In --lzma2=nice=NUMBER allow 2 and 3 with all match finders
  314. now that liblzma handles it.
  315. - Don't mention endianness for ARM and ARM-Thumb filters in
  316. --long-help. The filters only work for little endian
  317. instruction encoding but modern ARM processors using
  318. big endian data access still use little endian
  319. instruction encoding. So the help text was misleading.
  320. In contrast, the PowerPC filter is only for big endian
  321. 32/64-bit PowerPC code. Little endian PowerPC would need
  322. a separate filter.
  323. - Added decompression support for the .lz (lzip) file format
  324. version 0 and the original unextended version 1. It is
  325. autodetected by default. See also the option --format on
  326. the xz man page.
  327. - Sandboxing enabled by default:
  328. * Capsicum (FreeBSD)
  329. * pledge(2) (OpenBSD)
  330. * Scripts now support the .lz format using xz.
  331. * A few new tests were added.
  332. * The liblzma-specific tests are now supported in CMake-based
  333. builds too ("make test").
  334. 5.3.5beta (2022-12-01)
  335. * All fixes from 5.2.9.
  336. * liblzma:
  337. - Added new LZMA_FILTER_LZMA1EXT for raw encoder and decoder to
  338. handle raw LZMA1 streams that don't have end of payload marker
  339. (EOPM) alias end of stream (EOS) marker. It can be used in
  340. filter chains, for example, with the x86 BCJ filter.
  341. - Added lzma_str_to_filters(), lzma_str_from_filters(), and
  342. lzma_str_list_filters() to make it easier for applications
  343. to get custom compression options from a user and convert
  344. it to an array of lzma_filter structures.
  345. - Added lzma_filters_free().
  346. - lzma_filters_update() can now be used with the multi-threaded
  347. encoder (lzma_stream_encoder_mt()) to change the filter chain
  348. after LZMA_FULL_BARRIER or LZMA_FULL_FLUSH.
  349. - In lzma_options_lzma, allow nice_len = 2 and 3 with the match
  350. finders that require at least 3 or 4. Now it is internally
  351. rounded up if needed.
  352. - ARM64 filter was modified. It is still experimental.
  353. - Fixed LTO build with Clang if -fgnuc-version=10 or similar
  354. was used to make Clang look like GCC >= 10. Now it uses
  355. __has_attribute(__symver__) which should be reliable.
  356. * xz:
  357. - --threads=+1 or -T+1 is now a way to put xz into multi-threaded
  358. mode while using only one worker thread.
  359. - In --lzma2=nice=NUMBER allow 2 and 3 with all match finders
  360. now that liblzma handles it.
  361. * Updated translations: Chinese (simplified), Korean, and Turkish.
  362. 5.3.4alpha (2022-11-15)
  363. * All fixes from 5.2.7 and 5.2.8.
  364. * liblzma:
  365. - Minor improvements to the threaded decoder.
  366. - Added CRC64 implementation that uses SSSE3, SSE4.1, and CLMUL
  367. instructions on 32/64-bit x86 and E2K. On 32-bit x86 it's
  368. not enabled unless --disable-assembler is used but then
  369. the non-CLMUL code might be slower. Processor support is
  370. detected at runtime so this is built by default on x86-64
  371. and E2K. On these platforms, if compiler flags indicate
  372. unconditional CLMUL support (-msse4.1 -mpclmul) then the
  373. generic version is not built, making liblzma 8-9 KiB smaller
  374. compared to having both versions included.
  375. With extremely compressible files this can make decompression
  376. up to twice as fast but with typical files 5 % improvement
  377. is a more realistic expectation.
  378. The CLMUL version is slower than the generic version with
  379. tiny inputs (especially at 1-8 bytes per call, but up to
  380. 16 bytes). In normal use in xz this doesn't matter at all.
  381. - Added an experimental ARM64 filter. This is *not* the final
  382. version! Files created with this experimental version won't
  383. be supported in the future versions! The filter design is
  384. a compromise where improving one use case makes some other
  385. cases worse.
  386. - Added decompression support for the .lz (lzip) file format
  387. version 0 and the original unextended version 1. See the
  388. API docs of lzma_lzip_decoder() for details. Also
  389. lzma_auto_decoder() supports .lz files.
  390. - Building with --disable-threads --enable-small
  391. is now thread-safe if the compiler supports
  392. __attribute__((__constructor__))
  393. * xz:
  394. - Added support for OpenBSD's pledge(2) as a sandboxing method.
  395. - Don't mention endianness for ARM and ARM-Thumb filters in
  396. --long-help. The filters only work for little endian
  397. instruction encoding but modern ARM processors using
  398. big endian data access still use little endian
  399. instruction encoding. So the help text was misleading.
  400. In contrast, the PowerPC filter is only for big endian
  401. 32/64-bit PowerPC code. Little endian PowerPC would need
  402. a separate filter.
  403. - Added --experimental-arm64. This will be renamed once the
  404. filter is finished. Files created with this experimental
  405. filter will not be supported in the future!
  406. - Added new fields to the output of xz --robot --info-memory.
  407. - Added decompression support for the .lz (lzip) file format
  408. version 0 and the original unextended version 1. It is
  409. autodetected by default. See also the option --format on
  410. the xz man page.
  411. * Scripts now support the .lz format using xz.
  412. * Build systems:
  413. - New #defines in config.h: HAVE_ENCODER_ARM64,
  414. HAVE_DECODER_ARM64, HAVE_LZIP_DECODER, HAVE_CPUID_H,
  415. HAVE_FUNC_ATTRIBUTE_CONSTRUCTOR, HAVE_USABLE_CLMUL
  416. - New configure options: --disable-clmul-crc,
  417. --disable-microlzma, --disable-lzip-decoder, and
  418. 'pledge' is now an option in --enable-sandbox (but
  419. it's autodetected by default anyway).
  420. - INSTALL was updated to document the new configure options.
  421. - PACKAGERS now lists also --disable-microlzma and
  422. --disable-lzip-decoder as configure options that must
  423. not be used in builds for non-embedded use.
  424. * Tests:
  425. - Fix some of the tests so that they skip instead of fail if
  426. certain features have been disabled with configure options.
  427. It's still not perfect.
  428. - Other improvements to tests.
  429. * Updated translations: Croatian, Finnish, Hungarian, Polish,
  430. Romanian, Spanish, Swedish, and Ukrainian.
  431. 5.3.3alpha (2022-08-22)
  432. * All fixes from 5.2.6.
  433. * liblzma:
  434. - Fixed 32-bit build.
  435. - Added threaded .xz decompressor lzma_stream_decoder_mt().
  436. It can use multiple threads with .xz files that have multiple
  437. Blocks with size information in Block Headers. The threaded
  438. encoder in xz has always created such files.
  439. Single-threaded encoder cannot store the size information in
  440. Block Headers even if one used LZMA_FULL_FLUSH to create
  441. multiple Blocks, so this threaded decoder cannot use multiple
  442. threads with such files.
  443. If there are multiple Streams (concatenated .xz files), one
  444. Stream will be decompressed completely before starting the
  445. next Stream.
  446. - A new decoder flag LZMA_FAIL_FAST was added. It makes the
  447. threaded decompressor report errors soon instead of first
  448. flushing all pending data before the error location.
  449. * xz:
  450. - Using -T0 (--threads=0) will now use multi-threaded encoder
  451. even on a single-core system. This is to ensure that output
  452. from the same xz binary is identical on both single-core and
  453. multi-core systems.
  454. - A default soft memory usage limit is now used for compression
  455. when -T0 is used and no explicit limit has been specified.
  456. This soft limit is used to restrict the number of threads
  457. but if the limit is exceeded with even one thread then xz
  458. will continue with one thread using the multi-threaded
  459. encoder and this limit is ignored. If the number of threads
  460. is specified manually then no default limit will be used;
  461. this affects only -T0.
  462. This change helps on systems that have very many cores and
  463. using all of them for xz makes no sense. Previously xz -T0
  464. could run out of memory on such systems because it attempted
  465. to reserve memory for too many threads.
  466. This also helps with 32-bit builds which don't have a large
  467. amount of address space that would be required for many
  468. threads. The default limit is 1400 MiB on all 32-bit
  469. platforms with -T0.
  470. Now xz -T0 should just work. It might use too few threads
  471. in some cases but at least it shouldn't easily run out of
  472. memory. It's possible that this will be tweaked before 5.4.0.
  473. - Changes to --memlimit-compress and --no-adjust:
  474. In single-threaded mode, --memlimit-compress can make xz
  475. scale down the LZMA2 dictionary size to meet the memory usage
  476. limit. This obviously affects the compressed output. However,
  477. if xz was in threaded mode, --memlimit-compress could make xz
  478. reduce the number of threads but it wouldn't make xz switch
  479. from multi-threaded mode to single-threaded mode or scale
  480. down the LZMA2 dictionary size. This seemed illogical.
  481. Now --memlimit-compress can make xz switch to single-threaded
  482. mode if one thread in multi-threaded mode uses too much
  483. memory. If memory usage is still too high, then the LZMA2
  484. dictionary size can be scaled down too.
  485. The option --no-adjust was also changed so that it no longer
  486. prevents xz from scaling down the number of threads as that
  487. doesn't affect compressed output (only performance). After
  488. this commit --no-adjust only prevents adjustments that affect
  489. compressed output, that is, with --no-adjust xz won't switch
  490. from multithreaded mode to single-threaded mode and won't
  491. scale down the LZMA2 dictionary size.
  492. - Added a new option --memlimit-mt-decompress=LIMIT. This is
  493. used to limit the number of decompressor threads (possibly
  494. falling back to single-threaded mode) but it will never make
  495. xz refuse to decompress a file. This has a system-specific
  496. default value because without any limit xz could end up
  497. allocating memory for the whole compressed input file, the
  498. whole uncompressed output file, multiple thread-specific
  499. decompressor instances and so on. Basically xz could
  500. attempt to use an insane amount of memory even with fairly
  501. common files.
  502. The new option works together with the existing option
  503. --memlimit-decompress=LIMIT. The old option sets a hard limit
  504. that must not be exceeded (xz will refuse to decompress)
  505. while the new option only restricts the number of threads.
  506. If the limit set with --memlimit-mt-decompress is greater
  507. than the limit set with --memlimit-compress, then the latter
  508. value is used also for --memlimit-mt-decompress.
  509. * Tests:
  510. - Added a few more tests.
  511. - Added tests/code_coverage.sh to create a code coverage report
  512. of the tests.
  513. * Build systems:
  514. - Automake's parallel test harness is now used to make tests
  515. finish faster.
  516. - Added the CMake files to the distribution tarball. These were
  517. supposed to be in 5.2.5 already.
  518. - Added liblzma tests to the CMake build.
  519. - Windows: Fix building of liblzma.dll with the included
  520. Visual Studio project files.
  521. 5.3.2alpha (2021-10-28)
  522. This release was made on short notice so that recent erofs-utils can
  523. be built with LZMA support without needing a snapshot from xz.git.
  524. Thus many pending things were not included, not even updated
  525. translations (which would need to be updated for the new --list
  526. strings anyway).
  527. * All fixes from 5.2.5.
  528. * xz:
  529. - When copying metadata from the source file to the destination
  530. file, don't try to set the group (GID) if it is already set
  531. correctly. This avoids a failure on OpenBSD (and possibly on
  532. a few other OSes) where files may get created so that their
  533. group doesn't belong to the user, and fchown(2) can fail even
  534. if it needs to do nothing.
  535. - The --keep option now accepts symlinks, hardlinks, and
  536. setuid, setgid, and sticky files. Previously this required
  537. using --force.
  538. - Split the long strings used in --list and --info-memory modes
  539. to make them much easier for translators.
  540. - If built with sandbox support and enabling the sandbox fails,
  541. xz will now immediately exit with exit status of 1. Previously
  542. it would only display a warning if -vv was used.
  543. - Cap --memlimit-compress to 2000 MiB on MIPS32 because on
  544. MIPS32 userspace processes are limited to 2 GiB of address
  545. space.
  546. * liblzma:
  547. - Added lzma_microlzma_encoder() and lzma_microlzma_decoder().
  548. The API is in lzma/container.h.
  549. The MicroLZMA format is a raw LZMA stream (without end marker)
  550. whose first byte (always 0x00) has been replaced with
  551. bitwise-negation of the LZMA properties (lc/lp/pb). It was
  552. created for use in EROFS but may be used in other contexts
  553. as well where it is important to avoid wasting bytes for
  554. stream headers or footers. The format is also supported by
  555. XZ Embedded.
  556. The MicroLZMA encoder API in liblzma can compress into a
  557. fixed-sized output buffer so that as much data is compressed
  558. as can be fit into the buffer while still creating a valid
  559. MicroLZMA stream. This is needed for EROFS.
  560. - Added fuzzing support.
  561. - Support Intel Control-flow Enforcement Technology (CET) in
  562. 32-bit x86 assembly files.
  563. - Visual Studio: Use non-standard _MSVC_LANG to detect C++
  564. standard version in the lzma.h API header. It's used to
  565. detect when "noexcept" can be used.
  566. * Scripts:
  567. - Fix exit status of xzdiff/xzcmp. Exit status could be 2 when
  568. the correct value is 1.
  569. - Fix exit status of xzgrep.
  570. - Detect corrupt .bz2 files in xzgrep.
  571. - Add zstd support to xzgrep and xzdiff/xzcmp.
  572. - Fix less(1) version detection in xzless. It failed if the
  573. version number from "less -V" contained a dot.
  574. * Fix typos and technical issues in man pages.
  575. * Build systems:
  576. - Windows: Fix building of resource files when config.h isn't
  577. used. CMake + Visual Studio can now build liblzma.dll.
  578. - Various fixes to the CMake support. It might still need a few
  579. more fixes even for liblzma-only builds.
  580. 5.3.1alpha (2018-04-29)
  581. * All fixes from 5.2.4.
  582. * Add lzma_file_info_decoder() into liblzma and use it in xz to
  583. implement the --list feature.
  584. * Capsicum sandbox support is enabled by default where available
  585. (FreeBSD >= 10).
  586. 5.2.10 (2022-12-13)
  587. * xz: Don't modify argv[] when parsing the --memlimit* and
  588. --block-list command line options. This fixes confusing
  589. arguments in process listing (like "ps auxf").
  590. * GNU/Linux only: Use __has_attribute(__symver__) to detect if
  591. that attribute is supported. This fixes build on Mandriva where
  592. Clang is patched to define __GNUC__ to 11 by default (instead
  593. of 4 as used by Clang upstream).
  594. 5.2.9 (2022-11-30)
  595. * liblzma:
  596. - Fixed an infinite loop in LZMA encoder initialization
  597. if dict_size >= 2 GiB. (The encoder only supports up
  598. to 1536 MiB.)
  599. - Fixed two cases of invalid free() that can happen if
  600. a tiny allocation fails in encoder re-initialization
  601. or in lzma_filters_update(). These bugs had some
  602. similarities with the bug fixed in 5.2.7.
  603. - Fixed lzma_block_encoder() not allowing the use of
  604. LZMA_SYNC_FLUSH with lzma_code() even though it was
  605. documented to be supported. The sync-flush code in
  606. the Block encoder was already used internally via
  607. lzma_stream_encoder(), so this was just a missing flag
  608. in the lzma_block_encoder() API function.
  609. - GNU/Linux only: Don't put symbol versions into static
  610. liblzma as it breaks things in some cases (and even if
  611. it didn't break anything, symbol versions in static
  612. libraries are useless anyway). The downside of the fix
  613. is that if the configure options --with-pic or --without-pic
  614. are used then it's not possible to build both shared and
  615. static liblzma at the same time on GNU/Linux anymore;
  616. with those options --disable-static or --disable-shared
  617. must be used too.
  618. * New email address for bug reports is <xz@tukaani.org> which
  619. forwards messages to Lasse Collin and Jia Tan.
  620. 5.2.8 (2022-11-13)
  621. * xz:
  622. - If xz cannot remove an input file when it should, this
  623. is now treated as a warning (exit status 2) instead of
  624. an error (exit status 1). This matches GNU gzip and it
  625. is more logical as at that point the output file has
  626. already been successfully closed.
  627. - Fix handling of .xz files with an unsupported check type.
  628. Previously such printed a warning message but then xz
  629. behaved as if an error had occurred (didn't decompress,
  630. exit status 1). Now a warning is printed, decompression
  631. is done anyway, and exit status is 2. This used to work
  632. slightly before 5.0.0. In practice this bug matters only
  633. if xz has been built with some check types disabled. As
  634. instructed in PACKAGERS, such builds should be done in
  635. special situations only.
  636. - Fix "xz -dc --single-stream tests/files/good-0-empty.xz"
  637. which failed with "Internal error (bug)". That is,
  638. --single-stream was broken if the first .xz stream in
  639. the input file didn't contain any uncompressed data.
  640. - Fix displaying file sizes in the progress indicator when
  641. working in passthru mode and there are multiple input files.
  642. Just like "gzip -cdf", "xz -cdf" works like "cat" when the
  643. input file isn't a supported compressed file format. In
  644. this case the file size counters weren't reset between
  645. files so with multiple input files the progress indicator
  646. displayed an incorrect (too large) value.
  647. * liblzma:
  648. - API docs in lzma/container.h:
  649. * Update the list of decoder flags in the decoder
  650. function docs.
  651. * Explain LZMA_CONCATENATED behavior with .lzma files
  652. in lzma_auto_decoder() docs.
  653. - OpenBSD: Use HW_NCPUONLINE to detect the number of
  654. available hardware threads in lzma_physmem().
  655. - Fix use of wrong macro to detect x86 SSE2 support.
  656. __SSE2_MATH__ was used with GCC/Clang but the correct
  657. one is __SSE2__. The first one means that SSE2 is used
  658. for floating point math which is irrelevant here.
  659. The affected SSE2 code isn't used on x86-64 so this affects
  660. only 32-bit x86 builds that use -msse2 without -mfpmath=sse
  661. (there is no runtime detection for SSE2). It improves LZMA
  662. compression speed (not decompression).
  663. - Fix the build with Intel C compiler 2021 (ICC, not ICX)
  664. on Linux. It defines __GNUC__ to 10 but doesn't support
  665. the __symver__ attribute introduced in GCC 10.
  666. * Scripts: Ignore warnings from xz by using --quiet --no-warn.
  667. This is needed if the input .xz files use an unsupported
  668. check type.
  669. * Translations:
  670. - Updated Croatian and Turkish translations.
  671. - One new translations wasn't included because it needed
  672. technical fixes. It will be in upcoming 5.4.0. No new
  673. translations will be added to the 5.2.x branch anymore.
  674. - Renamed the French man page translation file from
  675. fr_FR.po to fr.po and thus also its install directory
  676. (like /usr/share/man/fr_FR -> .../fr).
  677. - Man page translations for upcoming 5.4.0 are now handled
  678. in the Translation Project.
  679. * Update doc/faq.txt a little so it's less out-of-date.
  680. 5.2.7 (2022-09-30)
  681. * liblzma:
  682. - Made lzma_filters_copy() to never modify the destination
  683. array if an error occurs. lzma_stream_encoder() and
  684. lzma_stream_encoder_mt() already assumed this. Before this
  685. change, if a tiny memory allocation in lzma_filters_copy()
  686. failed it would lead to a crash (invalid free() or invalid
  687. memory reads) in the cleanup paths of these two encoder
  688. initialization functions.
  689. - Added missing integer overflow check to lzma_index_append().
  690. This affects xz --list and other applications that decode
  691. the Index field from .xz files using lzma_index_decoder().
  692. Normal decompression of .xz files doesn't call this code
  693. and thus most applications using liblzma aren't affected
  694. by this bug.
  695. - Single-threaded .xz decoder (lzma_stream_decoder()): If
  696. lzma_code() returns LZMA_MEMLIMIT_ERROR it is now possible
  697. to use lzma_memlimit_set() to increase the limit and continue
  698. decoding. This was supposed to work from the beginning
  699. but there was a bug. With other decoders (.lzma or
  700. threaded .xz decoder) this already worked correctly.
  701. - Fixed accumulation of integrity check type statistics in
  702. lzma_index_cat(). This bug made lzma_index_checks() return
  703. only the type of the integrity check of the last Stream
  704. when multiple lzma_indexes were concatenated. Most
  705. applications don't use these APIs but in xz it made
  706. xz --list not list all check types from concatenated .xz
  707. files. In xz --list --verbose only the per-file "Check:"
  708. lines were affected and in xz --robot --list only the "file"
  709. line was affected.
  710. - Added ABI compatibility with executables that were linked
  711. against liblzma in RHEL/CentOS 7 or other liblzma builds
  712. that had copied the problematic patch from RHEL/CentOS 7
  713. (xz-5.2.2-compat-libs.patch). For the details, see the
  714. comment at the top of src/liblzma/validate_map.sh.
  715. WARNING: This uses __symver__ attribute with GCC >= 10.
  716. In other cases the traditional __asm__(".symver ...")
  717. is used. Using link-time optimization (LTO, -flto) with
  718. GCC versions older than 10 can silently result in
  719. broken liblzma.so.5 (incorrect symbol versions)! If you
  720. want to use -flto with GCC, you must use GCC >= 10.
  721. LTO with Clang seems to work even with the traditional
  722. __asm__(".symver ...") method.
  723. * xzgrep: Fixed compatibility with old shells that break if
  724. comments inside command substitutions have apostrophes (').
  725. This problem was introduced in 5.2.6.
  726. * Build systems:
  727. - New #define in config.h: HAVE_SYMBOL_VERSIONS_LINUX
  728. - Windows: Fixed liblzma.dll build with Visual Studio project
  729. files. It broke in 5.2.6 due to a change that was made to
  730. improve CMake support.
  731. - Windows: Building liblzma with UNICODE defined should now
  732. work.
  733. - CMake files are now actually included in the release tarball.
  734. They should have been in 5.2.5 already.
  735. - Minor CMake fixes and improvements.
  736. * Added a new translation: Turkish
  737. 5.2.6 (2022-08-12)
  738. * xz:
  739. - The --keep option now accepts symlinks, hardlinks, and
  740. setuid, setgid, and sticky files. Previously this required
  741. using --force.
  742. - When copying metadata from the source file to the destination
  743. file, don't try to set the group (GID) if it is already set
  744. correctly. This avoids a failure on OpenBSD (and possibly on
  745. a few other OSes) where files may get created so that their
  746. group doesn't belong to the user, and fchown(2) can fail even
  747. if it needs to do nothing.
  748. - Cap --memlimit-compress to 2000 MiB instead of 4020 MiB on
  749. MIPS32 because on MIPS32 userspace processes are limited
  750. to 2 GiB of address space.
  751. * liblzma:
  752. - Fixed a missing error-check in the threaded encoder. If a
  753. small memory allocation fails, a .xz file with an invalid
  754. Index field would be created. Decompressing such a file would
  755. produce the correct output but result in an error at the end.
  756. Thus this is a "mild" data corruption bug. Note that while
  757. a failed memory allocation can trigger the bug, it cannot
  758. cause invalid memory access.
  759. - The decoder for .lzma files now supports files that have
  760. uncompressed size stored in the header and still use the
  761. end of payload marker (end of stream marker) at the end
  762. of the LZMA stream. Such files are rare but, according to
  763. the documentation in LZMA SDK, they are valid.
  764. doc/lzma-file-format.txt was updated too.
  765. - Improved 32-bit x86 assembly files:
  766. * Support Intel Control-flow Enforcement Technology (CET)
  767. * Use non-executable stack on FreeBSD.
  768. - Visual Studio: Use non-standard _MSVC_LANG to detect C++
  769. standard version in the lzma.h API header. It's used to
  770. detect when "noexcept" can be used.
  771. * xzgrep:
  772. - Fixed arbitrary command injection via a malicious filename
  773. (CVE-2022-1271, ZDI-CAN-16587). A standalone patch for
  774. this was released to the public on 2022-04-07. A slight
  775. robustness improvement has been made since then and, if
  776. using GNU or *BSD grep, a new faster method is now used
  777. that doesn't use the old sed-based construct at all. This
  778. also fixes bad output with GNU grep >= 3.5 (2020-09-27)
  779. when xzgrepping binary files.
  780. This vulnerability was discovered by:
  781. cleemy desu wayo working with Trend Micro Zero Day Initiative
  782. - Fixed detection of corrupt .bz2 files.
  783. - Improved error handling to fix exit status in some situations
  784. and to fix handling of signals: in some situations a signal
  785. didn't make xzgrep exit when it clearly should have. It's
  786. possible that the signal handling still isn't quite perfect
  787. but hopefully it's good enough.
  788. - Documented exit statuses on the man page.
  789. - xzegrep and xzfgrep now use "grep -E" and "grep -F" instead
  790. of the deprecated egrep and fgrep commands.
  791. - Fixed parsing of the options -E, -F, -G, -P, and -X. The
  792. problem occurred when multiple options were specified in
  793. a single argument, for example,
  794. echo foo | xzgrep -Fe foo
  795. treated foo as a filename because -Fe wasn't correctly
  796. split into -F -e.
  797. - Added zstd support.
  798. * xzdiff/xzcmp:
  799. - Fixed wrong exit status. Exit status could be 2 when the
  800. correct value is 1.
  801. - Documented on the man page that exit status of 2 is used
  802. for decompression errors.
  803. - Added zstd support.
  804. * xzless:
  805. - Fix less(1) version detection. It failed if the version number
  806. from "less -V" contained a dot.
  807. * Translations:
  808. - Added new translations: Catalan, Croatian, Esperanto,
  809. Korean, Portuguese, Romanian, Serbian, Spanish, Swedish,
  810. and Ukrainian
  811. - Updated the Brazilian Portuguese translation.
  812. - Added French man page translation. This and the existing
  813. German translation aren't complete anymore because the
  814. English man pages got a few updates and the translators
  815. weren't reached so that they could update their work.
  816. * Build systems:
  817. - Windows: Fix building of resource files when config.h isn't
  818. used. CMake + Visual Studio can now build liblzma.dll.
  819. - Various fixes to the CMake support. Building static or shared
  820. liblzma should work fine in most cases. In contrast, building
  821. the command line tools with CMake is still clearly incomplete
  822. and experimental and should be used for testing only.
  823. 5.2.5 (2020-03-17)
  824. * liblzma:
  825. - Fixed several C99/C11 conformance bugs. Now the code is clean
  826. under gcc/clang -fsanitize=undefined. Some of these changes
  827. might have a negative effect on performance with old GCC
  828. versions or compilers other than GCC and Clang. The configure
  829. option --enable-unsafe-type-punning can be used to (mostly)
  830. restore the old behavior but it shouldn't normally be used.
  831. - Improved API documentation of lzma_properties_decode().
  832. - Added a very minor encoder speed optimization.
  833. * xz:
  834. - Fixed a crash in "xz -dcfv not_an_xz_file". All four options
  835. were required to trigger it. The crash occurred in the
  836. progress indicator code when xz was in passthru mode where
  837. xz works like "cat".
  838. - Fixed an integer overflow with 32-bit off_t. It could happen
  839. when decompressing a file that has a long run of zero bytes
  840. which xz would try to write as a sparse file. Since the build
  841. system enables large file support by default, off_t is
  842. normally 64-bit even on 32-bit systems.
  843. - Fixes for --flush-timeout:
  844. * Fix semi-busy-waiting.
  845. * Avoid unneeded flushes when no new input has arrived
  846. since the previous flush was completed.
  847. - Added a special case for 32-bit xz: If --memlimit-compress is
  848. used to specify a limit that exceeds 4020 MiB, the limit will
  849. be set to 4020 MiB. The values "0" and "max" aren't affected
  850. by this and neither is decompression. This hack can be
  851. helpful when a 32-bit xz has access to 4 GiB address space
  852. but the specified memlimit exceeds 4 GiB. This can happen
  853. e.g. with some scripts.
  854. - Capsicum sandbox is now enabled by default where available
  855. (FreeBSD >= 10). The sandbox debug messages (xz -vv) were
  856. removed since they seemed to be more annoying than useful.
  857. - DOS build now requires DJGPP 2.05 instead of 2.04beta.
  858. A workaround for a locale problem with DJGPP 2.05 was added.
  859. * xzgrep and other scripts:
  860. - Added a configure option --enable-path-for-scripts=PREFIX.
  861. It is disabled by default except on Solaris where the default
  862. is /usr/xpg4/bin. See INSTALL for details.
  863. - Added a workaround for a POSIX shell detection problem on
  864. Solaris.
  865. * Build systems:
  866. - Added preliminary build instructions for z/OS. See INSTALL
  867. section 1.2.9.
  868. - Experimental CMake support was added. It should work to build
  869. static liblzma on a few operating systems. It may or may not
  870. work to build shared liblzma. On some platforms it can build
  871. xz and xzdec too but those are only for testing. See the
  872. comment in the beginning of CMakeLists.txt for details.
  873. - Visual Studio project files were updated.
  874. WindowsTargetPlatformVersion was removed from VS2017 files
  875. and set to "10.0" in the added VS2019 files. In the future
  876. the VS project files will be removed when CMake support is
  877. good enough.
  878. - New #defines in config.h: HAVE___BUILTIN_ASSUME_ALIGNED,
  879. HAVE___BUILTIN_BSWAPXX, and TUKLIB_USE_UNSAFE_TYPE_PUNNING.
  880. - autogen.sh has a new optional dependency on po4a and a new
  881. option --no-po4a to skip that step. This matters only if one
  882. wants to remake the build files. po4a is used to update the
  883. translated man pages but as long as the man pages haven't
  884. been modified, there's nothing to update and one can use
  885. --no-po4a to avoid the dependency on po4a.
  886. * Translations:
  887. - XZ Utils translations are now handled by the Translation
  888. Project: https://translationproject.org/domain/xz.html
  889. - All man pages are now included in German too.
  890. - New xz translations: Brazilian Portuguese, Finnish,
  891. Hungarian, Chinese (simplified), Chinese (traditional),
  892. and Danish (partial translation)
  893. - Updated xz translations: French, German, Italian, and Polish
  894. - Unfortunately a few new xz translations weren't included due
  895. to technical problems like too long lines in --help output or
  896. misaligned column headings in tables. In the future, many of
  897. these strings will be split and e.g. the table column
  898. alignment will be handled in software. This should make the
  899. strings easier to translate.
  900. 5.2.4 (2018-04-29)
  901. * liblzma:
  902. - Allow 0 as memory usage limit instead of returning
  903. LZMA_PROG_ERROR. Now 0 is treated as if 1 byte was specified,
  904. which effectively is the same as 0.
  905. - Use "noexcept" keyword instead of "throw()" in the public
  906. headers when a C++11 (or newer standard) compiler is used.
  907. - Added a portability fix for recent Intel C Compilers.
  908. - Microsoft Visual Studio build files have been moved under
  909. windows/vs2013 and windows/vs2017.
  910. * xz:
  911. - Fix "xz --list --robot missing_or_bad_file.xz" which would
  912. try to print an uninitialized string and thus produce garbage
  913. output. Since the exit status is non-zero, most uses of such
  914. a command won't try to interpret the garbage output.
  915. - "xz --list foo.xz" could print "Internal error (bug)" in a
  916. corner case where a specific memory usage limit had been set.
  917. 5.2.3 (2016-12-30)
  918. * xz:
  919. - Always close a file before trying to delete it to avoid
  920. problems on some operating system and file system combinations.
  921. - Fixed copying of file timestamps on Windows.
  922. - Added experimental (disabled by default) sandbox support using
  923. Capsicum (FreeBSD >= 10). See --enable-sandbox in INSTALL.
  924. * C99/C11 conformance fixes to liblzma. The issues affected at least
  925. some builds using link-time optimizations.
  926. * Fixed bugs in the rarely-used function lzma_index_dup().
  927. * Use of external SHA-256 code is now disabled by default.
  928. It can still be enabled by passing --enable-external-sha256
  929. to configure. The reasons to disable it by default (see INSTALL
  930. for more details):
  931. - Some OS-specific SHA-256 implementations conflict with
  932. OpenSSL and cause problems in programs that link against both
  933. liblzma and libcrypto. At least FreeBSD 10 and MINIX 3.3.0
  934. are affected.
  935. - The internal SHA-256 is faster than the SHA-256 code in
  936. some operating systems.
  937. * Changed CPU core count detection to use sched_getaffinity() on
  938. GNU/Linux and GNU/kFreeBSD.
  939. * Fixes to the build-system and xz to make xz buildable even when
  940. encoders, decoders, or threading have been disabled from libilzma
  941. using configure options. These fixes added two new #defines to
  942. config.h: HAVE_ENCODERS and HAVE_DECODERS.
  943. 5.2.2 (2015-09-29)
  944. * Fixed bugs in QNX-specific code.
  945. * Omitted the use of pipe2() even if it is available to avoid
  946. portability issues with some old Linux and glibc combinations.
  947. * Updated German translation.
  948. * Added project files to build static and shared liblzma (not the
  949. whole XZ Utils) with Visual Studio 2013 update 2 or later.
  950. * Documented that threaded decompression hasn't been implemented
  951. yet. A 5.2.0 NEWS entry describing multi-threading support had
  952. incorrectly said "decompression" when it should have said
  953. "compression".
  954. 5.2.1 (2015-02-26)
  955. * Fixed a compression-ratio regression in fast mode of LZMA1 and
  956. LZMA2. The bug is present in 5.1.4beta and 5.2.0 releases.
  957. * Fixed a portability problem in xz that affected at least OpenBSD.
  958. * Fixed xzdiff to be compatible with FreeBSD's mktemp which differs
  959. from most other mktemp implementations.
  960. * Changed CPU core count detection to use cpuset_getaffinity() on
  961. FreeBSD.
  962. 5.2.0 (2014-12-21)
  963. Since 5.1.4beta:
  964. * All fixes from 5.0.8
  965. * liblzma: Fixed lzma_stream_encoder_mt_memusage() when a preset
  966. was used.
  967. * xzdiff: If mktemp isn't installed, mkdir will be used as
  968. a fallback to create a temporary directory. Installing mktemp
  969. is still recommended.
  970. * Updated French, German, Italian, Polish, and Vietnamese
  971. translations.
  972. Summary of fixes and new features added in the 5.1.x development
  973. releases:
  974. * liblzma:
  975. - Added support for multi-threaded compression. See the
  976. lzma_mt structure, lzma_stream_encoder_mt(), and
  977. lzma_stream_encoder_mt_memusage() in <lzma/container.h>,
  978. lzma_get_progress() in <lzma/base.h>, and lzma_cputhreads()
  979. in <lzma/hardware.h> for details.
  980. - Made the uses of lzma_allocator const correct.
  981. - Added lzma_block_uncomp_encode() to create uncompressed
  982. .xz Blocks using LZMA2 uncompressed chunks.
  983. - Added support for LZMA_IGNORE_CHECK.
  984. - A few speed optimizations were made.
  985. - Added support for symbol versioning. It is enabled by default
  986. on GNU/Linux, other GNU-based systems, and FreeBSD.
  987. - liblzma (not the whole XZ Utils) should now be buildable
  988. with MSVC 2013 update 2 or later using windows/config.h.
  989. * xz:
  990. - Fixed a race condition in the signal handling. It was
  991. possible that e.g. the first SIGINT didn't make xz exit
  992. if reading or writing blocked and one had bad luck. The fix
  993. is non-trivial, so as of writing it is unknown if it will be
  994. backported to the v5.0 branch.
  995. - Multi-threaded compression can be enabled with the
  996. --threads (-T) option.
  997. [Fixed: This originally said "decompression".]
  998. - New command line options in xz: --single-stream,
  999. --block-size=SIZE, --block-list=SIZES,
  1000. --flush-timeout=TIMEOUT, and --ignore-check.
  1001. - xz -lvv now shows the minimum xz version that is required to
  1002. decompress the file. Currently it is 5.0.0 for all supported
  1003. .xz files except files with empty LZMA2 streams require 5.0.2.
  1004. * xzdiff and xzgrep now support .lzo files if lzop is installed.
  1005. The .tzo suffix is also recognized as a shorthand for .tar.lzo.
  1006. 5.1.4beta (2014-09-14)
  1007. * All fixes from 5.0.6
  1008. * liblzma: Fixed the use of presets in threaded encoder
  1009. initialization.
  1010. * xz --block-list and --block-size can now be used together
  1011. in single-threaded mode. Previously the combination only
  1012. worked in multi-threaded mode.
  1013. * Added support for LZMA_IGNORE_CHECK to liblzma and made it
  1014. available in xz as --ignore-check.
  1015. * liblzma speed optimizations:
  1016. - Initialization of a new LZMA1 or LZMA2 encoder has been
  1017. optimized. (The speed of reinitializing an already-allocated
  1018. encoder isn't affected.) This helps when compressing many
  1019. small buffers with lzma_stream_buffer_encode() and other
  1020. similar situations where an already-allocated encoder state
  1021. isn't reused. This speed-up is visible in xz too if one
  1022. compresses many small files one at a time instead running xz
  1023. once and giving all files as command-line arguments.
  1024. - Buffer comparisons are now much faster when unaligned access
  1025. is allowed (configured with --enable-unaligned-access). This
  1026. speeds up encoding significantly. There is arch-specific code
  1027. for 32-bit and 64-bit x86 (32-bit needs SSE2 for the best
  1028. results and there's no run-time CPU detection for now).
  1029. For other archs there is only generic code which probably
  1030. isn't as optimal as arch-specific solutions could be.
  1031. - A few speed optimizations were made to the SHA-256 code.
  1032. (Note that the builtin SHA-256 code isn't used on all
  1033. operating systems.)
  1034. * liblzma can now be built with MSVC 2013 update 2 or later
  1035. using windows/config.h.
  1036. * Vietnamese translation was added.
  1037. 5.1.3alpha (2013-10-26)
  1038. * All fixes from 5.0.5
  1039. * liblzma:
  1040. - Fixed a deadlock in the threaded encoder.
  1041. - Made the uses of lzma_allocator const correct.
  1042. - Added lzma_block_uncomp_encode() to create uncompressed
  1043. .xz Blocks using LZMA2 uncompressed chunks.
  1044. - Added support for native threads on Windows and the ability
  1045. to detect the number of CPU cores.
  1046. * xz:
  1047. - Fixed a race condition in the signal handling. It was
  1048. possible that e.g. the first SIGINT didn't make xz exit
  1049. if reading or writing blocked and one had bad luck. The fix
  1050. is non-trivial, so as of writing it is unknown if it will be
  1051. backported to the v5.0 branch.
  1052. - Made the progress indicator work correctly in threaded mode.
  1053. - Threaded encoder now works together with --block-list=SIZES.
  1054. - Added preliminary support for --flush-timeout=TIMEOUT.
  1055. It can be useful for (somewhat) real-time streaming. For
  1056. now the decompression side has to be done with something
  1057. else than the xz tool due to how xz does buffering, but this
  1058. should be fixed.
  1059. 5.1.2alpha (2012-07-04)
  1060. * All fixes from 5.0.3 and 5.0.4
  1061. * liblzma:
  1062. - Fixed a deadlock and an invalid free() in the threaded encoder.
  1063. - Added support for symbol versioning. It is enabled by default
  1064. on GNU/Linux, other GNU-based systems, and FreeBSD.
  1065. - Use SHA-256 implementation from the operating system if one is
  1066. available in libc, libmd, or libutil. liblzma won't use e.g.
  1067. OpenSSL or libgcrypt to avoid introducing new dependencies.
  1068. - Fixed liblzma.pc for static linking.
  1069. - Fixed a few portability bugs.
  1070. * xz --decompress --single-stream now fixes the input position after
  1071. successful decompression. Now the following works:
  1072. echo foo | xz > foo.xz
  1073. echo bar | xz >> foo.xz
  1074. ( xz -dc --single-stream ; xz -dc --single-stream ) < foo.xz
  1075. Note that it doesn't work if the input is not seekable
  1076. or if there is Stream Padding between the concatenated
  1077. .xz Streams.
  1078. * xz -lvv now shows the minimum xz version that is required to
  1079. decompress the file. Currently it is 5.0.0 for all supported .xz
  1080. files except files with empty LZMA2 streams require 5.0.2.
  1081. * Added an *incomplete* implementation of --block-list=SIZES to xz.
  1082. It only works correctly in single-threaded mode and when
  1083. --block-size isn't used at the same time. --block-list allows
  1084. specifying the sizes of Blocks which can be useful e.g. when
  1085. creating files for random-access reading.
  1086. 5.1.1alpha (2011-04-12)
  1087. * All fixes from 5.0.2
  1088. * liblzma fixes that will also be included in 5.0.3:
  1089. - A memory leak was fixed.
  1090. - lzma_stream_buffer_encode() no longer creates an empty .xz
  1091. Block if encoding an empty buffer. Such an empty Block with
  1092. LZMA2 data would trigger a bug in 5.0.1 and older (see the
  1093. first bullet point in 5.0.2 notes). When releasing 5.0.2,
  1094. I thought that no encoder creates this kind of files but
  1095. I was wrong.
  1096. - Validate function arguments better in a few functions. Most
  1097. importantly, specifying an unsupported integrity check to
  1098. lzma_stream_buffer_encode() no longer creates a corrupt .xz
  1099. file. Probably no application tries to do that, so this
  1100. shouldn't be a big problem in practice.
  1101. - Document that lzma_block_buffer_encode(),
  1102. lzma_easy_buffer_encode(), lzma_stream_encoder(), and
  1103. lzma_stream_buffer_encode() may return LZMA_UNSUPPORTED_CHECK.
  1104. - The return values of the _memusage() functions are now
  1105. documented better.
  1106. * Support for multithreaded compression was added using the simplest
  1107. method, which splits the input data into blocks and compresses
  1108. them independently. Other methods will be added in the future.
  1109. The current method has room for improvement, e.g. it is possible
  1110. to reduce the memory usage.
  1111. * Added the options --single-stream and --block-size=SIZE to xz.
  1112. * xzdiff and xzgrep now support .lzo files if lzop is installed.
  1113. The .tzo suffix is also recognized as a shorthand for .tar.lzo.
  1114. * Support for short 8.3 filenames under DOS was added to xz. It is
  1115. experimental and may change before it gets into a stable release.
  1116. 5.0.8 (2014-12-21)
  1117. * Fixed an old bug in xzgrep that affected OpenBSD and probably
  1118. a few other operating systems too.
  1119. * Updated French and German translations.
  1120. * Added support for detecting the amount of RAM on AmigaOS/AROS.
  1121. * Minor build system updates.
  1122. 5.0.7 (2014-09-20)
  1123. * Fix regressions introduced in 5.0.6:
  1124. - Fix building with non-GNU make.
  1125. - Fix invalid Libs.private value in liblzma.pc which broke
  1126. static linking against liblzma if the linker flags were
  1127. taken from pkg-config.
  1128. 5.0.6 (2014-09-14)
  1129. * xzgrep now exits with status 0 if at least one file matched.
  1130. * A few minor portability and build system fixes
  1131. 5.0.5 (2013-06-30)
  1132. * lzmadec and liblzma's lzma_alone_decoder(): Support decompressing
  1133. .lzma files that have less common settings in the headers
  1134. (dictionary size other than 2^n or 2^n + 2^(n-1), or uncompressed
  1135. size greater than 256 GiB). The limitations existed to avoid false
  1136. positives when detecting .lzma files. The lc + lp <= 4 limitation
  1137. still remains since liblzma's LZMA decoder has that limitation.
  1138. NOTE: xz's .lzma support or liblzma's lzma_auto_decoder() are NOT
  1139. affected by this change. They still consider uncommon .lzma headers
  1140. as not being in the .lzma format. Changing this would give way too
  1141. many false positives.
  1142. * xz:
  1143. - Interaction of preset and custom filter chain options was
  1144. made less illogical. This affects only certain less typical
  1145. uses cases so few people are expected to notice this change.
  1146. Now when a custom filter chain option (e.g. --lzma2) is
  1147. specified, all preset options (-0 ... -9, -e) earlier are on
  1148. the command line are completely forgotten. Similarly, when
  1149. a preset option is specified, all custom filter chain options
  1150. earlier on the command line are completely forgotten.
  1151. Example 1: "xz -9 --lzma2=preset=5 -e" is equivalent to "xz -e"
  1152. which is equivalent to "xz -6e". Earlier -e didn't put xz back
  1153. into preset mode and thus the example command was equivalent
  1154. to "xz --lzma2=preset=5".
  1155. Example 2: "xz -9e --lzma2=preset=5 -7" is equivalent to
  1156. "xz -7". Earlier a custom filter chain option didn't make
  1157. xz forget the -e option so the example was equivalent to
  1158. "xz -7e".
  1159. - Fixes and improvements to error handling.
  1160. - Various fixes to the man page.
  1161. * xzless: Fixed to work with "less" versions 448 and later.
  1162. * xzgrep: Made -h an alias for --no-filename.
  1163. * Include the previously missing debug/translation.bash which can
  1164. be useful for translators.
  1165. * Include a build script for Mac OS X. This has been in the Git
  1166. repository since 2010 but due to a mistake in Makefile.am the
  1167. script hasn't been included in a release tarball before.
  1168. 5.0.4 (2012-06-22)
  1169. * liblzma:
  1170. - Fix lzma_index_init(). It could crash if memory allocation
  1171. failed.
  1172. - Fix the possibility of an incorrect LZMA_BUF_ERROR when a BCJ
  1173. filter is used and the application only provides exactly as
  1174. much output space as is the uncompressed size of the file.
  1175. - Fix a bug in doc/examples_old/xz_pipe_decompress.c. It didn't
  1176. check if the last call to lzma_code() really returned
  1177. LZMA_STREAM_END, which made the program think that truncated
  1178. files are valid.
  1179. - New example programs in doc/examples (old programs are now in
  1180. doc/examples_old). These have more comments and more detailed
  1181. error handling.
  1182. * Fix "xz -lvv foo.xz". It could crash on some corrupted files.
  1183. * Fix output of "xz --robot -lv" and "xz --robot -lvv" which
  1184. incorrectly printed the filename also in the "foo (x/x)" format.
  1185. * Fix exit status of "xzdiff foo.xz bar.xz".
  1186. * Fix exit status of "xzgrep foo binary_file".
  1187. * Fix portability to EBCDIC systems.
  1188. * Fix a configure issue on AIX with the XL C compiler. See INSTALL
  1189. for details.
  1190. * Update French, German, Italian, and Polish translations.
  1191. 5.0.3 (2011-05-21)
  1192. * liblzma fixes:
  1193. - A memory leak was fixed.
  1194. - lzma_stream_buffer_encode() no longer creates an empty .xz
  1195. Block if encoding an empty buffer. Such an empty Block with
  1196. LZMA2 data would trigger a bug in 5.0.1 and older (see the
  1197. first bullet point in 5.0.2 notes). When releasing 5.0.2,
  1198. I thought that no encoder creates this kind of files but
  1199. I was wrong.
  1200. - Validate function arguments better in a few functions. Most
  1201. importantly, specifying an unsupported integrity check to
  1202. lzma_stream_buffer_encode() no longer creates a corrupt .xz
  1203. file. Probably no application tries to do that, so this
  1204. shouldn't be a big problem in practice.
  1205. - Document that lzma_block_buffer_encode(),
  1206. lzma_easy_buffer_encode(), lzma_stream_encoder(), and
  1207. lzma_stream_buffer_encode() may return LZMA_UNSUPPORTED_CHECK.
  1208. - The return values of the _memusage() functions are now
  1209. documented better.
  1210. * Fix command name detection in xzgrep. xzegrep and xzfgrep now
  1211. correctly use egrep and fgrep instead of grep.
  1212. * French translation was added.
  1213. 5.0.2 (2011-04-01)
  1214. * LZMA2 decompressor now correctly accepts LZMA2 streams with no
  1215. uncompressed data. Previously it considered them corrupt. The
  1216. bug can affect applications that use raw LZMA2 streams. It is
  1217. very unlikely to affect .xz files because no compressor creates
  1218. .xz files with empty LZMA2 streams. (Empty .xz files are a
  1219. different thing than empty LZMA2 streams.)
  1220. * "xz --suffix=.foo filename.foo" now refuses to compress the
  1221. file due to it already having the suffix .foo. It was already
  1222. documented on the man page, but the code lacked the test.
  1223. * "xzgrep -l foo bar.xz" works now.
  1224. * Polish translation was added.
  1225. 5.0.1 (2011-01-29)
  1226. * xz --force now (de)compresses files that have setuid, setgid,
  1227. or sticky bit set and files that have multiple hard links.
  1228. The man page had it documented this way already, but the code
  1229. had a bug.
  1230. * gzip and bzip2 support in xzdiff was fixed.
  1231. * Portability fixes
  1232. * Minor fix to Czech translation
  1233. 5.0.0 (2010-10-23)
  1234. Only the most important changes compared to 4.999.9beta are listed
  1235. here. One change is especially important:
  1236. * The memory usage limit is now disabled by default. Some scripts
  1237. written before this change may have used --memory=max on xz command
  1238. line or in XZ_OPT. THESE USES OF --memory=max SHOULD BE REMOVED
  1239. NOW, because they interfere with user's ability to set the memory
  1240. usage limit himself. If user-specified limit causes problems to
  1241. your script, blame the user.
  1242. Other significant changes:
  1243. * Added support for XZ_DEFAULTS environment variable. This variable
  1244. allows users to set default options for xz, e.g. default memory
  1245. usage limit or default compression level. Scripts that use xz
  1246. must never set or unset XZ_DEFAULTS. Scripts should use XZ_OPT
  1247. instead if they need a way to pass options to xz via an
  1248. environment variable.
  1249. * The compression settings associated with the preset levels
  1250. -0 ... -9 have been changed. --extreme was changed a little too.
  1251. It is now less likely to make compression worse, but with some
  1252. files the new --extreme may compress slightly worse than the old
  1253. --extreme.
  1254. * If a preset level (-0 ... -9) is specified after a custom filter
  1255. chain options have been used (e.g. --lzma2), the custom filter
  1256. chain will be forgotten. Earlier the preset options were
  1257. completely ignored after custom filter chain options had been
  1258. seen.
  1259. * xz will create sparse files when decompressing if the uncompressed
  1260. data contains long sequences of binary zeros. This is done even
  1261. when writing to standard output that is connected to a regular
  1262. file and certain additional conditions are met to make it safe.
  1263. * Support for "xz --list" was added. Combine with --verbose or
  1264. --verbose --verbose (-vv) for detailed output.
  1265. * I had hoped that liblzma API would have been stable after
  1266. 4.999.9beta, but there have been a couple of changes in the
  1267. advanced features, which don't affect most applications:
  1268. - Index handling code was revised. If you were using the old
  1269. API, you will get a compiler error (so it's easy to notice).
  1270. - A subtle but important change was made to the Block handling
  1271. API. lzma_block.version has to be initialized even for
  1272. lzma_block_header_decode(). Code that doesn't do it will work
  1273. for now, but might break in the future, which makes this API
  1274. change easy to miss.
  1275. * The major soname has been bumped to 5.0.0. liblzma API and ABI
  1276. are now stable, so the need to recompile programs linking against
  1277. liblzma shouldn't arise soon.