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