summaryrefslogtreecommitdiffstats
path: root/src/H5Fpkg.h
diff options
context:
space:
mode:
authorMuqun Yang <myang6@hdfgroup.org>2021-10-28 17:29:39 (GMT)
committerMuqun Yang <myang6@hdfgroup.org>2021-10-28 17:29:39 (GMT)
commit7a527aac5a69449a185cdd40de43b82723cc3fbb (patch)
treebaa263666a0de357299eb9ec0bbdc99c3a46bd8d /src/H5Fpkg.h
parente52f6fdb1322a1b770eac4297ce7d0dd01e1da73 (diff)
downloadhdf5-7a527aac5a69449a185cdd40de43b82723cc3fbb.zip
hdf5-7a527aac5a69449a185cdd40de43b82723cc3fbb.tar.gz
hdf5-7a527aac5a69449a185cdd40de43b82723cc3fbb.tar.bz2
Modify comments.
Diffstat (limited to 'src/H5Fpkg.h')
-rw-r--r--src/H5Fpkg.h20
1 files changed, 13 insertions, 7 deletions
diff --git a/src/H5Fpkg.h b/src/H5Fpkg.h
index 578c6ab..7bb5e45 100644
--- a/src/H5Fpkg.h
+++ b/src/H5Fpkg.h
@@ -468,11 +468,17 @@ struct H5F_shared_t {
H5F_fs_state_t fs_state_md; /* State of the free space
* manager
*/
-
- FILE * vfd_swmr_log_file_ptr;
- hbool_t vfd_swmr_log_on;
- struct timespec vfd_swmr_log_start_time;
-
+ /* Log file for VFD SWMR */
+ FILE * vfd_swmr_log_file_ptr; /* File pointer for the
+ * log file.
+ */
+ hbool_t vfd_swmr_log_on; /* flag to indicate if
+ * the log file is
+ * created. */
+ struct timespec vfd_swmr_log_start_time; /* The starting time for
+ * calculating the time
+ * stamp of a log message.
+ */
/* Delayed free space release doubly linked list */
shadow_defree_queue_t shadow_defrees;
@@ -614,10 +620,10 @@ H5_DLL herr_t H5F__reparse_file_lock_variable_test(void);
/* VFD SMWR LOG REPORTING MACROS */
-/* H5F_POST_VFD_SWMR_LOG_ENTRY is the macro that needs to be used by the developers.
+/* H5F_POST_VFD_SWMR_LOG_ENTRY is the macro that can help the developers debug VFD SWMR features.
* It calls an internal reporting function H5F_post_vfd_swmr_log_entry() that receives
* the log entry_type_code, which generates the log tag, and the message log_info, which
- * the library developer wants to save into the log file.
+ * the developers want to save into the log file.
*
* The macro H5F_POST_VFD_SWMR_LOG_ENTRY_RELEASE(f, c, number_entry_production, m) is
* called by H5F_POST_VFD_SWMR_LOG_ENTRY when the HDF5 library is built with the