Minor comment fixes
authorEric Biggers <ebiggers3@gmail.com>
Sat, 18 Jan 2014 06:25:46 +0000 (00:25 -0600)
committerEric Biggers <ebiggers3@gmail.com>
Sat, 18 Jan 2014 06:25:46 +0000 (00:25 -0600)
NEWS
README
include/wimlib.h
src/extract.c

diff --git a/NEWS b/NEWS
index 221126a444fe2c723719744512155fcce6f07899..167830ce676c2b1fd7de153c099dbc5d693fc889 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -10,7 +10,7 @@ Version 1.6.1:
 
        Fixed a minor compatibility issue with the LZMS compressor and
        decompressor.  This is *not* the default compression type and was only
 
        Fixed a minor compatibility issue with the LZMS compressor and
        decompressor.  This is *not* the default compression type and was only
-       introduced in v1.6.0.  In the unlikely event that you created a
+       introduced in v1.6.0.  In the unlikely event that you created an
        LZMS-compressed WIM with v1.6.0 and a checksum error is reported when
        applying it with v1.6.1, decompress it with v1.6.0 then compress it with
        v1.6.1.
        LZMS-compressed WIM with v1.6.0 and a checksum error is reported when
        applying it with v1.6.1, decompress it with v1.6.0 then compress it with
        v1.6.1.
diff --git a/README b/README
index ed7ee1e0e4a55dd802acef4ccfab54aed15c7d40..dbef7a8b27e1f988a0b75bbbf14819527fc7cb9a 100644 (file)
--- a/README
+++ b/README
@@ -65,7 +65,7 @@ wimlib (and wimlib-imagex) can create XPRESS, LZX, or LZMS compressed WIM
 archives.  wimlib includes its own compression codecs and does not use the
 compression API available on some versions of Windows.  The below table provides
 the results (file size, in bytes, and time to create, in seconds) of capturing a
 archives.  wimlib includes its own compression codecs and does not use the
 compression API available on some versions of Windows.  The below table provides
 the results (file size, in bytes, and time to create, in seconds) of capturing a
-WIM containing a x86 Windows PE image, using various compression types and
+WIM containing an x86 Windows PE image, using various compression types and
 options.  When applicable, the results with the equivalent Microsoft
 implementation in WIMGAPI, which is the library used by ImageX and Dism, are
 included.
 options.  When applicable, the results with the equivalent Microsoft
 implementation in WIMGAPI, which is the library used by ImageX and Dism, are
 included.
index d8806b97895d89ee7c5d2e4e4ef4d223629246f7..22b6b0d307e917210e0517b9bde52c34d3d110e0 100644 (file)
@@ -517,8 +517,10 @@ enum wimlib_progress_msg {
         * will not be valid. */
        WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN,
 
         * will not be valid. */
        WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN,
 
-       /** Confirms that the metadata resource for each image has successfully
-        * been writen to the WIM.  @p info will not be valid.  */
+       /** Confirms that per-image metadata has been successfully been written
+        * to the WIM file.  @p info will not be valid.  This message is paired
+        * with a preceding ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN message.
+        */
        WIMLIB_PROGRESS_MSG_WRITE_METADATA_END,
 
        /** wimlib_overwrite() has successfully renamed the temporary file to
        WIMLIB_PROGRESS_MSG_WRITE_METADATA_END,
 
        /** wimlib_overwrite() has successfully renamed the temporary file to
@@ -537,8 +539,8 @@ enum wimlib_progress_msg {
 
        /** An integrity table is being calculated for the WIM being written.
         * @p info will point to ::wimlib_progress_info.integrity.  This message
 
        /** An integrity table is being calculated for the WIM being written.
         * @p info will point to ::wimlib_progress_info.integrity.  This message
-        * is only received (and may be received many times) when a WIM is being
-        * written with the flag ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY.  */
+        * is only received (and may be received many times) when a WIM file is
+        * being written with the flag ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY.  */
        WIMLIB_PROGRESS_MSG_CALC_INTEGRITY,
 
        /** Reserved.  */
        WIMLIB_PROGRESS_MSG_CALC_INTEGRITY,
 
        /** Reserved.  */
@@ -1548,8 +1550,8 @@ typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resour
 
 /** For wimlib_extract_paths() and wimlib_extract_pathlist() only:  Do not
  * preserve the directory structure of the archive when extracting --- that is,
 
 /** For wimlib_extract_paths() and wimlib_extract_pathlist() only:  Do not
  * preserve the directory structure of the archive when extracting --- that is,
- * place each extracted files or directory tree directly in the target
- * directory.  */
+ * place each extracted file or directory tree directly in the target directory.
+ */
 #define WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE  0x00200000
 
 /** @} */
 #define WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE  0x00200000
 
 /** @} */
@@ -2270,7 +2272,7 @@ wimlib_export_image(WIMStruct *src_wim, int src_image,
  *
  * As of wimlib v1.6.1, this function is deprecated in favor of
  * wimlib_extract_paths() because wimlib_extract_paths() is easier to use and
  *
  * As of wimlib v1.6.1, this function is deprecated in favor of
  * wimlib_extract_paths() because wimlib_extract_paths() is easier to use and
- * usually more efficient.
+ * more efficient.
  *
  * Notes: wimlib_extract_files() does not support the
  * ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS flag, and
  *
  * Notes: wimlib_extract_files() does not support the
  * ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS flag, and
index ee82be2bf1e5df21f1adb86c97d60e81b63ec620..a1725a918880b84e79e088815fb0518ecbc54583 100644 (file)
@@ -1907,8 +1907,8 @@ dentry_list_calculate_extraction_names(struct list_head *dentry_list,
        struct list_head *prev, *cur;
 
        /* Can't use list_for_each_entry() because a call to
        struct list_head *prev, *cur;
 
        /* Can't use list_for_each_entry() because a call to
-        * dentry_calculate_extraction_name() may the current dentry and its
-        * children from the list.  */
+        * dentry_calculate_extraction_name() may delete the current dentry and
+        * its children from the list.  */
 
        prev = dentry_list;
        for (;;) {
 
        prev = dentry_list;
        for (;;) {