]> wimlib.net Git - wimlib/blob - NEWS
resource: pass blob and offset to consume_chunk
[wimlib] / NEWS
1 Version 1.11.0-BETA1:
2         Updated 'mkwinpeimg' to work correctly on images that have a "windows"
3         (lower case) directory rather than a "Windows" (upper case) directory.
4
5         On Windows, improved the way in which files deduplicated with Windows'
6         Data Deduplication feature are captured.
7
8         Fixed configuring with --enable-ssse3-sha1 from release tarball
9         (the file nasm_lt.sh was missing).
10
11         The development files needed to link with wimlib using Visual Studio are
12         now included in the Windows release archives.
13
14         wimlib.h can now be included by Visual Studio without errors.
15
16         The example programs can now be compiled in C++ mode, and they also now
17         work on Windows.
18
19 Version 1.10.0:
20         The LZX compression ratio has been slightly improved.  The default mode,
21         LZX level 50, is now almost as good as the old LZX level 100, while
22         being nearly the same speed as before.
23
24         Decompression performance has been slightly improved.
25
26         Filenames are now always listed in NTFS collation order.
27
28         On UNIX-like systems, wimlib can now process Windows filenames that are
29         not valid Unicode due to the presence of unpaired surrogates.
30
31         On UNIX-like systems, wimlib now always assumes UTF-8 encoding with the
32         addition of surrogate codepoints.  Consequently, the environmental
33         variable WIMLIB_IMAGEX_USE_UTF8 and the flag
34         WIMLIB_INIT_FLAG_ASSUME_UTF8 no longer have any effect.
35
36         wimlib no longer depends on iconv.
37
38         Reduced memory usage slightly.
39
40         When a WIM image is applied in NTFS-3G mode, security descriptors are
41         now created in NTFS v3.0 format when supported by the volume.
42
43         Workarounds for bugs in libntfs-3g version 2013.1.13 and earlier have
44         been removed.  Users are advised to upgrade to a later version of
45         libntfs-3g.
46
47         On Windows, wimlib now supports case-sensitive filename extraction when
48         supported by the underlying operating system and filesystem (operating
49         system support requires a registry setting).
50
51 Version 1.9.2:
52         On UNIX, wimlib can now overwrite readonly files when extracting.
53
54         On Windows, fixed a bug where wimlib could leave a null DACL (a.k.a. "no
55         NTFS permissions") set on some existing directories after extraction.
56
57         On Windows, when applying a WIM image in "WIMBoot mode" when the WOF
58         driver is not loaded, wimlib can now correctly register a new WIM file
59         with the target volume when the target volume previously had had WIM
60         files unregistered.
61
62         Added a new testing program.
63
64         Clarified the main license text and updated public domain dedications
65         for certain files to be more thorough.
66
67 Version 1.9.1:
68         Object IDs are now saved and restored on Windows and in NTFS-3G mode.
69
70         Reduced memory usage when exporting large numbers of WIM images.
71
72         Non UTF-8 locales are now detected correctly.
73
74         Addressed compiler warnings and enabled "silent" make rules by default.
75
76         Windows-specific updates:
77                 Fixed a bug where duplicate backslashes could be generated in
78                 link targets when extracting symbolic links and junctions.
79
80                 Fixed a bug where the .cmd shortcuts for wimlib-imagex wouldn't
81                 work if their full path contained a space.
82
83                 Fixed bugs related to scanning SMB filesystems.
84
85                 Added warning message about known issue with WindowsApps folder.
86
87                 Added instructions for building from source on Windows.
88
89                 VSS support is no longer marked "experimental".
90
91                 Added missing license file for libdivsufsort-lite.
92
93 Version 1.9.0:
94         Added experimental support for Windows VSS (Volume Shadow Copy Service).
95         The new '--snapshot' argument to 'wimcapture' makes wimlib automatically
96         create and use a temporary VSS snapshot when capturing a WIM image.
97
98         Implemented setting of Windows-specific XML information, such as
99         architecture, system root, and version details.  This information is now
100         automatically set in newly captured WIM images, when appropriate.
101
102         Improved performance of directory tree scans on Windows.
103
104         On Windows, to improve capture performance, wimlib now sometimes opens
105         files by inode number rather than by path.  This is enabled for
106         wimcapture and wimappend, but for now other applications have to opt-in.
107
108         The progress messages printed by wimlib-imagex while writing WIM files
109         have been slightly tweaked.
110
111         Progress information for directory tree scans now counts all hard links.
112         Also, on Windows "\\?\" is no longer stripped from the current path.
113
114         Added a new '--image-property' option to 'wimcapture', 'wimappend', and
115         'wiminfo'.  This option lets you assign values to elements in a WIM
116         file's XML document by name.
117
118         The wimlib_get_image_property() and wimlib_set_image_property() API
119         functions now support numerically indexed elements.
120
121         Fixed a bug where, on Windows, wimlib would change the security
122         descriptor of the target directory of an extraction even when the
123         '--no-acls' option was specified.
124
125 Version 1.8.3:
126         Fixed a bug with libntfs-3g extraction present since v1.8.1.  Sometimes,
127         some Microsoft software would not correctly recognize data in the
128         resulting filesystem.
129
130         Made some small improvements to the compression algorithms:
131                 LZX compression ratio was slightly improved.
132                 XPRESS compression ratio and speed was slightly improved.
133                 LZMS compression speed was slightly improved.
134
135         Improved handling of WIM XML data.  wimlib no longer drops unrecognized
136         elements when exporting images.  In addition, two API functions were
137         added for better access to elements in the XML document:
138         wimlib_get_image_property() and wimlib_set_image_property().
139
140         Added support for (unsafe) in-place compaction of WIM files.
141
142         Improved performance of image export by reusing metadata resources
143         instead of always rebuilding and recompressing them.
144
145         Improved performance of wimlib_update_image() by delaying the update to
146         the WIM's XML document until a write is requested.
147
148         On Windows, the target of an extraction may now be a reparse point
149         (which will be dereferenced).
150
151         On Windows, wimlib now correctly restores non-Microsoft reparse points.
152         However, this remains broken in NTFS-3g mode due to a libntfs-3g bug.
153
154         On Windows, wimlib now has improved performance when archiving files
155         from a filesystem backed by a WIM (a "WIMBoot" setup).
156
157         Several improvements to System Compression (compact mode) support:
158
159                 wof.sys (or wofadk.sys) is now automatically attached to the
160                 target volume if needed.
161
162                 Compact-mode extractions now work correctly with wofadk.sys on
163                 older versions of Windows.
164
165                 For compatibility with the Windows bootloader, the requested
166                 compression format now is overridden on certain files.
167
168         Other minor bugfixes.
169
170 Version 1.8.2:
171         This release primarily contains various minor bug fixes and
172         improvements, including:
173
174                 Improved handling of deep directory structures.
175
176                 Fixed a bug where on 32-bit systems, the library could enter an
177                 infinite loop if a WIM file was malformed in a specific way.
178
179                 Added a workaround for a case where libntfs-3g may report
180                 duplicate streams in an NTFS file.
181
182                 Windows symbolic links and junctions in mounted WIM images are
183                 now automatically rewritten to be valid in the mounted location.
184
185                 Reparse point fixes: correctly handle the "ReparseReserved"
186                 field, and correctly handle "empty" (data-less) reparse points.
187
188                 On Windows, wimlib now acquires SeManageVolumePrivilege, which
189                 is needed to create externally backed files using the
190                 "wofadk.sys" driver.
191
192                 Improved validation of filenames.
193
194                 Improved LZMS decompression speed.
195
196                 The configure script now honors alternate pkg-config settings.
197
198                 Links have been updated to point to the new website.
199
200         In addition, experimental support has been added for compressing
201         extracted files using System Compression on Windows 10.  This
202         functionality is available through the new '--compact' option to
203         'wimapply' and 'wimextract' as well as new library flags.
204
205 Version 1.8.1:
206         Fixed a bug in the LZX decompressor: malicious input data could cause
207         out of bounds writes to memory (since wimlib v1.2.2).
208
209         The output of the 'wiminfo' command now consolidates various boolean
210         flags (such as "Relative path junction") into a single line.
211
212         A file can now have both an unnamed data stream ("file contents") and a
213         reparse point stream.  Such files can exist as a result of the use of
214         certain Windows features, such as offline storage, including "OneDrive".
215         wimlib will now store and restore both streams on Windows as well as in
216         NTFS-3g mode.  Microsoft's WIMGAPI also has this behavior.
217
218         On Windows, named data streams of encrypted files are no longer stored
219         twice in WIM archives.
220
221         On Windows, named data streams are now correctly extracted to existing
222         "readonly" directories.  Before, an error would be reported.
223
224         On Windows, it is now possible to do a "WIMBoot mode" extraction with
225         non-standalone WIMs such as delta WIMs.
226
227         On Windows, when doing an extraction in "WIMBoot mode", files larger
228         than 4 gigabytes are now never extracted as externally backed.  This
229         works around a bug in Microsoft's "WOF" driver.
230
231         The '--enable-verify-compression' configure option has been removed.  If
232         you want to verify a WIM file, use the 'wimverify' program.
233
234         The way the "file count", "directory count", "total bytes", and "hard
235         link bytes" image statistics (stored in the WIM XML data) is calculated
236         has been slightly changed.
237
238         In mounted WIM images, the disk usage provided for each file (st_blocks)
239         is now the compressed size rather than the uncompressed size.
240
241         The performance of the NTFS-3g and Windows capture modes has been
242         slightly improved.
243
244         On UNIX-like systems, symbolic links whose targets contain the backslash
245         character are now handled correctly (losslessly).
246
247 Version 1.8.0:
248         Improved the LZX compressor.  It is now 15-20% faster than before and
249         provides a slightly better compression ratio.
250
251         Improved the LZMS compressor.  It now provides a compression ratio
252         slightly better than WIMGAPI while still being faster and using slightly
253         less memory.
254
255         The compression chunk size in solid resources, e.g. when capturing or
256         exporting a WIM file using the '--solid' option, now defaults to 64 MiB
257         (67108864 bytes) instead of 32 MiB (33554432 bytes).  This provides a
258         better compression ratio and is the same value that WIMGAPI uses.  The
259         memory usage is less than 50% higher than wimlib v1.7.4 and is slightly
260         lower than WIMGAPI's memory usage, but if it is too much, it is still
261         possible to choose a lower value, e.g. with the '--solid-chunk-size'
262         option to wimlib-imagex.
263
264         The '--chunk-size' and '--solid-chunk-size' options to wimlib-imagex now
265         accept the 'K', 'M', and 'G' suffixes.
266
267         Files are now sorted by name extension when creating a solid WIM file.
268
269         Fixed various issues related to capture/apply of EFS-encrypted files on
270         Windows.
271
272         The file list printed by 'wimdir' is now sorted by the platform-specific
273         case sensitivity setting, rather than always case sensitively.  This
274         also affects the library function wimlib_iterate_dir_tree().
275
276         On Windows, some error and warning messages have been improved.
277
278 Version 1.7.4:
279         The Windows binary distribution no longer contains third party DLLs.
280         These dependencies are instead compiled directly into the libwim DLL.
281
282         Added more fixes for wimlib on non-x86 architectures such as ARM.
283
284         Extracting files to a Windows PE in-memory filesystem no longer fails if
285         the target files do not yet exist.
286
287         Improved the performance of XPRESS compression and LZMS decompression.
288
289         Enabled SSSE3 accelerated SHA-1 computation in x86_64 Windows builds.
290         It will automatically be faster on newer Intel and AMD processors.
291
292         Removed the --with-imagex-progname and --enable-more-assertions
293         configure options.
294
295 Version 1.7.3:
296         Fix for very slow export from solid WIM / ESD files.
297
298         Fix for LZX and LZMS algorithms on non-x86 architectures, such as ARM.
299
300         New progress message: WIMLIB_PROGRESS_MSG_HANDLE_ERROR.  Applications
301         may use this to treat some types of errors as non-fatal.
302
303         The library now permits making in-memory changes to a WIMStruct backed
304         by a read-only WIM file.
305
306         Fixes for "WIMBoot" extraction mode (Windows only):
307
308                 When not using the WOF driver, extraction no longer fails if the
309                 disk containing the WIM file has too many partitions.
310
311                 When matching patterns in [PrepopulateList], all hard links of
312                 each file are now considered.
313
314                 The system registry files are now automatically treated as being
315                 in [PrepopulateList].
316
317                 Added a hack to try to work around an intermittent bug in
318                 Microsoft's WOF (Windows Overlay Filesystem) driver.
319
320 Version 1.7.2:
321         Made more improvements to the XPRESS, LZX, and LZMS compressors.
322
323         A number of improvements to the Windows port:
324
325                 Fixes for setting short filenames.
326
327                 Faster "WIMBoot" extraction.
328
329                 Updated and slimmed down the dependent DLLs.
330
331                 ACL inheritence bits are now restored.
332
333                 Mandatory integrity labels are now backed up and restored.
334
335         Added a workaround for an issue where in rare cases, wimlib could create
336         a compressed data stream that could not be read correctly by Windows
337         after an extraction in "WIMBoot" mode.
338
339         Library changes:
340                 Added file count progress data for
341                 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE and
342                 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
343
344                 Added support for testing file exclusions via the user-provided
345                 progress function.
346
347                 Some documentation improvements.
348
349         Made some clarifications to the license text in the COPYING file.
350
351 Version 1.7.1:
352         Made more improvements to the XPRESS, LZX, and LZMS compressors.
353
354         The default compression mode for wimcapture is now LZX compression in
355         its default mode, which is the same as '--compress=maximum'.
356
357         You can now specify an optional integer compression level to the
358         '--compress' option; e.g. '--compress=lzx:75'.
359
360         Made a minor change to the LZMS compressor and decompressor to fix an
361         incompatibility with the Microsoft implementation.  In the unlikely
362         event that you created an LZMS-compressed WIM with wimlib v1.7.0 or
363         earlier and a checksum error is reported when extracting files from it
364         with wimlib v1.7.1, decompress it with v1.7.0 then compress it with
365         v1.7.1.
366
367         Added 'verify' subcommand to wimlib-imagex.
368
369         Notable library changes:
370
371                 Custom compressor parameters have been removed from the library
372                 in favor of the simpler level-based API.
373
374                 Decompressor parameters have been removed entirely.
375
376                 Library users can now specify a custom file for warning and
377                 error messages to be sent to, rather than the default of
378                 standard error.
379
380                 New progress messages:
381                 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE,
382                 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
383
384                 New function: wimlib_verify_wim().
385
386 Version 1.7.0:
387         Improved compression, decompression, and extraction performance.
388
389         Improved compatibility with version 3584 WIM / ESD files:
390             - Add support for reading and writing multiple solid blocks per
391               archive, which WIMGAPI/DISM can create when appending an image.
392             - Correctly create solid blocks larger than 4 GiB.
393
394         'add' commands passed to wimupdate will now replace existing
395         nondirectory files by default.  Use the --no-replace option to get the
396         old behavior.
397
398         The license for the library now contains an exception that allows using
399         it under the LGPL.  See the COPYING file for details.
400
401         In reparse-point fixup mode (the default for capture), symbolic links
402         and junctions that point outside the tree being captured are no longer
403         excluded from capture.
404
405         Added support for "WIMBoot" capture and extraction.  See the
406         documentation for the new '--wimboot' option to wimcapture and wimapply
407         for more information.
408
409         On UNIX-like systems, you can now backup and restore device nodes, named
410         pipes, and sockets.  In addition, 32-bit user and group IDs are now
411         supported.
412
413         The way that UNIX data is stored in WIM files has been changed.  If you
414         captured any WIMs with the --unix-data option, to upgrade them you'll
415         need to apply them with --unix-data using wimlib-imagex v1.6.2, then
416         re-capture them with --unix-data using this version.
417
418         wimlib now understands tagged metadata items, such as object IDs, that
419         can be stored in WIM directory entries.
420
421         Removed the --hardlink and --symlink options to wimapply, since I don't
422         think they are too useful and they got in the way of improving the code.
423
424         WIMs will now retain their GUIDs when rebuilt (e.g. with wimoptimize).
425
426         The 'mkwinpeimg' script now supports writing the ISO image to standard
427         output.
428
429         The <ARCH> element in WIM XML data is now exported correctly.
430
431         On Windows, sparse file attributes are no longer set on extracted files.
432         Oddly enough, this actually saves disk space in some cases.
433
434         On UNIX, configuring with --disable-xattr or --enable-xattr is no longer
435         supported.  Mounting WIM images now always requires extended attribute
436         support.  Use --without-fuse to disable support for mounting WIM images;
437         this will also disable the need for extended attribute support.
438
439         Configuring with --enable-ssse3-sha1 now works correctly.
440
441         The shared library version has been bumped up.  The main
442         incompatibilities are:
443
444                 - WIMLIB_COMPRESSION_TYPE_XPRESS is now 1 and
445                   WIMLIB_COMPRESSION_TYPE_LZX is now 2 (so it's the same as
446                   WIMGAPI).
447
448                 - User-provided progress functions are now registered using a
449                   separate function, wimlib_register_progress_function().  The
450                   'progress_func' argument to many functions no longer exists.
451
452                 - The return value from user-provided progress functions is now
453                   significant.
454
455                 - A context argument has been added to the prototype of
456                   user-provided progress functions.
457
458                 - 'struct wimlib_capture_config' has been removed.  The library
459                   now takes the path to the configuration file directly.  This
460                   affects wimlib_add_image(), wimlib_add_image_multisource(),
461                   and wimlib_update_image().  However, a NULL value passed in
462                   the argument retains the same meaning.
463
464                 - Removed deprecated functions: some (de)compression functions,
465                   wimlib_extract_files(), and wimlib_print_metadata().
466
467                 - Removed extraction flags: WIMLIB_EXTRACT_FLAG_HARDLINK,
468                   WIMLIB_EXTRACT_FLAG_SYMLINK, WIMLIB_EXTRACT_FLAG_FILE_ORDER,
469                   and WIMLIB_EXTRACT_FLAG_SEQUENTIAL.
470
471                 - Removed some progress messages:
472                   WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
473                   WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
474                   WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END.  Numbering
475                   stays the same.
476
477                 - Removed some error codes.  Numbering stays the same.
478
479                 - Replaced WIMLIB_UNMOUNT_FLAG_LAZY with
480                   WIMLIB_UNMOUNT_FLAG_FORCE.
481
482                 - WIM paths passed to progress functions now have a leading
483                   slash.
484
485 Version 1.6.2:
486         Case-insensitive comparisons of strings (e.g. filenames) containing
487         UTF-16 codepoints above 32767 are now done correctly.
488
489         Fixed build failure on Mac OS X.
490
491         wimunmount now provides the '--new-image' option to cause changes to a
492         read-write mounted image to be committed as a new image rather than as
493         an update of the mounted image.  (The corresponding new library flag is
494         WIMLIB_UNMOUNT_FLAG_NEW_IMAGE.)
495
496         The LZMS ("recovery") compression chunk size, or "dictionary size", may
497         now be up to 1 GiB (1,073,741,824 bytes).
498
499         The performance of LZX ("maximum") and LZMS ("recovery") compression
500         with large chunk sizes has been slightly improved.
501
502 Version 1.6.1:
503         Stored files with size exactly 4 GiB (4,294,967,296 bytes) are now
504         decompressed correctly.
505
506         Fixed a bug in the LZX compressor introduced in v1.5.3.  The bug
507         occurred in an unlikely case, and due to validity checks it did not
508         affect successfully created archives.
509
510         Fixed a minor compatibility issue with the LZMS compressor and
511         decompressor.  This is *not* the default compression type and was only
512         introduced in v1.6.0.  In the unlikely event that you created an
513         LZMS-compressed WIM with v1.6.0 and a checksum error is reported when
514         applying it with v1.6.1, decompress it with v1.6.0 then compress it with
515         v1.6.1.
516
517         Memory usage for LZMS and LZX compression has been decreased.
518
519         wimextract now allows wildcard characters in paths specified on the
520         command line.  Also, the '--strict-wildcards' option has been removed
521         and replaced with the inverse option '--nullglob'.  See the
522         documentation for wimextract for more details and changes.
523
524         The wimlib_extract_files() function is now considered deprecated in
525         favor of wimlib_extract_paths().
526
527         Fixed more permissions problems when extracting files on Windows.
528
529         A new '--no-attributes' option has been added to wimapply and
530         wimextract.  The library flag is WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES.
531
532         The default chunk size is now set correctly when changing the
533         compression type of a WIM, for example with 'wimoptimize'.
534
535         The '--metadata' option to wiminfo has been replaced with the
536         '--detailed' option to wimdir.
537
538         In relevant wimlib-imagex commands, '--solid' may now be used as an
539         alias for '--pack-streams'.
540
541 Version 1.6.0:
542         Support for extracting and updating the new version 3584 WIMs has been
543         added.  These WIMs typically pack many streams ("files") together into a
544         single compressed resource, thereby saving space.  This degrades the
545         performance of random access (such as that which occurs on a mounted
546         image), but optimizations have been implemented for extraction.  These
547         new WIM files also typically use a new compression format (LZMS), which
548         is similar to LZMA and can offer a better compression ratio than LZX.
549         These new WIM files can be created using `wimcapture' with
550         the '--compress=lzms --pack-streams' options.  Note: this new WIM format
551         is used by the Windows 8 web downloader, but important segments of the
552         raw '.esd' files are encrypted, so wimlib will not be able to extract
553         such files until they are first decrypted.
554
555         wimlib now supports extracting files and directories from a WIM image
556         based on a "listfile" that itself contains the list of paths to extract.
557         For `wimextract', the syntax is to specify @LISTFILE instead of a PATH,
558         and for the library itself, the new APIs are wimlib_extract_pathlist()
559         and wimlib_extract_paths().  Path globs containing wildcard characters
560         are supported.
561
562         For searching WIM files, wimlib now has configurable case sensitivity.
563         The default on Windows is still case-insensitive and the default on
564         UNIX-like systems is still case-sensitive, but this can be overridden
565         on either platform through flags to wimlib_global_init().  For
566         `wimlib-imagex', the environmental variable WIMLIB_IMAGEX_IGNORE_CASE
567         can be set to 1 or 0 for case-insensitive or case-sensitive behavior,
568         respectively.
569
570         Support for compression chunk sizes greater than the default of 32768
571         bytes has been added.  A larger chunk size typically results in a better
572         compression ratio.  However, the MS implementation is seemingly not
573         compatible with all chunk sizes, especially for LZX compression, so the
574         defaults remain unchanged, with the exception of the new LZMS-compressed
575         WIMs, which use a larger chunk size by default.
576
577         The compression/decompression API exported by wimlib has been changed.
578         Now one set of functions handles all supported compression formats.
579
580         `wimcapture' and `wimappend' will now display the progress of scanning
581         the directory tree to capture, in addition to the progress of writing
582         data to the WIM.  The '--verbose' option no longer does anything.  The
583         library API change for this is the addition of several members to
584         `struct wimlib_progress_info_scan' available to progress callbacks.
585
586         `mkwinpeimg' now correctly handles the '--start-script' option when the
587         start script is not in the working directory.
588
589         Sequential extraction, previously requested by using
590         WIMLIB_EXTRACT_FLAG_SEQUENTIAL, is now the default.
591         WIMLIB_EXTRACT_FLAG_FILE_ORDER can be used to get the old default
592         behavior (extract in file order).
593
594 Version 1.5.3:
595         The new LZX compressor added in v1.5.2 has been improved and is now
596         enabled by default, except when `wimcapture' or `wimappend' is run
597         *without* the '--compress' option, in which case the faster LZX
598         compressor is used (the same as before).  This behavior is reasonably
599         consistent with ImageX which actually uses "fast" (XPRESS) compression
600         by default.  In those cases, use '--compress=maximum' to explicitly
601         capture a WIM image using the new (slower but better) LZX compressor.
602
603         The '--compress-slow' option still exists to `wimlib-imagex optimize',
604         but its new behavior is to tweak the new LZX compressor even more to
605         produce an even better compression ratio at the cost of more time spent
606         compressing.
607
608         `wimlib-imagex optimize' now supports the '--compress=TYPE' option,
609         which recompresses the WIM file using the specified compression TYPE.
610         The new library API function used for this is
611         wimlib_set_output_compression_type().
612
613         Added the wimlib_get_xml_data() function to allow library clients to
614         easily retrieve the raw XML data from a WIM file if needed.
615
616         Fixed a bug that could cause an error code to be incorrectly returned
617         when writing XML data containing a <WINDOWS> element.
618
619         Mounted WIM images will now correctly show the default file stream even
620         if appears in the alternate data stream entries of the corresponding WIM
621         directory entry.
622
623 Version 1.5.2:
624         Added a new experimental LZX compressor which can be enabled by passing
625         '--compress-slow' to `wimlib-imagex capture' or `wimlib-imagex
626         optimize'.  (The latter is only applicable if the WIM is already
627         LZX-compressed and the '--recompress' option is also given.)  The
628         experimental compressor is much slower but compresses the data slightly
629         more --- currently usually to within a fraction of a percent of the
630         results from WIMGAPI/ImageX.
631
632         A workaround has been added for compatibility with versions of WinPE
633         that interpret alternate data stream entries in the boot WIM
634         incorrectly.
635
636         An alignment bug that caused a crash in the LZX decompressor on some
637         builds was fixed.
638
639         wimlib now attempts to clear the WIM_HDR_FLAG_WRITE_IN_PROGRESS flag in
640         the WIM header when restoring the previous state of a WIM it failed to
641         successfully update.
642
643         Added a workaround to avoid an access denied error on Windows when
644         replacing a WIM file that another process has opened.
645
646 Version 1.5.1:
647         wimlib can now open WinPE WIMs from WAIK v2.1, which had a quirk that
648         needed to be handled.
649
650         A bug in the interpretation of negative IMAGE indices in the
651         --update-of=[WIMFILE:]IMAGE option to `wimlib-imagex capture' and
652         `wimlib-imagex append' has been fixed.
653
654         A workaround has been added to successfully apply security descriptors
655         with empty DACLs when the NTFS-3g apply mode is being used with NTFS-3g
656         2013.1.13 or earlier.
657
658         `wimlib-imagex capture' can now accept the '--delta-from' option
659         multiple times.
660
661 Version 1.5.0:
662         Added support for "pipable" WIMs.  Pipable WIMs allow capturing images
663         to standard output and applying images from standard input, but they are
664         not compatible with Microsoft's software and are not created by default.
665         See the documentation for --pipable flag of `wimlib-imagex capture' for
666         more information.
667
668         To better support incremental backups, added support for declaring an
669         image as a modified form of another image.  See the documentation for
670         the '--update-of' option of `wimlib-imagex append' and `wimlib-imagex
671         capture'.
672
673         Added supported for "delta" WIMs.  See the documentation for the
674         '--delta-from' option of `wimlib-imagex capture'.
675
676         The library support for managing split WIMs has been changed to support
677         other arrangements, such as delta WIMs, and be easier to use.  This
678         change is visible in `wimlib-imagex', which also can now accept the
679         '--ref' option multiple times, and also now supports "delta" WIMs as
680         mentioned above.
681
682         wimlib now preserves WIM integrity tables by default, even if
683         WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is not specified.  This changes the
684         behavior of `wimlib-imagex' whenever the WIM being operated on contains
685         an integrity table and the '--check' option is not specified.
686
687         `wimlib-imagex capture' now creates LZX-compressed WIMs by default
688         (when --compress is not specified).  This provides the best compression
689         ratio by default, which is usually what is desired, at a cost of some
690         speed.
691
692         `wimlib-imagex' now supports being invoked as wimCOMMAND, where COMMAND
693         is the command as in `wimlib-imagex COMMAND'; for example, it can be
694         invoked as `wimapply' as an alternative to `wimlib-imagex apply'.  The
695         appropriate hard links are created in UNIX installations of
696         `wimlib-imagex', while for the Windows distribution of `wimlib-imagex',
697         batch files that emulate this behavior are generated.
698
699         Security descriptors are now extracted correctly on Windows.
700
701         Fixed archiving DOS names in NTFS-3g capture mode.
702
703         The extraction code has been rewritten and it will now be easier to
704         support new features on all supported backends (currently Win32, UNIX,
705         and NTFS-3g).  For example, hard-linked extraction mode (--hardlink) is
706         now supported on all backends, not just UNIX.
707
708         `mkwinpeimg' now supports grabbing files from the WAIK supplement rather
709         than the WAIK itself.
710
711         wimlib_global_init() now, by default, attempts to acquire additional
712         privileges on Windows, so library clients need not do this.
713
714         This update bumps the shared library version number up to 9, since it is
715         not binary compatibible with previous releases.
716
717 Version 1.4.2:
718         Fixed bug in `wimlib-imagex export' that made it impossible to export an
719         image from a WIM that is readonly at the filesystem level.
720
721         Return error code rather than segfaulting when trying to list files from
722         a non-first part of a split WIM.
723
724         Joining a WIM will now preserve the RP_FIX and READONLY flags.
725
726 Version 1.4.1:
727         On Windows, paths given to wimlib-imagex are now treated case
728         insensitively.
729
730         Improved behavior regarding invalid filenames; in particular, on
731         Windows, wimlib-imagex will, when extracting, now omit (with an option
732         to override this default) filenames differing only in case, or filenames
733         containing characters not valid on Windows.
734
735         On Windows, wimlib now supports capturing and extracting long paths
736         (longer than the so-called MAX_PATH).
737
738         On Windows, `wimlib-imagex update' now acquires proper privileges when
739         running as an Administrator.
740
741         `wimlib-imagex update' will now complain if no image is specified when
742         trying to update a multi-image WIM.
743
744         `wimlib-imagex update' now supports specifying a single update command
745         directly on the command line using the --command option.
746
747         wimlib-imagex will now choose different units for progress messages,
748         depending on the amount of data that needs to be processed.
749
750         `wimlib-imagex append' will now generate a unique WIM image name if no
751         name is specified and the defaulted name already exists in the WIM.
752
753         wimlib now allows you to create unnamed WIM images, which can then only
754         be referred to by index.
755
756         wimlib now allows you to explicitly declare you want write access to a
757         WIM by providing the WIMLIB_OPEN_FLAG_WRITE_ACCESS flag to
758         wimlib_open_wim().
759
760         wimlib now respects the WIM_HDR_FLAG_READONLY flag when set in the WIM
761         header.
762
763         Progress callbacks have been added to wimlib's wimlib_update_image()
764         function.
765
766         Added wimlib_get_wim_info(), wimlib_set_wim_info(),
767         wimlib_iterate_dir_tree(), and wimlib_iterate_lookup_table() functions
768         to the library.
769
770         NTFS-3g capture now only warns about two conditions previously treated
771         as errors.
772
773         Fixed a couple issues with using wimlib-imagex on UDF filesystems on
774         Windows.
775
776         wimlib now correctly detects and returns an error when reading a WIM
777         image with a cyclic directory structure.  (Fun fact: such a WIM will
778         crash Microsoft's software.)
779
780 Version 1.4.0:
781         Added new "extract" and "update" subcommands to wimlib-imagex, along
782         with associated APIs in the library.  These commands are intended mainly
783         for Windows use but can be used on UNIX as well.
784
785         Many documentation improvements.
786
787         Fixed a bug in the Windows build where relative symbolic links were not
788         captured in reparse-point fixup mode.
789
790         Fixed a bug in the Windows build where file handles were left open to
791         the WIM file, causing `wimlib_imagex optimize' to fail in some cases.
792
793         Fixed a bug in the Windows build of wimlib-imagex where globbing
794         split-WIM parts could cause the program to crash.
795
796         Fixed a bug where the creation time of WIM images would be shown instead
797         of the last modification time.
798
799         With the Windows build it is now possible to restore a WIM containing
800         symbolic links as a non-Administrator; however you will receive warnings
801         about not being able to extract the symbolic links.
802
803 Version 1.3.3:
804         Capturing a WIM image should now be significantly faster in most cases
805         due to improved use of the operating system's cache and avoiding reading
806         files twice whenever possible.
807
808         The Windows build should now work on Windows XP.
809
810         The Windows build now supports capturing and restoring hidden,
811         compressed, sparse, and encrypted files.
812
813         The Windows build now supports capturing and applying WIM images from
814         filesystems other than NTFS (with some reduced functionality).
815
816         The Windows build now extracts short names correctly.
817
818         Added support for "reparse-point" fixups (i.e. fixing up of symbolic
819         links).  See docs for --rpfix and --norpfix flags of `wimlib-imagex
820         capture' and `wimlib-imagex apply'.
821
822         The performance of splitting and joining WIMs should be slightly
823         improved.
824
825         The LZX and XPRESS compression and decompression functions are now
826         exported from the library.
827
828 Version 1.3.2:
829         Improvements and bugfixes for the Windows build.
830
831         Added --strict-acls options.
832
833         Fixed the way that wimlib determines the order of images in the WIM.
834
835 Version 1.3.1:
836         Since wimlib can now be used on Windows, wimlib's implementation of
837         ImageX has been renamed to wimlib-imagex to avoid confusion with
838         Microsoft's implementation of ImageX, which would have the same file
839         name ("imagex.exe").  If you really don't like this you can pass the
840         --with-imagex-progname option to `configure' to choose a different name,
841         or even simply rename the binary yourself (but the former way will
842         configure the man pages to use the chosen name).
843
844         Various bugs fixed in the Windows build.  Mainly to do with capturing
845         and restoring alternate data streams correctly in weird cases, and
846         requesting the correct privileges when opening files.  Also added the
847         --noacls options to wimlib-imagex capture, append, and apply.
848
849         Windows build again: FindFirstStreamW() and FindNextStreamW() are now
850         dynamically loaded, so this may make the library compatible with Windows
851         XP (however, there may still be other problems).
852
853 Version 1.3.0:
854         Added experimental support for native Windows builds.  Binaries can be
855         downloaded from the SourceForge page.
856
857         --source-list option added to `imagex capture' and `imagex append'.
858
859         Better support for different character encodings.
860
861 Version 1.2.6:
862         Storing UNIX file owners, groups, and modes in WIM images is now
863         possible using `imagex capture' with the --unix-data flag.
864
865         Minor bug fixes and documentation fixes.
866
867 Version 1.2.5:
868         NTFS capture: Fixed capturing duplicate reparse points.
869
870         NTFS capture: Capture first unnamed stream if there are more than one
871         (print warning instead of error).
872
873         Allow multiple test cases to execute concurrently (e.g. make -j2 check).
874
875 Version 1.2.4:
876         Added --arch switch to mkwinpeimg script to support getting AMD64 WinPE
877         from the WAIK.
878
879         Update to work with ntfs-3g version 2013.1.13.
880
881 Version 1.2.3:
882         Fixed truncating file to shorter but non-zero length on read-write
883         mounted WIM image.
884
885         Various code cleanups and minor documentation fixes.
886
887 Version 1.2.2:
888         LZX and XPRESS decompression have received some additional optimizations
889         and should now be even faster.  (Although, they were already pretty
890         fast--- much faster than typical I/O speeds.)
891
892         Fixed a bug introduced in v1.2.1 that would cause a directory tree
893         containing hard links to be captured incorrectly in some cases.
894
895 Version 1.2.1:
896         By default, unmounting a read-write mounted WIM with 'imagex unmount
897         --commit' will now change the WIM in-place without needing to write the
898         entire WIM again.  Use 'imagex unmount --commit --rebuild' to get the
899         old behavior.
900
901         'imagex unmount' no longer has a hard-coded limit of 10 minutes to wait
902         for a response from the daemon servicing the mounted WIM.  Instead,
903         every second 'imagex unmount' will check if the daemon is still alive,
904         and keep waiting if so, otherwise terminate with an error.
905
906         'imagex unmount --commit' on a read-write mounted WIM will now print
907         progress information regarding the writing of new or modified streams
908         the WIM, just like when capturing or appending a WIM.
909
910         A small change has been made to XPRESS compression and it should improve
911         the compression ratio slightly.
912
913         A change was made that may improve performance slightly when applying a
914         WIM image to a NTFS volume.
915
916         Microsoft has managed to introduce even more bugs into their software,
917         and now the WIMs for Windows 8 have incorrect (too low) reference counts
918         for some streams.  This is unsafe because such streams can be removed
919         when they are in actuality still referenced in the WIM (perhaps by a
920         different image).  wimlib will now work around this problem by fixing
921         the stream reference counts.  This is only done when wimlib_delete_image() is
922         called ('imagex delete') or when wimlib_mount_image() is called with
923         WIMLIB_MOUNT_FLAG_READWRITE ('imagex mountrw').  Please note that this
924         requires reading the metadata for all images in the WIM, so this will
925         make these operations noticably slower on WIMs with multiple images.
926
927         Various other bugfixes.
928
929 Version 1.2.0:
930         Appending images to a WIM is now be done by default without re-building
931         the whole WIM.  Use the --rebuild flag to get the old behavior (which
932         was to re-build the entire WIM when a new image is appended).
933
934         A new command `imagex optimize' is now available to manually re-build a
935         WIM that has wasted space due to repeated appends.
936
937         Progress information has been improved, and now arbitrary callback
938         functions can be used to show the progress of a WIM operation.
939
940         A possible bug with changing the bootable image of a WIM was fixed.
941
942         Some advisory locking is now done to prevent two processes from
943         modifying a WIM at the same time (but only in some cases).  For example,
944         you cannot mount two images from a WIM read-write at the same time.
945
946         Some functions have been reorganized:
947                 * wimlib_mount() renamed to wimlib_mount_image().
948                 * wimlib_unmount() renamed to wimlib_unmount_image().
949                 * wimlib_overwrite_xml_and_header() removed as
950                 wimlib_overwrite() suffices now.
951                 * wimlib_apply_image_to_ntfs_volume() removed as
952                 wimlib_extract_image() suffices now.
953                 * wimlib_add_image_from_ntfs_volume() removed as
954                 * wimlib_add_image() suffices now.
955
956         Previously, the soname of libwim.so has been 0.0.0, despite many
957         interface changes.  The soname is now updated to 1.0.0 and will now be
958         updated each release.
959
960 Version 1.1.0:
961         Resources will now be compressed using multiple threads by default.
962         (This applies to `imagex capture', `imagex append', and `imagex
963         export').
964
965         Some performance improvements in mounted WIMs.
966
967         More progress information is shown when capturing a WIM.
968
969 Version 1.0.4:
970         Lots of minor fixes, code cleanups, and some documentation updates.
971         Nothing in particular is really noteworthy.
972
973 Version 1.0.3:
974         LZX and XPRESS compression improvements.
975
976         Fixed calculation of Directory Count, File Count, Total Bytes, and Hard
977         Link Bytes of the WIM.
978
979 Version 1.0.2:
980         Fixed bug when capturing NTFS file with multiple named data streams.
981
982         Internally, we are now using inode structures, even though these don't
983         appear literally in the WIM file.  This simplifies some of the code
984         (mainly for WIM mounting) and likely fixed a few problems, although it
985         needs more testing.
986
987 Version 1.0.1:
988         Fixed problem when exporting images from XPRESS to LZX compressed WIM or
989         vice versa
990
991 Version 1.0.0:
992         Enough changes to call it version 1.0.0!
993
994         Capturing a WIM directly from a NTFS volume, and applying a WIM directly
995         to a NTFS volume, is now supported.
996
997         Hard links and symbolic links have much improved support.  They are
998         supported for WIM capture, WIM application, and mounted WIMs (you can
999         even make them on read-write mounted WIMs).
1000
1001         Alternate data streams are now supported on mounted WIMs through an
1002         xattr or a Windows-style stream interface.  Also they are supported when
1003         capturing a WIM from NTFS or applying a WIM to NTFS.
1004
1005         Split WIMs are better supported.  You may now apply an image directly
1006         from a split WIM, mount an image from a split WIM read-only, or export
1007         an image from a split WIM.
1008
1009         Using a capture configuration file is now supported (but not fully yet).
1010
1011         SHA1 message digests are checked in more places, so we can make sure
1012         applied and captured data is correct.
1013
1014         Man pages have been updated and consolidated.
1015
1016 Version 0.7.2:
1017         Fixed segfault when unmounting read-only WIM.
1018
1019 Version 0.7.1:
1020         Support for joining and splitting WIMs.
1021         Also, security data is now preserved by default.
1022
1023 Version 0.6.3:
1024         Can now build with older gcc and system headers, like on CentOS 5.
1025
1026 Version 0.6.2:
1027         Fixed bug that made it impossible to overwrite files in read-write
1028         mount.
1029
1030 Version 0.6.1:
1031         Write byte-order mark before WIM XML data.  (imagex.exe requires this to
1032         be there.)