Windows build updates
[wimlib] / NEWS
1 Version 1.7.4-BETA:
2         Extracting files to a Windows PE in-memory filesystem no longer fails if
3         the target files do not yet exist.  (Broken since v1.7.0, but actually a
4         result of a Microsoft bug.)
5
6         The Windows binary distribution no longer contain third party DLLs.
7         These dependencies are instead compiled directly into libwim.dll.
8
9         More fixes for wimlib on non-x86 architectures such as ARM.
10
11         Slight performance improvements in compression and decompression.
12
13         Removed the --with-imagex-progname and --enable-more-assertions
14         configure options.
15
16 Version 1.7.3:
17         Fix for very slow export from solid WIM / ESD files.
18
19         Fix for LZX and LZMS algorithms on non-x86 architectures, such as ARM.
20
21         New progress message: WIMLIB_PROGRESS_MSG_HANDLE_ERROR.  Applications
22         may use this to treat some types of errors as non-fatal.
23
24         The library now permits making in-memory changes to a WIMStruct backed
25         by a read-only WIM file.
26
27         Fixes for "WIMBoot" extraction mode (Windows only):
28
29                 When not using the WOF driver, extraction no longer fails if the
30                 disk containing the WIM file has too many partitions.
31
32                 When matching patterns in [PrepopulateList], all hard links of
33                 each file are now considered.
34
35                 The system registry files are now automatically treated as being
36                 in [PrepopulateList].
37
38                 Added a hack to try to work around an intermittent bug in
39                 Microsoft's WOF (Windows Overlay Filesystem) driver.
40
41 Version 1.7.2:
42         Made more improvements to the XPRESS, LZX, and LZMS compressors.
43
44         A number of improvements to the Windows port:
45
46                 Fixes for setting short filenames.
47
48                 Faster "WIMBoot" extraction.
49
50                 Updated and slimmed down the dependent DLLs.
51
52                 ACL inheritence bits are now restored.
53
54                 Mandatory integrity labels are now backed up and restored.
55
56         Added a workaround for an issue where in rare cases, wimlib could create
57         a compressed data stream that could not be read correctly by Windows
58         after an extraction in "WIMBoot" mode.
59
60         Library changes:
61                 Added file count progress data for
62                 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE and
63                 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
64
65                 Added support for testing file exclusions via the user-provided
66                 progress function.
67
68                 Some documentation improvements.
69
70         Made some clarifications to the license text in the COPYING file.
71
72 Version 1.7.1:
73         Made more improvements to the XPRESS, LZX, and LZMS compressors.
74
75         The default compression mode for wimcapture is now LZX compression in
76         its default mode, which is the same as '--compress=maximum'.
77
78         You can now specify an optional integer compression level to the
79         '--compress' option; e.g. '--compress=lzx:75'.
80
81         Made a minor change to the LZMS compressor and decompressor to fix an
82         incompatibility with the Microsoft implementation.  In the unlikely
83         event that you created an LZMS-compressed WIM with wimlib v1.7.0 or
84         earlier and a checksum error is reported when extracting files from it
85         with wimlib v1.7.1, decompress it with v1.7.0 then compress it with
86         v1.7.1.
87
88         Added 'verify' subcommand to wimlib-imagex.
89
90         Notable library changes:
91
92                 Custom compressor parameters have been removed from the library
93                 in favor of the simpler level-based API.
94
95                 Decompressor parameters have been removed entirely.
96
97                 Library users can now specify a custom file for warning and
98                 error messages to be sent to, rather than the default of
99                 standard error.
100
101                 New progress messages:
102                 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE,
103                 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
104
105                 New function: wimlib_verify_wim().
106
107 Version 1.7.0:
108         Improved compression, decompression, and extraction performance.
109
110         Improved compatibility with version 3584 WIM / ESD files:
111             - Add support for reading and writing multiple solid blocks per
112               archive, which WIMGAPI/DISM can create when appending an image.
113             - Correctly create solid blocks larger than 4 GiB.
114
115         'add' commands passed to wimupdate will now replace existing
116         nondirectory files by default.  Use the --no-replace option to get the
117         old behavior.
118
119         The license for the library now contains an exception that allows using
120         it under the LGPL.  See the COPYING file for details.
121
122         In reparse-point fixup mode (the default for capture), symbolic links
123         and junctions that point outside the tree being captured are no longer
124         excluded from capture.
125
126         Added support for "WIMBoot" capture and extraction.  See the
127         documentation for the new '--wimboot' option to wimcapture and wimapply
128         for more information.
129
130         On UNIX-like systems, you can now backup and restore device nodes, named
131         pipes, and sockets.  In addition, 32-bit user and group IDs are now
132         supported.
133
134         The way that UNIX data is stored in WIM files has been changed.  If you
135         captured any WIMs with the --unix-data option, to upgrade them you'll
136         need to apply them with --unix-data using wimlib-imagex v1.6.2, then
137         re-capture them with --unix-data using this version.
138
139         wimlib now understands tagged metadata items, such as object IDs, that
140         can be stored in WIM directory entries.
141
142         Removed the --hardlink and --symlink options to wimapply, since I don't
143         think they are too useful and they got in the way of improving the code.
144
145         WIMs will now retain their GUIDs when rebuilt (e.g. with wimoptimize).
146
147         The 'mkwinpeimg' script now supports writing the ISO image to standard
148         output.
149
150         The <ARCH> element in WIM XML data is now exported correctly.
151
152         On Windows, sparse file attributes are no longer set on extracted files.
153         Oddly enough, this actually saves disk space in some cases.
154
155         On UNIX, configuring with --disable-xattr or --enable-xattr is no longer
156         supported.  Mounting WIM images now always requires extended attribute
157         support.  Use --without-fuse to disable support for mounting WIM images;
158         this will also disable the need for extended attribute support.
159
160         Configuring with --enable-ssse3-sha1 now works correctly.
161
162         The shared library version has been bumped up.  The main
163         incompatibilities are:
164
165                 - WIMLIB_COMPRESSION_TYPE_XPRESS is now 1 and
166                   WIMLIB_COMPRESSION_TYPE_LZX is now 2 (so it's the same as
167                   WIMGAPI).
168
169                 - User-provided progress functions are now registered using a
170                   separate function, wimlib_register_progress_function().  The
171                   'progress_func' argument to many functions no longer exists.
172
173                 - The return value from user-provided progress functions is now
174                   significant.
175
176                 - A context argument has been added to the prototype of
177                   user-provided progress functions.
178
179                 - 'struct wimlib_capture_config' has been removed.  The library
180                   now takes the path to the configuration file directly.  This
181                   affects wimlib_add_image(), wimlib_add_image_multisource(),
182                   and wimlib_update_image().  However, a NULL value passed in
183                   the argument retains the same meaning.
184
185                 - Removed deprecated functions: some (de)compression functions,
186                   wimlib_extract_files(), and wimlib_print_metadata().
187
188                 - Removed extraction flags: WIMLIB_EXTRACT_FLAG_HARDLINK,
189                   WIMLIB_EXTRACT_FLAG_SYMLINK, WIMLIB_EXTRACT_FLAG_FILE_ORDER,
190                   and WIMLIB_EXTRACT_FLAG_SEQUENTIAL.
191
192                 - Removed some progress messages:
193                   WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
194                   WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
195                   WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END.  Numbering
196                   stays the same.
197
198                 - Removed some error codes.  Numbering stays the same.
199
200                 - Replaced WIMLIB_UNMOUNT_FLAG_LAZY with
201                   WIMLIB_UNMOUNT_FLAG_FORCE.
202
203                 - WIM paths passed to progress functions now have a leading
204                   slash.
205
206 Version 1.6.2:
207         Case-insensitive comparisons of strings (e.g. filenames) containing
208         UTF-16 codepoints above 32767 are now done correctly.
209
210         Fixed build failure on Mac OS X.
211
212         wimunmount now provides the '--new-image' option to cause changes to a
213         read-write mounted image to be committed as a new image rather than as
214         an update of the mounted image.  (The corresponding new library flag is
215         WIMLIB_UNMOUNT_FLAG_NEW_IMAGE.)
216
217         The LZMS ("recovery") compression chunk size, or "dictionary size", may
218         now be up to 1 GiB (1,073,741,824 bytes).
219
220         The performance of LZX ("maximum") and LZMS ("recovery") compression
221         with large chunk sizes has been slightly improved.
222
223 Version 1.6.1:
224         Stored files with size exactly 4 GiB (4,294,967,296 bytes) are now
225         decompressed correctly.
226
227         Fixed a bug in the LZX compressor introduced in v1.5.3.  The bug
228         occurred in an unlikely case, and due to validity checks it did not
229         affect successfully created archives.
230
231         Fixed a minor compatibility issue with the LZMS compressor and
232         decompressor.  This is *not* the default compression type and was only
233         introduced in v1.6.0.  In the unlikely event that you created an
234         LZMS-compressed WIM with v1.6.0 and a checksum error is reported when
235         applying it with v1.6.1, decompress it with v1.6.0 then compress it with
236         v1.6.1.
237
238         Memory usage for LZMS and LZX compression has been decreased.
239
240         wimextract now allows wildcard characters in paths specified on the
241         command line.  Also, the '--strict-wildcards' option has been removed
242         and replaced with the inverse option '--nullglob'.  See the
243         documentation for wimextract for more details and changes.
244
245         The wimlib_extract_files() function is now considered deprecated in
246         favor of wimlib_extract_paths().
247
248         Fixed more permissions problems when extracting files on Windows.
249
250         A new '--no-attributes' option has been added to wimapply and
251         wimextract.  The library flag is WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES.
252
253         The default chunk size is now set correctly when changing the
254         compression type of a WIM, for example with 'wimoptimize'.
255
256         The '--metadata' option to wiminfo has been replaced with the
257         '--detailed' option to wimdir.
258
259         In relevant wimlib-imagex commands, '--solid' may now be used as an
260         alias for '--pack-streams'.
261
262 Version 1.6.0:
263         Support for extracting and updating the new version 3584 WIMs has been
264         added.  These WIMs typically pack many streams ("files") together into a
265         single compressed resource, thereby saving space.  This degrades the
266         performance of random access (such as that which occurs on a mounted
267         image), but optimizations have been implemented for extraction.  These
268         new WIM files also typically use a new compression format (LZMS), which
269         is similar to LZMA and can offer a better compression ratio than LZX.
270         These new WIM files can be created using `wimcapture' with
271         the '--compress=lzms --pack-streams' options.  Note: this new WIM format
272         is used by the Windows 8 web downloader, but important segments of the
273         raw '.esd' files are encrypted, so wimlib will not be able to extract
274         such files until they are first decrypted.
275
276         wimlib now supports extracting files and directories from a WIM image
277         based on a "listfile" that itself contains the list of paths to extract.
278         For `wimextract', the syntax is to specify @LISTFILE instead of a PATH,
279         and for the library itself, the new APIs are wimlib_extract_pathlist()
280         and wimlib_extract_paths().  Path globs containing wildcard characters
281         are supported.
282
283         For searching WIM files, wimlib now has configurable case sensitivity.
284         The default on Windows is still case-insensitive and the default on
285         UNIX-like systems is still case-sensitive, but this can be overridden
286         on either platform through flags to wimlib_global_init().  For
287         `wimlib-imagex', the environmental variable WIMLIB_IMAGEX_IGNORE_CASE
288         can be set to 1 or 0 for case-insensitive or case-sensitive behavior,
289         respectively.
290
291         Support for compression chunk sizes greater than the default of 32768
292         bytes has been added.  A larger chunk size typically results in a better
293         compression ratio.  However, the MS implementation is seemingly not
294         compatible with all chunk sizes, especially for LZX compression, so the
295         defaults remain unchanged, with the exception of the new LZMS-compressed
296         WIMs, which use a larger chunk size by default.
297
298         The compression/decompression API exported by wimlib has been changed.
299         Now one set of functions handles all supported compression formats.
300
301         `wimcapture' and `wimappend' will now display the progress of scanning
302         the directory tree to capture, in addition to the progress of writing
303         data to the WIM.  The '--verbose' option no longer does anything.  The
304         library API change for this is the addition of several members to
305         `struct wimlib_progress_info_scan' available to progress callbacks.
306
307         `mkwinpeimg' now correctly handles the '--start-script' option when the
308         start script is not in the working directory.
309
310         Sequential extraction, previously requested by using
311         WIMLIB_EXTRACT_FLAG_SEQUENTIAL, is now the default.
312         WIMLIB_EXTRACT_FLAG_FILE_ORDER can be used to get the old default
313         behavior (extract in file order).
314
315 Version 1.5.3:
316         The new LZX compressor added in v1.5.2 has been improved and is now
317         enabled by default, except when `wimcapture' or `wimappend' is run
318         *without* the '--compress' option, in which case the faster LZX
319         compressor is used (the same as before).  This behavior is reasonably
320         consistent with ImageX which actually uses "fast" (XPRESS) compression
321         by default.  In those cases, use '--compress=maximum' to explicitly
322         capture a WIM image using the new (slower but better) LZX compressor.
323
324         The '--compress-slow' option still exists to `wimlib-imagex optimize',
325         but its new behavior is to tweak the new LZX compressor even more to
326         produce an even better compression ratio at the cost of more time spent
327         compressing.
328
329         `wimlib-imagex optimize' now supports the '--compress=TYPE' option,
330         which recompresses the WIM file using the specified compression TYPE.
331         The new library API function used for this is
332         wimlib_set_output_compression_type().
333
334         Added the wimlib_get_xml_data() function to allow library clients to
335         easily retrieve the raw XML data from a WIM file if needed.
336
337         Fixed a bug that could cause an error code to be incorrectly returned
338         when writing XML data containing a <WINDOWS> element.
339
340         Mounted WIM images will now correctly show the default file stream even
341         if appears in the alternate data stream entries of the corresponding WIM
342         directory entry.
343
344 Version 1.5.2:
345         Added a new experimental LZX compressor which can be enabled by passing
346         '--compress-slow' to `wimlib-imagex capture' or `wimlib-imagex
347         optimize'.  (The latter is only applicable if the WIM is already
348         LZX-compressed and the '--recompress' option is also given.)  The
349         experimental compressor is much slower but compresses the data slightly
350         more --- currently usually to within a fraction of a percent of the
351         results from WIMGAPI/ImageX.
352
353         A workaround has been added for compatibility with versions of WinPE
354         that interpret alternate data stream entries in the boot WIM
355         incorrectly.
356
357         An alignment bug that caused a crash in the LZX decompressor on some
358         builds was fixed.
359
360         wimlib now attempts to clear the WIM_HDR_FLAG_WRITE_IN_PROGRESS flag in
361         the WIM header when restoring the previous state of a WIM it failed to
362         successfully update.
363
364         Added a workaround to avoid an access denied error on Windows when
365         replacing a WIM file that another process has opened.
366
367 Version 1.5.1:
368         wimlib can now open WinPE WIMs from WAIK v2.1, which had a quirk that
369         needed to be handled.
370
371         A bug in the interpretation of negative IMAGE indices in the
372         --update-of=[WIMFILE:]IMAGE option to `wimlib-imagex capture' and
373         `wimlib-imagex append' has been fixed.
374
375         A workaround has been added to successfully apply security descriptors
376         with empty DACLs when the NTFS-3g apply mode is being used with NTFS-3g
377         2013.1.13 or earlier.
378
379         `wimlib-imagex capture' can now accept the '--delta-from' option
380         multiple times.
381
382 Version 1.5.0:
383         Added support for "pipable" WIMs.  Pipable WIMs allow capturing images
384         to standard output and applying images from standard input, but they are
385         not compatible with Microsoft's software and are not created by default.
386         See the documentation for --pipable flag of `wimlib-imagex capture' for
387         more information.
388
389         To better support incremental backups, added support for declaring an
390         image as a modified form of another image.  See the documentation for
391         the '--update-of' option of `wimlib-imagex append' and `wimlib-imagex
392         capture'.
393
394         Added supported for "delta" WIMs.  See the documentation for the
395         '--delta-from' option of `wimlib-imagex capture'.
396
397         The library support for managing split WIMs has been changed to support
398         other arrangements, such as delta WIMs, and be easier to use.  This
399         change is visible in `wimlib-imagex', which also can now accept the
400         '--ref' option multiple times, and also now supports "delta" WIMs as
401         mentioned above.
402
403         wimlib now preserves WIM integrity tables by default, even if
404         WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is not specified.  This changes the
405         behavior of `wimlib-imagex' whenever the WIM being operated on contains
406         an integrity table and the '--check' option is not specified.
407
408         `wimlib-imagex capture' now creates LZX-compressed WIMs by default
409         (when --compress is not specified).  This provides the best compression
410         ratio by default, which is usually what is desired, at a cost of some
411         speed.
412
413         `wimlib-imagex' now supports being invoked as wimCOMMAND, where COMMAND
414         is the command as in `wimlib-imagex COMMAND'; for example, it can be
415         invoked as `wimapply' as an alternative to `wimlib-imagex apply'.  The
416         appropriate hard links are created in UNIX installations of
417         `wimlib-imagex', while for the Windows distribution of `wimlib-imagex',
418         batch files that emulate this behavior are generated.
419
420         Security descriptors are now extracted correctly on Windows.
421
422         Fixed archiving DOS names in NTFS-3g capture mode.
423
424         The extraction code has been rewritten and it will now be easier to
425         support new features on all supported backends (currently Win32, UNIX,
426         and NTFS-3g).  For example, hard-linked extraction mode (--hardlink) is
427         now supported on all backends, not just UNIX.
428
429         `mkwinpeimg' now supports grabbing files from the WAIK supplement rather
430         than the WAIK itself.
431
432         wimlib_global_init() now, by default, attempts to acquire additional
433         privileges on Windows, so library clients need not do this.
434
435         This update bumps the shared library version number up to 9, since it is
436         not binary compatibible with previous releases.
437
438 Version 1.4.2:
439         Fixed bug in `wimlib-imagex export' that made it impossible to export an
440         image from a WIM that is readonly at the filesystem level.
441
442         Return error code rather than segfaulting when trying to list files from
443         a non-first part of a split WIM.
444
445         Joining a WIM will now preserve the RP_FIX and READONLY flags.
446
447 Version 1.4.1:
448         On Windows, paths given to wimlib-imagex are now treated case
449         insensitively.
450
451         Improved behavior regarding invalid filenames; in particular, on
452         Windows, wimlib-imagex will, when extracting, now omit (with an option
453         to override this default) filenames differing only in case, or filenames
454         containing characters not valid on Windows.
455
456         On Windows, wimlib now supports capturing and extracting long paths
457         (longer than the so-called MAX_PATH).
458
459         On Windows, `wimlib-imagex update' now acquires proper privileges when
460         running as an Administrator.
461
462         `wimlib-imagex update' will now complain if no image is specified when
463         trying to update a multi-image WIM.
464
465         `wimlib-imagex update' now supports specifying a single update command
466         directly on the command line using the --command option.
467
468         wimlib-imagex will now choose different units for progress messages,
469         depending on the amount of data that needs to be processed.
470
471         `wimlib-imagex append' will now generate a unique WIM image name if no
472         name is specified and the defaulted name already exists in the WIM.
473
474         wimlib now allows you to create unnamed WIM images, which can then only
475         be referred to by index.
476
477         wimlib now allows you to explicitly declare you want write access to a
478         WIM by providing the WIMLIB_OPEN_FLAG_WRITE_ACCESS flag to
479         wimlib_open_wim().
480
481         wimlib now respects the WIM_HDR_FLAG_READONLY flag when set in the WIM
482         header.
483
484         Progress callbacks have been added to wimlib's wimlib_update_image()
485         function.
486
487         Added wimlib_get_wim_info(), wimlib_set_wim_info(),
488         wimlib_iterate_dir_tree(), and wimlib_iterate_lookup_table() functions
489         to the library.
490
491         NTFS-3g capture now only warns about two conditions previously treated
492         as errors.
493
494         Fixed a couple issues with using wimlib-imagex on UDF filesystems on
495         Windows.
496
497         wimlib now correctly detects and returns an error when reading a WIM
498         image with a cyclic directory structure.  (Fun fact: such a WIM will
499         crash Microsoft's software.)
500
501 Version 1.4.0:
502         Added new "extract" and "update" subcommands to wimlib-imagex, along
503         with associated APIs in the library.  These commands are intended mainly
504         for Windows use but can be used on UNIX as well.
505
506         Many documentation improvements.
507
508         Fixed a bug in the Windows build where relative symbolic links were not
509         captured in reparse-point fixup mode.
510
511         Fixed a bug in the Windows build where file handles were left open to
512         the WIM file, causing `wimlib_imagex optimize' to fail in some cases.
513
514         Fixed a bug in the Windows build of wimlib-imagex where globbing
515         split-WIM parts could cause the program to crash.
516
517         Fixed a bug where the creation time of WIM images would be shown instead
518         of the last modification time.
519
520         With the Windows build it is now possible to restore a WIM containing
521         symbolic links as a non-Administrator; however you will receive warnings
522         about not being able to extract the symbolic links.
523
524 Version 1.3.3:
525         Capturing a WIM image should now be significantly faster in most cases
526         due to improved use of the operating system's cache and avoiding reading
527         files twice whenever possible.
528
529         The Windows build should now work on Windows XP.
530
531         The Windows build now supports capturing and restoring hidden,
532         compressed, sparse, and encrypted files.
533
534         The Windows build now supports capturing and applying WIM images from
535         filesystems other than NTFS (with some reduced functionality).
536
537         The Windows build now extracts short names correctly.
538
539         Added support for "reparse-point" fixups (i.e. fixing up of symbolic
540         links).  See docs for --rpfix and --norpfix flags of `wimlib-imagex
541         capture' and `wimlib-imagex apply'.
542
543         The performance of splitting and joining WIMs should be slightly
544         improved.
545
546         The LZX and XPRESS compression and decompression functions are now
547         exported from the library.
548
549 Version 1.3.2:
550         Improvements and bugfixes for the Windows build.
551
552         Added --strict-acls options.
553
554         Fixed the way that wimlib determines the order of images in the WIM.
555
556 Version 1.3.1:
557         Since wimlib can now be used on Windows, wimlib's implementation of
558         ImageX has been renamed to wimlib-imagex to avoid confusion with
559         Microsoft's implementation of ImageX, which would have the same file
560         name ("imagex.exe").  If you really don't like this you can pass the
561         --with-imagex-progname option to `configure' to choose a different name,
562         or even simply rename the binary yourself (but the former way will
563         configure the man pages to use the chosen name).
564
565         Various bugs fixed in the Windows build.  Mainly to do with capturing
566         and restoring alternate data streams correctly in weird cases, and
567         requesting the correct privileges when opening files.  Also added the
568         --noacls options to wimlib-imagex capture, append, and apply.
569
570         Windows build again: FindFirstStreamW() and FindNextStreamW() are now
571         dynamically loaded, so this may make the library compatible with Windows
572         XP (however, there may still be other problems).
573
574 Version 1.3.0:
575         Added experimental support for native Windows builds.  Binaries can be
576         downloaded from the SourceForge page.
577
578         --source-list option added to `imagex capture' and `imagex append'.
579
580         Better support for different character encodings.
581
582 Version 1.2.6:
583         Storing UNIX file owners, groups, and modes in WIM images is now
584         possible using `imagex capture' with the --unix-data flag.
585
586         Minor bug fixes and documentation fixes.
587
588 Version 1.2.5:
589         NTFS capture: Fixed capturing duplicate reparse points.
590
591         NTFS capture: Capture first unnamed stream if there are more than one
592         (print warning instead of error).
593
594         Allow multiple test cases to execute concurrently (e.g. make -j2 check).
595
596 Version 1.2.4:
597         Added --arch switch to mkwinpeimg script to support getting AMD64 WinPE
598         from the WAIK.
599
600         Update to work with ntfs-3g version 2013.1.13.
601
602 Version 1.2.3:
603         Fixed truncating file to shorter but non-zero length on read-write
604         mounted WIM image.
605
606         Various code cleanups and minor documentation fixes.
607
608 Version 1.2.2:
609         LZX and XPRESS decompression have received some additional optimizations
610         and should now be even faster.  (Although, they were already pretty
611         fast--- much faster than typical I/O speeds.)
612
613         Fixed a bug introduced in v1.2.1 that would cause a directory tree
614         containing hard links to be captured incorrectly in some cases.
615
616 Version 1.2.1:
617         By default, unmounting a read-write mounted WIM with 'imagex unmount
618         --commit' will now change the WIM in-place without needing to write the
619         entire WIM again.  Use 'imagex unmount --commit --rebuild' to get the
620         old behavior.
621
622         'imagex unmount' no longer has a hard-coded limit of 10 minutes to wait
623         for a response from the daemon servicing the mounted WIM.  Instead,
624         every second 'imagex unmount' will check if the daemon is still alive,
625         and keep waiting if so, otherwise terminate with an error.
626
627         'imagex unmount --commit' on a read-write mounted WIM will now print
628         progress information regarding the writing of new or modified streams
629         the WIM, just like when capturing or appending a WIM.
630
631         A small change has been made to XPRESS compression and it should improve
632         the compression ratio slightly.
633
634         A change was made that may improve performance slightly when applying a
635         WIM image to a NTFS volume.
636
637         Microsoft has managed to introduce even more bugs into their software,
638         and now the WIMs for Windows 8 have incorrect (too low) reference counts
639         for some streams.  This is unsafe because such streams can be removed
640         when they are in actuality still referenced in the WIM (perhaps by a
641         different image).  wimlib will now work around this problem by fixing
642         the stream reference counts.  This is only done when wimlib_delete_image() is
643         called ('imagex delete') or when wimlib_mount_image() is called with
644         WIMLIB_MOUNT_FLAG_READWRITE ('imagex mountrw').  Please note that this
645         requires reading the metadata for all images in the WIM, so this will
646         make these operations noticably slower on WIMs with multiple images.
647
648         Various other bugfixes.
649
650 Version 1.2.0:
651         Appending images to a WIM is now be done by default without re-building
652         the whole WIM.  Use the --rebuild flag to get the old behavior (which
653         was to re-build the entire WIM when a new image is appended).
654
655         A new command `imagex optimize' is now available to manually re-build a
656         WIM that has wasted space due to repeated appends.
657
658         Progress information has been improved, and now arbitrary callback
659         functions can be used to show the progress of a WIM operation.
660
661         A possible bug with changing the bootable image of a WIM was fixed.
662
663         Some advisory locking is now done to prevent two processes from
664         modifying a WIM at the same time (but only in some cases).  For example,
665         you cannot mount two images from a WIM read-write at the same time.
666
667         Some functions have been reorganized:
668                 * wimlib_mount() renamed to wimlib_mount_image().
669                 * wimlib_unmount() renamed to wimlib_unmount_image().
670                 * wimlib_overwrite_xml_and_header() removed as
671                 wimlib_overwrite() suffices now.
672                 * wimlib_apply_image_to_ntfs_volume() removed as
673                 wimlib_extract_image() suffices now.
674                 * wimlib_add_image_from_ntfs_volume() removed as
675                 * wimlib_add_image() suffices now.
676
677         Previously, the soname of libwim.so has been 0.0.0, despite many
678         interface changes.  The soname is now updated to 1.0.0 and will now be
679         updated each release.
680
681 Version 1.1.0:
682         Resources will now be compressed using multiple threads by default.
683         (This applies to `imagex capture', `imagex append', and `imagex
684         export').
685
686         Some performance improvements in mounted WIMs.
687
688         More progress information is shown when capturing a WIM.
689
690 Version 1.0.4:
691         Lots of minor fixes, code cleanups, and some documentation updates.
692         Nothing in particular is really noteworthy.
693
694 Version 1.0.3:
695         LZX and XPRESS compression improvements.
696
697         Fixed calculation of Directory Count, File Count, Total Bytes, and Hard
698         Link Bytes of the WIM.
699
700 Version 1.0.2:
701         Fixed bug when capturing NTFS file with multiple named data streams.
702
703         Internally, we are now using inode structures, even though these don't
704         appear literally in the WIM file.  This simplifies some of the code
705         (mainly for WIM mounting) and likely fixed a few problems, although it
706         needs more testing.
707
708 Version 1.0.1:
709         Fixed problem when exporting images from XPRESS to LZX compressed WIM or
710         vice versa
711
712 Version 1.0.0:
713         Enough changes to call it version 1.0.0!
714
715         Capturing a WIM directly from a NTFS volume, and applying a WIM directly
716         to a NTFS volume, is now supported.
717
718         Hard links and symbolic links have much improved support.  They are
719         supported for WIM capture, WIM application, and mounted WIMs (you can
720         even make them on read-write mounted WIMs).
721
722         Alternate data streams are now supported on mounted WIMs through an
723         xattr or a Windows-style stream interface.  Also they are supported when
724         capturing a WIM from NTFS or applying a WIM to NTFS.
725
726         Split WIMs are better supported.  You may now apply an image directly
727         from a split WIM, mount an image from a split WIM read-only, or export
728         an image from a split WIM.
729
730         Using a capture configuration file is now supported (but not fully yet).
731
732         SHA1 message digests are checked in more places, so we can make sure
733         applied and captured data is correct.
734
735         Man pages have been updated and consolidated.
736
737 Version 0.7.2:
738         Fixed segfault when unmounting read-only WIM.
739
740 Version 0.7.1:
741         Support for joining and splitting WIMs.
742         Also, security data is now preserved by default.
743
744 Version 0.6.3:
745         Can now build with older gcc and system headers, like on CentOS 5.
746
747 Version 0.6.2:
748         Fixed bug that made it impossible to overwrite files in read-write
749         mount.
750
751 Version 0.6.1:
752         Write byte-order mark before WIM XML data.  (imagex.exe requires this to
753         be there.)