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