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