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