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