wimlib-imagex: More documentation updates

[wimlib] / NEWS

diff --git a/NEWS b/NEWS
index 28ccd95d0d9bb508d6bdf7630793f6aab834b30b..a0d271b6741ee5ad8b355dd3342d84a7eddb1fc7 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -1,7 +1,65 @@
 Only the most important changes more recent than version 0.6 are noted here.
 
 Only the most important changes more recent than version 0.6 are noted here.
 

+Version 1.5.0:
+       Added support for "pipable" WIMs.  This support allows capturing images
+       to standard output or applying images from standard input, but they are
+       not compatible with Microsoft's software and are not created by default.
+       See documentation for --pipable flag of `wimlib-imagex capture' for more
+       information.  Two new functions have been added to the library to fully
+       support this: wimlib_write_to_fd() and wimlib_extract_image_from_pipe().
+
+       wimlib now preserve WIM integrity tables by default, even if
+       WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is not specified.  This changes the
+       behavior of `wimlib-imagex' whenever the WIM being operated on contains
+       an integrity table and the '--check' option is not specified.
+
+       `wimlib-imagex capture' now creates LZX-compressed WIMs by default
+       (when --compress is not specified).  This provides the best compression
+       ratio by default, which is usually what is desired, at a cost of some
+       speed.
+
+       For convenience, `wimlib-imagex' now supports being invoked as
+       wimCOMMAND, where COMMAND is the command as in `wimlib-imagex COMMAND';
+       for example, it can be invoked as `wimapply' as an alternative to
+       `wimlib-imagex apply'.  The appropriate hard links are created in UNIX
+       installations of `wimlib-imagex', while for the Windows distribution of
+       `wimlib-imagex', batch files that emulate this behavior are generated.
+
+       `wimlib-imagex' no longer recognizes the 'mount', 'mountrw', and
+       'unmount' commands on Windows, since they didn't work on Windows anyway.
+
+       Security descriptors are now extracted correctly on Windows.
+
+       `mkwinpeimg' now supports grabbing files from the WAIK supplement rather
+       than the WAIK itself.
+
+       The test suite no longer fails when run in a locale where the decimal
+       separator is not a period.
+
+       WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY has been removed and
+       WIMLIB_EXTRACT_FLAG_VERBOSE re-reserved for future use.
+
+       The extraction code has been rewritten and it will now be easier to
+       support new features on all supported backends (currently Win32, UNIX,
+       and NTFS-3g).  For example, hard-linked extraction mode (--hardlink) is
+       now supported on all backends, not just UNIX.
+
+       A few changes were made to the error codes returned by library routines.
+
+       This update bumps the shared library version number up to 9, since it
+       doesn't quite not maintain binary compatibility with previous releases.
+
+Version 1.4.2:
+       Fixed bug in `wimlib-imagex export' that made it impossible to export an
+       image from a WIM that is readonly at the filesystem level.
+
+       Return error code rather than segfaulting when trying to list files from
+       a non-first part of a split WIM.
+
+       Joining a WIM will now preserve the RP_FIX and READONLY flags.
+

 Version 1.4.1:
 Version 1.4.1:

-       Paths given to wimlib-imagex on Windows are now treated case
+       On Windows, paths given to wimlib-imagex are now treated case

        insensitively.
 
        Improved behavior regarding invalid filenames; in particular, on
        insensitively.
 
        Improved behavior regarding invalid filenames; in particular, on


@@ -9,7 +67,10 @@ Version 1.4.1:
        to override this default) filenames differing only in case, or filenames
        containing characters not valid on Windows.
 
        to override this default) filenames differing only in case, or filenames
        containing characters not valid on Windows.
 

-       `wimlib-imagex update' now acquires proper privileges on Windows when
+       On Windows, wimlib now supports capturing and extracting long paths
+       (longer than the so-called MAX_PATH).
+
+       On Windows, `wimlib-imagex update' now acquires proper privileges when

        running as an Administrator.
 
        `wimlib-imagex update' will now complain if no image is specified when
        running as an Administrator.
 
        `wimlib-imagex update' will now complain if no image is specified when


@@ -21,6 +82,36 @@ Version 1.4.1:
        wimlib-imagex will now choose different units for progress messages,
        depending on the amount of data that needs to be processed.
 
        wimlib-imagex will now choose different units for progress messages,
        depending on the amount of data that needs to be processed.
 

+       `wimlib-imagex append' will now generate a unique WIM image name if no
+       name is specified and the defaulted name already exists in the WIM.
+
+       wimlib now allows you to create unnamed WIM images, which can then only
+       be referred to by index.
+
+       wimlib now allows you to explicitly declare you want write access to a
+       WIM by providing the WIMLIB_OPEN_FLAG_WRITE_ACCESS flag to
+       wimlib_open_wim().
+
+       wimlib now respects the WIM_HDR_FLAG_READONLY flag when set in the WIM
+       header.
+
+       Progress callbacks have been added to wimlib's wimlib_update_image()
+       function.
+
+       Added wimlib_get_wim_info(), wimlib_set_wim_info(),
+       wimlib_iterate_dir_tree(), and wimlib_iterate_lookup_table() functions
+       to the library.
+
+       NTFS-3g capture now only warns about two conditions previously treated
+       as errors.
+
+       Fixed a couple issues with using wimlib-imagex on UDF filesystems on
+       Windows.
+
+       wimlib now correctly detects and returns an error when reading a WIM
+       image with a cyclic directory structure.  (Fun fact: such a WIM will
+       crash Microsoft's software.)
+

 Version 1.4.0:
        Added new "extract" and "update" subcommands to wimlib-imagex, along
        with associated APIs in the library.  These commands are intended mainly
 Version 1.4.0:
        Added new "extract" and "update" subcommands to wimlib-imagex, along
        with associated APIs in the library.  These commands are intended mainly