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