Deprecate wimlib_print_wim_information()

[wimlib] / include / wimlib.h

diff --git a/include/wimlib.h b/include/wimlib.h
index 9c8239aa0c47ff95d99b489c5e6bf614d5258a9d..1efdcb1b5adca7a18f5cf5462fc667450f01e61b 100644 (file)
--- a/include/wimlib.h
+++ b/include/wimlib.h
@@ -686,10 +686,14 @@ struct wimlib_wim_info {
         * table.  */
        uint64_t total_bytes;
 
-       /** 1 if the WIM has an integrity table  */
+       /** 1 if the WIM has an integrity table.  Note: if the ::WIMStruct was
+        * created via wimlib_create_new_wim() rather than wimlib_open_wim(),
+        * this will always be 0, even if the ::WIMStruct was written to
+        * somewhere by calling wimlib_write() with the
+        * ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY flag specified. */
        uint32_t has_integrity_table : 1;
 
-       /** 1 if the WIM was created via wimlib_open_wim() rather than
+       /** 1 if the ::WIMStruct was created via wimlib_open_wim() rather than
         * wimlib_create_new_wim(). */
        uint32_t opened_from_file : 1;
 
@@ -709,7 +713,7 @@ struct wimlib_wim_info {
        uint32_t write_in_progress : 1;
        uint32_t metadata_only : 1;
        uint32_t resource_only : 1;
-       uint32_t reserved_flags : 24;
+       uint32_t reserved_flags : 23;
        uint32_t reserved[9];
 };
 
@@ -1815,18 +1819,10 @@ extern void
 wimlib_global_cleanup(void);
 
 /**
- * Returns true if the WIM has an integrity table.
- *
- * @param wim
- *     Pointer to the ::WIMStruct for a WIM file.
- * @return
- *     @c true if the WIM has an integrity table; @c false otherwise.  If @a
- *     wim is a ::WIMStruct created with wimlib_create_new_wim() rather than
- *     wimlib_open_wim(), @c false will be returned, even if wimlib_write() has
- *     been called on @a wim with ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY set.
+ * Deprecated in favor of wimlib_get_wim_info().
  */
 extern bool
-wimlib_has_integrity_table(const WIMStruct *wim);
+wimlib_has_integrity_table(const WIMStruct *wim) _wimlib_deprecated;
 
 /**
  * Determines if an image name is already used by some image in the WIM.
@@ -2331,18 +2327,11 @@ extern int
 wimlib_print_metadata(WIMStruct *wim, int image);
 
 /**
- * Prints some basic information about a WIM file.  All information printed by
- * this function is also printed by wimlib_print_header(), but
- * wimlib_print_wim_information() prints some of this information more concisely
- * and in a more readable form.
- *
- * @param wim
- *     Pointer to the ::WIMStruct for a WIM file.
- *
- * @return This function has no return value.
+ * Deprecated in favor of wimlib_get_wim_info(), which provides the information
+ * in a way that can be accessed programatically.
  */
 extern void
-wimlib_print_wim_information(const WIMStruct *wim);
+wimlib_print_wim_information(const WIMStruct *wim) _wimlib_deprecated;
 
 /**
  * Translates a string specifying the name or number of an image in the WIM into