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