Various cleanups

[wimlib] / include / wimlib.h

diff --git a/include/wimlib.h b/include/wimlib.h
index c2ecb48dffdf8e11e5ab7ef94c96cb2579d40d7f..9b629d66f40e8571df0fbe9fababd577cc3b915a 100644 (file)
--- a/include/wimlib.h
+++ b/include/wimlib.h
@@ -511,13 +511,15 @@ enum wimlib_compression_type {
         * later.  Also, chunk sizes larger than <c>2^26</c> are not compatible
         * with the Microsoft implementation.
         *
-        * wimlib's LZMS compressor is currently faster but will usually not
-        * compress as much as the implementation in Microsoft's WIMGAPI
-        * (Windows 8.1).
+        * wimlib's LZMS compressor will, with the default settings, usually
+        * produce a better compression ratio, and work more quickly, than the
+        * implementation in Microsoft's WIMGAPI (as of Windows 8.1).  There is
+        * limited support for non-default compression levels, but compression
+        * will be noticably faster if you choose a level < 35.
         *
         * If using wimlib_create_compressor() to create an LZMS compressor
         * directly, the @p max_block_size parameter may be any positive value
-        * up to and including <c>1180427429</c>.
+        * up to and including <c>2^30</c>.
         */
        WIMLIB_COMPRESSION_TYPE_LZMS = 3,
 };
@@ -2216,7 +2218,7 @@ typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resour
 #define WIMLIB_WRITE_FLAG_RETAIN_GUID                  0x00000800
 
 /**
- * When writing streams in the resulting WIM file, combine multiple streams into
+ * When writing streams to the resulting WIM file, combine multiple streams into
  * a single compressed resource instead of compressing them independently.  This
  * is also known as creating a "solid archive".  This tends to produce a better
  * compression ratio at the cost of much slower random access.
@@ -2232,13 +2234,13 @@ typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resour
  * all streams recompressed in solid mode.
  *
  * Currently, new solid resources will, by default, be written using LZMS
- * compression with 32 MiB (33554432 byte) chunks.  Use
+ * compression with 64 MiB (67108864 byte) chunks.  Use
  * wimlib_set_output_pack_compression_type() and/or
  * wimlib_set_output_pack_chunk_size() to change this.  This is independent of
  * the WIM's main compression type and chunk size; you can have a WIM that
  * nominally uses LZX compression and 32768 byte chunks but actually contains
  * LZMS-compressed solid resources, for example.  However, if including solid
- * blocks, I suggest that you set the WIM's main compression type to LZMS as
+ * resources, I suggest that you set the WIM's main compression type to LZMS as
  * well, either by creating the WIM with
  * ::wimlib_create_new_wim(::WIMLIB_COMPRESSION_TYPE_LZMS, ...) or by calling
  * ::wimlib_set_output_compression_type(..., ::WIMLIB_COMPRESSION_TYPE_LZMS).
@@ -4671,7 +4673,7 @@ wimlib_get_compressor_needed_memory(enum wimlib_compression_type ctype,
  *     Therefore, it is a compressor-only parameter and does not need to be
  *     passed to the decompressor.
  *     <br/>
- *     Since wimlib v1.7.5, this parameter can be OR-ed with the flag
+ *     Since wimlib v1.8.0, this parameter can be OR-ed with the flag
  *     ::WIMLIB_COMPRESSOR_FLAG_DESTRUCTIVE.  This creates the compressor in a
  *     mode where it is allowed to modify the input buffer.  Specifically, in
  *     this mode, if compression succeeds, the input buffer may have been