From 3414c52b7effab6fe860dd28f1c28db210a4b3e1 Mon Sep 17 00:00:00 2001 From: Eric Biggers Date: Mon, 23 Dec 2013 23:44:31 -0600 Subject: [PATCH] wimlib.h: Document pack streams write flags --- include/wimlib.h | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/include/wimlib.h b/include/wimlib.h index 3b358098..1526a7a3 100644 --- a/include/wimlib.h +++ b/include/wimlib.h @@ -1535,10 +1535,27 @@ typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resour #define WIMLIB_WRITE_FLAG_RESERVED 0x00000800 -/** TODO */ +/** When writing streams in the resulting WIM file, pack multiple streams into a + * single WIM resource instead of compressing them independently. This tends to + * produce a better compression ratio at the cost of less random access. + * Furthermore, WIMs created with this flag are only compatible with wimlib + * v1.6.0 or later and WIMGAPI Windows 8 or later, seemingly for Windows Setup + * only and not including ImageX and Dism. WIMs created with this flag + * use version number 3584 in their header instead of 68864. If this flag is + * passed to wimlib_overwrite() and the WIM did not previously contain packed + * streams, the WIM's version number will be changed to 3584 and the new streams + * will be written packed. */ #define WIMLIB_WRITE_FLAG_PACK_STREAMS 0x00001000 -/** TODO */ +/** Compress all streams independently. This produces a WIM optimized for + * random access and compatibility, as noted in the documentation for + * ::WIMLIB_WRITE_RESOURCE_FLAG_PACK_STREAMS. For wimlib_write(), this is the + * default behavior. For wimlib_overwrite(), this is the default if the WIM file + * did not already contain packed streams. Also, for wimlib_overwrite(), if the + * WIM already contained packed streams, specifying this flag but not + * ::WIMLIB_WRITE_FLAG_REBUILD will cause new streams to be written unpacked, + * but the WIM itself will not be rebuilt and may still contain packed streams. + */ #define WIMLIB_WRITE_FLAG_NO_PACK_STREAMS 0x00002000 /** @} */ -- 2.43.0