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