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