wimlib.h: document receiving "unmount begin" progress message
authorEric Biggers <ebiggers3@gmail.com>
Sun, 17 Apr 2016 14:44:57 +0000 (09:44 -0500)
committerEric Biggers <ebiggers3@gmail.com>
Sun, 17 Apr 2016 15:16:41 +0000 (10:16 -0500)
include/wimlib.h

index e4ae344..667b2b9 100644 (file)
@@ -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,