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