wimlib.h: Update wimlib_add_image() docs

[wimlib] / src / wimlib.h

diff --git a/src/wimlib.h b/src/wimlib.h
index 84ee830ec75d6bc8e101d9a086c5da976b4317e4..7a2fad7d8c3c87b595f848db31ba7876307fd39d 100644 (file)
--- a/src/wimlib.h
+++ b/src/wimlib.h
@@ -956,6 +956,7 @@ enum wimlib_error_code {
        WIMLIB_ERR_INVALID_OVERLAY,
        WIMLIB_ERR_INVALID_PARAM,
        WIMLIB_ERR_INVALID_PART_NUMBER,
+       WIMLIB_ERR_INVALID_REPARSE_DATA,
        WIMLIB_ERR_INVALID_RESOURCE_HASH,
        WIMLIB_ERR_INVALID_RESOURCE_SIZE,
        WIMLIB_ERR_INVALID_SECURITY_DATA,
@@ -977,6 +978,7 @@ enum wimlib_error_code {
        WIMLIB_ERR_READLINK,
        WIMLIB_ERR_RENAME,
        WIMLIB_ERR_REOPEN,
+       WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED,
        WIMLIB_ERR_RESOURCE_ORDER,
        WIMLIB_ERR_SPECIAL_FILE,
        WIMLIB_ERR_SPLIT_INVALID,
@@ -1001,12 +1003,9 @@ enum wimlib_error_code {
 /**
  * Adds an image to a WIM file from an on-disk directory tree or NTFS volume.
  *
- * The directory tree of NTFS volume is read immediately for the purpose of
- * constructing a directory entry tree in-memory.  Also, all files are read to
- * calculate their SHA1 message digests.  However, because the directory tree
- * may contain a very large amount of data, the files themselves are not read
- * into memory permanently, and instead references to their paths saved.  The
- * files are then read on-demand if wimlib_write() or wimlib_overwrite() is
+ * The directory tree or NTFS volume is scanned immediately to load the dentry
+ * tree into memory, and file attributes and symbolic links are read.  However,
+ * actual file data is not read until wimlib_write() or wimlib_overwrite() is
  * called.
  *
  * See the manual page for the @b wimlib-imagex program for more information
@@ -1975,6 +1974,10 @@ wimlib_open_wim(const wimlib_tchar *wim_file,
  * and while abnormal termination of the program will result in extra data
  * appended to the original WIM, it should still be a valid WIM.
  *
+ * If this function completes successfully, no functions should be called on @a
+ * wim other than wimlib_free().  You must use wimlib_open_wim() to read the WIM
+ * file anew.
+ *
  * @param wim
  *     Pointer to the ::WIMStruct for the WIM file to write.  There may have
  *     been in-memory changes made to it, which are then reflected in the
@@ -2002,11 +2005,6 @@ wimlib_open_wim(const wimlib_tchar *wim_file,
  * @retval ::WIMLIB_ERR_RENAME
  *     The temporary file that the WIM was written to could not be renamed to
  *     the original filename of @a wim.
- * @retval ::WIMLIB_ERR_REOPEN
- *     The WIM was overwritten successfully, but it could not be re-opened
- *     read-only.  Therefore, the resources in the WIM can no longer be
- *     accessed, so this limits the functions that can be called on @a wim
- *     before calling wimlib_free().
  */
 extern int
 wimlib_overwrite(WIMStruct *wim, int write_flags, unsigned num_threads,