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