]> wimlib.net Git - wimlib/blobdiff - include/wimlib.h
wimlib.h: update git links for gitlist => gitweb replacement
[wimlib] / include / wimlib.h
index 02b1ce9f08688c0fe22aa69d784bffb00cdc7cef..7254a1265f61d86fd782498b1a9acdfb1c484727 100644 (file)
 /**
  * @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.2, 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
  * program, please see the manual pages and also the <a
- * href="https://wimlib.net/gitlist/wimlib/blob/master/README">README
- * file</a>.
+ * href="https://wimlib.net/git/?p=wimlib;a=blob;f=README">README file</a>.
  *
  * @section sec_installing Installing
  *
@@ -46,7 +45,7 @@
  * distribution.  Also see @ref sec_basic_wim_handling_concepts below.
  *
  * There is also the <a
- * href="https://wimlib.net/gitlist/wimlib/blob/master/programs/imagex.c">
+ * href="https://wimlib.net/git/?p=wimlib;a=blob;f=programs/imagex.c">
  * source code of <b>wimlib-imagex</b></a>, which is complicated but uses most
  * capabilities of wimlib.
  *
  * such as wimlib_join(), also take the progress function directly using an
  * extended version of the function, such as wimlib_join_with_progress().
  *
- * In wimlib v1.7.0 and later, progress functions are no longer just
- * unidirectional.  You can now return ::WIMLIB_PROGRESS_STATUS_ABORT to cause
- * the current operation to be aborted.  wimlib v1.7.0 also added the third
- * argument to ::wimlib_progress_func_t, which is a user-supplied context.
+ * Since wimlib v1.7.0, progress functions are no longer just unidirectional.
+ * You can now return ::WIMLIB_PROGRESS_STATUS_ABORT to cause the current
+ * operation to be aborted.  wimlib v1.7.0 also added the third argument to
+ * ::wimlib_progress_func_t, which is a user-supplied context.
  */
 
 /** @defgroup G_writing_and_overwriting_wims Writing and Overwriting WIMs
 #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 2
 
 #ifdef __cplusplus
 extern "C" {
@@ -1063,8 +1062,8 @@ union wimlib_progress_info {
 
                /** Name of the split WIM part that is about to be started
                 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
-                * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART).
-                * As of wimlib v1.7.0, the library user may change this when
+                * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART).  Since
+                * wimlib v1.7.0, the library user may change this when
                 * receiving ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART in order to
                 * cause the next split WIM part to be written to a different
                 * location.  */
@@ -1461,8 +1460,8 @@ struct wimlib_stream_entry {
 };
 
 /**
- * An object ID, which is an extra piece of metadata that may be associated with
- * a file on NTFS filesystems.  See:
+ * Since wimlib v1.9.1: an object ID, which is an extra piece of metadata that
+ * may be associated with a file on NTFS filesystems.  See:
  * https://msdn.microsoft.com/en-us/library/windows/desktop/aa363997(v=vs.85).aspx
  */
 struct wimlib_object_id {
@@ -3044,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
@@ -4335,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,