write.c, lookup table.c: cleanup

[wimlib] / src / wimlib.h

diff --git a/src/wimlib.h b/src/wimlib.h
index f0be7acdba028fcc24c54fc39d321c6974af252a..08d74b25c5cc2a0b95361eb15455f5a14c112465 100644 (file)
--- a/src/wimlib.h
+++ b/src/wimlib.h
@@ -431,6 +431,7 @@ union wimlib_progress_info {
                 * ::WIMLIB_COMPRESSION_TYPE_LZX. */
                int      compression_type;
 
+               /** Library internal use only. */
                uint64_t _private;
        } write_streams;
 
@@ -899,7 +900,8 @@ struct wimlib_modify_command {
  * added at the end to maintain a compatible ABI, except when it's being broken
  * anyway. */
 enum wimlib_error_code {
-       WIMLIB_ERR_ALREADY_LOCKED = 1,
+       WIMLIB_ERR_SUCCESS = 0,
+       WIMLIB_ERR_ALREADY_LOCKED,
        WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE,
        WIMLIB_ERR_DECOMPRESSION,
        WIMLIB_ERR_DELETE_STAGING_DIR,
@@ -949,7 +951,6 @@ enum wimlib_error_code {
        WIMLIB_ERR_SPLIT_INVALID,
        WIMLIB_ERR_SPLIT_UNSUPPORTED,
        WIMLIB_ERR_STAT,
-       WIMLIB_ERR_SUCCESS = 0,
        WIMLIB_ERR_TIMEOUT,
        WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE,
        WIMLIB_ERR_UNKNOWN_VERSION,
@@ -1674,14 +1675,6 @@ wimlib_join(const wimlib_tchar * const *swms,
  *
  * As a special requirement, the compression code is optimized for the WIM
  * format and therefore requires (@a chunk_size <= 32768).
- *
- * As another special requirement, the compression code will read up to 8 bytes
- * off the end of the @a chunk array for performance reasons.  The values of
- * these bytes will not affect the output of the compression, but the calling
- * code must make sure that the buffer holding the uncompressed chunk is
- * actually at least (@a chunk_size + 8) bytes, or at least that these extra
- * bytes are in mapped memory that will not cause a memory access violation if
- * accessed.
  */
 extern unsigned
 wimlib_lzx_compress(const void *chunk, unsigned chunk_size, void *out);