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