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