wimcapture: Allow specifying `--delta-from' multiple times
[wimlib] / NEWS
1 Only the most important changes more recent than version 0.6 are noted here.
2
3 Version 1.5.1:
4         wimlib can now open WinPE WIMs from WAIK v2.1, which had a quirk that
5         needed to be handled.
6
7         A bug in the interpretation of negative IMAGE indices in the
8         --update-of=[WIMFILE:]IMAGE option to `wimlib-imagex capture' and
9         `wimlib-imagex append' has been fixed.
10
11         A workaround has been added to successfully apply security descriptors
12         with empty DACLs when the NTFS-3g apply mode is being used with NTFS-3g
13         2013.1.13 or earlier.
14
15         `wimlib-imagex capture' can now accept the '--delta-from' option
16         multiple times.
17
18 Version 1.5.0:
19         Added support for "pipable" WIMs.  Pipable WIMs allow capturing images
20         to standard output and applying images from standard input, but they are
21         not compatible with Microsoft's software and are not created by default.
22         See the documentation for --pipable flag of `wimlib-imagex capture' for
23         more information.
24
25         To better support incremental backups, added support for declaring an
26         image as a modified form of another image.  See the documentation for
27         the '--update-of' option of `wimlib-imagex append' and `wimlib-imagex
28         capture'.
29
30         Added supported for "delta" WIMs.  See the documentation for the
31         '--delta-from' option of `wimlib-imagex capture'.
32
33         The library support for managing split WIMs has been changed to support
34         other arrangements, such as delta WIMs, and be easier to use.  This
35         change is visible in `wimlib-imagex', which also can now accept the
36         '--ref' option multiple times, and also now supports "delta" WIMs as
37         mentioned above.
38
39         wimlib now preserves WIM integrity tables by default, even if
40         WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is not specified.  This changes the
41         behavior of `wimlib-imagex' whenever the WIM being operated on contains
42         an integrity table and the '--check' option is not specified.
43
44         `wimlib-imagex capture' now creates LZX-compressed WIMs by default
45         (when --compress is not specified).  This provides the best compression
46         ratio by default, which is usually what is desired, at a cost of some
47         speed.
48
49         `wimlib-imagex' now supports being invoked as wimCOMMAND, where COMMAND
50         is the command as in `wimlib-imagex COMMAND'; for example, it can be
51         invoked as `wimapply' as an alternative to `wimlib-imagex apply'.  The
52         appropriate hard links are created in UNIX installations of
53         `wimlib-imagex', while for the Windows distribution of `wimlib-imagex',
54         batch files that emulate this behavior are generated.
55
56         Security descriptors are now extracted correctly on Windows.
57
58         Fixed archiving DOS names in NTFS-3g capture mode.
59
60         The extraction code has been rewritten and it will now be easier to
61         support new features on all supported backends (currently Win32, UNIX,
62         and NTFS-3g).  For example, hard-linked extraction mode (--hardlink) is
63         now supported on all backends, not just UNIX.
64
65         `mkwinpeimg' now supports grabbing files from the WAIK supplement rather
66         than the WAIK itself.
67
68         wimlib_global_init() now, by default, attempts to acquire additional
69         privileges on Windows, so library clients need not do this.
70
71         This update bumps the shared library version number up to 9, since it is
72         not binary compatibible with previous releases.
73
74 Version 1.4.2:
75         Fixed bug in `wimlib-imagex export' that made it impossible to export an
76         image from a WIM that is readonly at the filesystem level.
77
78         Return error code rather than segfaulting when trying to list files from
79         a non-first part of a split WIM.
80
81         Joining a WIM will now preserve the RP_FIX and READONLY flags.
82
83 Version 1.4.1:
84         On Windows, paths given to wimlib-imagex are now treated case
85         insensitively.
86
87         Improved behavior regarding invalid filenames; in particular, on
88         Windows, wimlib-imagex will, when extracting, now omit (with an option
89         to override this default) filenames differing only in case, or filenames
90         containing characters not valid on Windows.
91
92         On Windows, wimlib now supports capturing and extracting long paths
93         (longer than the so-called MAX_PATH).
94
95         On Windows, `wimlib-imagex update' now acquires proper privileges when
96         running as an Administrator.
97
98         `wimlib-imagex update' will now complain if no image is specified when
99         trying to update a multi-image WIM.
100
101         `wimlib-imagex update' now supports specifying a single update command
102         directly on the command line using the --command option.
103
104         wimlib-imagex will now choose different units for progress messages,
105         depending on the amount of data that needs to be processed.
106
107         `wimlib-imagex append' will now generate a unique WIM image name if no
108         name is specified and the defaulted name already exists in the WIM.
109
110         wimlib now allows you to create unnamed WIM images, which can then only
111         be referred to by index.
112
113         wimlib now allows you to explicitly declare you want write access to a
114         WIM by providing the WIMLIB_OPEN_FLAG_WRITE_ACCESS flag to
115         wimlib_open_wim().
116
117         wimlib now respects the WIM_HDR_FLAG_READONLY flag when set in the WIM
118         header.
119
120         Progress callbacks have been added to wimlib's wimlib_update_image()
121         function.
122
123         Added wimlib_get_wim_info(), wimlib_set_wim_info(),
124         wimlib_iterate_dir_tree(), and wimlib_iterate_lookup_table() functions
125         to the library.
126
127         NTFS-3g capture now only warns about two conditions previously treated
128         as errors.
129
130         Fixed a couple issues with using wimlib-imagex on UDF filesystems on
131         Windows.
132
133         wimlib now correctly detects and returns an error when reading a WIM
134         image with a cyclic directory structure.  (Fun fact: such a WIM will
135         crash Microsoft's software.)
136
137 Version 1.4.0:
138         Added new "extract" and "update" subcommands to wimlib-imagex, along
139         with associated APIs in the library.  These commands are intended mainly
140         for Windows use but can be used on UNIX as well.
141
142         Many documentation improvements.
143
144         Fixed a bug in the Windows build where relative symbolic links were not
145         captured in reparse-point fixup mode.
146
147         Fixed a bug in the Windows build where file handles were left open to
148         the WIM file, causing `wimlib_imagex optimize' to fail in some cases.
149
150         Fixed a bug in the Windows build of wimlib-imagex where globbing
151         split-WIM parts could cause the program to crash.
152
153         Fixed a bug where the creation time of WIM images would be shown instead
154         of the last modification time.
155
156         With the Windows build it is now possible to restore a WIM containing
157         symbolic links as a non-Administrator; however you will receive warnings
158         about not being able to extract the symbolic links.
159
160 Version 1.3.3:
161         Capturing a WIM image should now be significantly faster in most cases
162         due to improved use of the operating system's cache and avoiding reading
163         files twice whenever possible.
164
165         The Windows build should now work on Windows XP.
166
167         The Windows build now supports capturing and restoring hidden,
168         compressed, sparse, and encrypted files.
169
170         The Windows build now supports capturing and applying WIM images from
171         filesystems other than NTFS (with some reduced functionality).
172
173         The Windows build now extracts short names correctly.
174
175         Added support for "reparse-point" fixups (i.e. fixing up of symbolic
176         links).  See docs for --rpfix and --norpfix flags of `wimlib-imagex
177         capture' and `wimlib-imagex apply'.
178
179         The performance of splitting and joining WIMs should be slightly
180         improved.
181
182         The LZX and XPRESS compression and decompression functions are now
183         exported from the library.
184
185 Version 1.3.2:
186         Improvements and bugfixes for the Windows build.
187
188         Added --strict-acls options.
189
190         Fixed the way that wimlib determines the order of images in the WIM.
191
192 Version 1.3.1:
193         Since wimlib can now be used on Windows, wimlib's implementation of
194         ImageX has been renamed to wimlib-imagex to avoid confusion with
195         Microsoft's implementation of ImageX, which would have the same file
196         name ("imagex.exe").  If you really don't like this you can pass the
197         --with-imagex-progname option to `configure' to choose a different name,
198         or even simply rename the binary yourself (but the former way will
199         configure the man pages to use the chosen name).
200
201         Various bugs fixed in the Windows build.  Mainly to do with capturing
202         and restoring alternate data streams correctly in weird cases, and
203         requesting the correct privileges when opening files.  Also added the
204         --noacls options to wimlib-imagex capture, append, and apply.
205
206         Windows build again: FindFirstStreamW() and FindNextStreamW() are now
207         dynamically loaded, so this may make the library compatible with Windows
208         XP (however, there may still be other problems).
209
210 Version 1.3.0:
211         Added experimental support for native Windows builds.  Binaries can be
212         downloaded from the SourceForge page.
213
214         --source-list option added to `imagex capture' and `imagex append'.
215
216         Better support for different character encodings.
217
218 Version 1.2.6:
219         Storing UNIX file owners, groups, and modes in WIM images is now
220         possible using `imagex capture' with the --unix-data flag.
221
222         Minor bug fixes and documentation fixes.
223
224 Version 1.2.5:
225         NTFS capture: Fixed capturing duplicate reparse points.
226
227         NTFS capture: Capture first unnamed stream if there are more than one
228         (print warning instead of error).
229
230         Allow multiple test cases to execute concurrently (e.g. make -j2 check).
231
232 Version 1.2.4:
233         Added --arch switch to mkwinpeimg script to support getting AMD64 WinPE
234         from the WAIK.
235
236         Update to work with ntfs-3g version 2013.1.13.
237
238 Version 1.2.3:
239         Fixed truncating file to shorter but non-zero length on read-write
240         mounted WIM image.
241
242         Various code cleanups and minor documentation fixes.
243
244 Version 1.2.2:
245         LZX and XPRESS decompression have received some additional optimizations
246         and should now be even faster.  (Although, they were already pretty
247         fast--- much faster than typical I/O speeds.)
248
249         Fixed a bug introduced in v1.2.1 that would cause a directory tree
250         containing hard links to be captured incorrectly in some cases.
251
252 Version 1.2.1:
253         By default, unmounting a read-write mounted WIM with 'imagex unmount
254         --commit' will now change the WIM in-place without needing to write the
255         entire WIM again.  Use 'imagex unmount --commit --rebuild' to get the
256         old behavior.
257
258         'imagex unmount' no longer has a hard-coded limit of 10 minutes to wait
259         for a response from the daemon servicing the mounted WIM.  Instead,
260         every second 'imagex unmount' will check if the daemon is still alive,
261         and keep waiting if so, otherwise terminate with an error.
262
263         'imagex unmount --commit' on a read-write mounted WIM will now print
264         progress information regarding the writing of new or modified streams
265         the WIM, just like when capturing or appending a WIM.
266
267         A small change has been made to XPRESS compression and it should improve
268         the compression ratio slightly.
269
270         A change was made that may improve performance slightly when applying a
271         WIM image to a NTFS volume.
272
273         Microsoft has managed to introduce even more bugs into their software,
274         and now the WIMs for Windows 8 have incorrect (too low) reference counts
275         for some streams.  This is unsafe because such streams can be removed
276         when they are in actuality still referenced in the WIM (perhaps by a
277         different image).  wimlib will now work around this problem by fixing
278         the stream reference counts.  This is only done when wimlib_delete_image() is
279         called ('imagex delete') or when wimlib_mount_image() is called with
280         WIMLIB_MOUNT_FLAG_READWRITE ('imagex mountrw').  Please note that this
281         requires reading the metadata for all images in the WIM, so this will
282         make these operations noticably slower on WIMs with multiple images.
283
284         Various other bugfixes.
285
286 Version 1.2.0:
287         Appending images to a WIM is now be done by default without re-building
288         the whole WIM.  Use the --rebuild flag to get the old behavior (which
289         was to re-build the entire WIM when a new image is appended).
290
291         A new command `imagex optimize' is now available to manually re-build a
292         WIM that has wasted space due to repeated appends.
293
294         Progress information has been improved, and now arbitrary callback
295         functions can be used to show the progress of a WIM operation.
296
297         A possible bug with changing the bootable image of a WIM was fixed.
298
299         Some advisory locking is now done to prevent two processes from
300         modifying a WIM at the same time (but only in some cases).  For example,
301         you cannot mount two images from a WIM read-write at the same time.
302
303         Some functions have been reorganized:
304                 * wimlib_mount() renamed to wimlib_mount_image().
305                 * wimlib_unmount() renamed to wimlib_unmount_image().
306                 * wimlib_overwrite_xml_and_header() removed as
307                 wimlib_overwrite() suffices now.
308                 * wimlib_apply_image_to_ntfs_volume() removed as
309                 wimlib_extract_image() suffices now.
310                 * wimlib_add_image_from_ntfs_volume() removed as
311                 * wimlib_add_image() suffices now.
312
313         Previously, the soname of libwim.so has been 0.0.0, despite many
314         interface changes.  The soname is now updated to 1.0.0 and will now be
315         updated each release.
316
317 Version 1.1.0:
318         Resources will now be compressed using multiple threads by default.
319         (This applies to `imagex capture', `imagex append', and `imagex
320         export').
321
322         Some performance improvements in mounted WIMs.
323
324         More progress information is shown when capturing a WIM.
325
326 Version 1.0.4:
327         Lots of minor fixes, code cleanups, and some documentation updates.
328         Nothing in particular is really noteworthy.
329
330 Version 1.0.3:
331         LZX and XPRESS compression improvements.
332
333         Fixed calculation of Directory Count, File Count, Total Bytes, and Hard
334         Link Bytes of the WIM.
335
336 Version 1.0.2:
337         Fixed bug when capturing NTFS file with multiple named data streams.
338
339         Internally, we are now using inode structures, even though these don't
340         appear literally in the WIM file.  This simplifies some of the code
341         (mainly for WIM mounting) and likely fixed a few problems, although it
342         needs more testing.
343
344 Version 1.0.1:
345         Fixed problem when exporting images from XPRESS to LZX compressed WIM or
346         vice versa
347
348 Version 1.0.0:
349         Enough changes to call it version 1.0.0!
350
351         Capturing a WIM directly from a NTFS volume, and applying a WIM directly
352         to a NTFS volume, is now supported.
353
354         Hard links and symbolic links have much improved support.  They are
355         supported for WIM capture, WIM application, and mounted WIMs (you can
356         even make them on read-write mounted WIMs).
357
358         Alternate data streams are now supported on mounted WIMs through an
359         xattr or a Windows-style stream interface.  Also they are supported when
360         capturing a WIM from NTFS or applying a WIM to NTFS.
361
362         Split WIMs are better supported.  You may now apply an image directly
363         from a split WIM, mount an image from a split WIM read-only, or export
364         an image from a split WIM.
365
366         Using a capture configuration file is now supported (but not fully yet).
367
368         SHA1 message digests are checked in more places, so we can make sure
369         applied and captured data is correct.
370
371         Man pages have been updated and consolidated.
372
373 Version 0.7.2:
374         Fixed segfault when unmounting read-only WIM.
375
376 Version 0.7.1:
377         Support for joining and splitting WIMs.
378         Also, security data is now preserved by default.
379
380 Version 0.6.3:
381         Can now build with older gcc and system headers, like on CentOS 5.
382
383 Version 0.6.2:
384         Fixed bug that made it impossible to overwrite files in read-write
385         mount.
386
387 Version 0.6.1:
388         Write byte-order mark before WIM XML data.  (imagex.exe requires this to
389         be there.)