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