]> wimlib.net Git - wimlib/blobdiff - include/wimlib.h
wimlib.h: document receiving "unmount begin" progress message
[wimlib] / include / wimlib.h
index cd341e694cc73c0898c48a3126922110a596d913..667b2b923e0ebb744a40ad846226d09e28ba14dc 100644 (file)
@@ -11,7 +11,7 @@
 /**
  * @mainpage
  *
- * This is the documentation for the library interface of wimlib 1.9.0, a C
+ * This is the documentation for the library interface of wimlib 1.9.1, a C
  * library for creating, modifying, extracting, and mounting files in the
  * Windows Imaging Format.  This documentation is intended for developers only.
  * If you have installed wimlib and want to know how to use the @b wimlib-imagex
 #define WIMLIB_MINOR_VERSION 9
 
 /** Patch version of the library (for example, the 5 in 1.2.5). */
-#define WIMLIB_PATCH_VERSION 0
+#define WIMLIB_PATCH_VERSION 1
 
 #ifdef __cplusplus
 extern "C" {
@@ -3043,7 +3043,7 @@ wimlib_extract_pathlist(WIMStruct *wim, int image,
  * to match no files, and there is a flag (::WIMLIB_EXTRACT_FLAG_STRICT_GLOB) to
  * enable the strict behavior if desired.
  *
- * Symbolic are not be dereferenced when paths in the image are interpreted.
+ * Symbolic links are not dereferenced when paths in the image are interpreted.
  *
  * @param wim
  *     WIM from which to extract the paths, specified as a pointer to the
@@ -4334,8 +4334,9 @@ wimlib_unmount_image(const wimlib_tchar *dir, int unmount_flags);
  * @ingroup G_mounting_wim_images
  *
  * Same as wimlib_unmount_image(), but allows specifying a progress function.
- * If changes are committed from a read-write mount, the progress function will
- * receive ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS messages.
+ * The progress function will receive a ::WIMLIB_PROGRESS_MSG_UNMOUNT_BEGIN
+ * message.  In addition, if changes are committed from a read-write mount, the
+ * progress function will receive ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS messages.
  */
 extern int
 wimlib_unmount_image_with_progress(const wimlib_tchar *dir,