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