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