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