Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add release information to enum constants - Part 1 #5174

Merged
merged 2 commits into from
Dec 11, 2024
Merged

Add release information to enum constants - Part 1 #5174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
24263c3
Add release information to enum constants - Part 1
bmribler Dec 11, 2024
fc9793d
Committing clang-format changes
github-actions[bot] Dec 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/H5FDhdfs.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@

#else

/** Initializer for the hdfs VFD (disabled) */
/** Initializer for the hdfs VFD (disabled) \since 1.8.22 */
#define H5FD_HDFS (H5I_INVALID_HID)

/** Identifier for the hdfs VFD (disabled) */
Expand All @@ -47,11 +47,11 @@
*/
#define H5FD__CURR_HDFS_FAPL_T_VERSION 1

/** Max size of the node name */
/** Max size of the node name \since 1.8.22 */
#define H5FD__HDFS_NODE_NAME_SPACE 128
/** Max size of the user name */
/** Max size of the user name \since 1.8.22 */
#define H5FD__HDFS_USER_NAME_SPACE 128
/** Max size of the kerberos cache path */
/** Max size of the kerberos cache path \since 1.8.22 */
#define H5FD__HDFS_KERB_CACHE_PATH_SPACE 128

/**
Expand Down
23 changes: 14 additions & 9 deletions src/H5FDpublic.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,18 +107,23 @@
* of type 'int' and is compatible with POSIX I/O calls.
*/
#define H5FD_FEAT_POSIX_COMPAT_HANDLE 0x00000080
/*
* Defining H5FD_FEAT_HAS_MPI for a VFL driver means that
* the driver makes use of MPI communication and code may retrieve
* communicator/rank information from it
*/

#define H5FD_FEAT_HAS_MPI 0x00000100
/*
* Defining the H5FD_FEAT_ALLOCATE_EARLY for a VFL driver will force
* the library to use the H5D_ALLOC_TIME_EARLY on dataset create
* instead of the default H5D_ALLOC_TIME_LATE
/**< Defining H5FD_FEAT_HAS_MPI for a VFL driver means that
* the driver makes use of MPI communication and code may retrieve
* communicator/rank information from it
*
* \since 1.8.15
*/

#define H5FD_FEAT_ALLOCATE_EARLY 0x00000200
/**< Defining the H5FD_FEAT_ALLOCATE_EARLY for a VFL driver will force
* the library to use the H5D_ALLOC_TIME_EARLY on dataset create
* instead of the default H5D_ALLOC_TIME_LATE
*
* \since 1.8.15
*/

/*
* Defining H5FD_FEAT_ALLOW_FILE_IMAGE for a VFL driver means that
* the driver is able to use a file image in the fapl as the initial
Expand Down
8 changes: 4 additions & 4 deletions src/H5FDros3.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,17 @@

#ifdef H5_HAVE_ROS3_VFD

/** ID for the ros3 VFD */
/** Initializer for the ros3 VFD \since 1.8.22 */
#define H5FD_ROS3 (H5OPEN H5FD_ROS3_id_g)

/** Identifier for the ros3 VFD */
/** Identifier for the ros3 VFD \since 1.14.0 */
#define H5FD_ROS3_VALUE H5_VFD_ROS3

#else
/** Initializer for the ros3 VFD (disabled) */
/** Initializer for the ros3 VFD (disabled) \since 1.8.22 */
#define H5FD_ROS3 (H5I_INVALID_HID)

/** Identifier for the ros3 VFD (disabled) */
/** Identifier for the ros3 VFD (disabled) \since 1.14.0 */
#define H5FD_ROS3_VALUE H5_VFD_INVALID
#endif

Expand Down
11 changes: 6 additions & 5 deletions src/H5Fpublic.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,13 @@
/* NOTE: 0x0008u was H5F_ACC_DEBUG, now deprecated */
#define H5F_ACC_CREAT (0x0010u) /**< Create non-existing files */
#define H5F_ACC_SWMR_WRITE \
(0x0020u) /**< Indicate that this file is open for writing in a \
(0x0020u) /**< Indicates that this file is open for writing in a \
* single-writer/multi-reader (SWMR) scenario. \
* Note that the process(es) opening the file for reading \
* must open the file with #H5F_ACC_RDONLY and use the \
* #H5F_ACC_SWMR_READ access flag. */
#define H5F_ACC_SWMR_READ \
(0x0040u) /**< Indicate that this file is open for reading in a \
(0x0040u) /**< Indicates that this file is open for reading in a \
* single-writer/multi-reader (SWMR) scenario. Note that \
* the process(es) opening the file for SWMR reading must \
* also open the file with the #H5F_ACC_RDONLY flag. */
Expand Down Expand Up @@ -231,9 +231,10 @@ typedef herr_t (*H5F_flush_cb_t)(hid_t object_id, void *udata);
* high number of unused bits. See documentation for \
* H5Pset_relax_file_integrity_checks for details. */
#define H5F_RFIC_ALL \
(H5F_RFIC_UNUSUAL_NUM_UNUSED_NUMERIC_BITS) /**< Suppress all format integrity check errors. See \
* documentation for H5Pset_relax_file_integrity_checks \
* for details. */
(H5F_RFIC_UNUSUAL_NUM_UNUSED_NUMERIC_BITS) /**< Suppress all format integrity check \
* errors. See documentation for \
* H5Pset_relax_file_integrity_checks \
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add () for linking:

H5Pset_relax_file_integrity_checks()

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will fix this in my next PR. Thanks.

* for details. */

/*********************/
/* Public Prototypes */
Expand Down
12 changes: 9 additions & 3 deletions src/H5PLpublic.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,16 @@ typedef enum H5PL_type_t {
//! <!-- [H5PL_type_t_snip] -->

/* Common dynamic plugin type flags used by the set/get_loading_state functions */
/** Flag for filter plugin \since 1.8.15 */
#define H5PL_FILTER_PLUGIN 0x0001
#define H5PL_VOL_PLUGIN 0x0002
#define H5PL_VFD_PLUGIN 0x0004
#define H5PL_ALL_PLUGIN 0xFFFF
/** Flag for VOL plugin \since 1.12.0 */
#define H5PL_VOL_PLUGIN 0x0002
/** Flag for VFD plugin \since 1.14.0 */
#define H5PL_VFD_PLUGIN 0x0004
/** Flag for all plugin types \since 1.8.15 */
#define H5PL_ALL_PLUGIN 0xFFFF

#define H5F_ACC_DEBUG (0x0000u) /**< Print debug info \deprecated In which version? */
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you mean to leave this question?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you mean to leave this question?

@brtnfld That question wasn't from me. I don't know how it showed as a new line. I made a note to myself to check on that and fix it though.


#ifdef __cplusplus
extern "C" {
Expand Down
2 changes: 1 addition & 1 deletion src/H5Ppublic.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1012,7 +1012,7 @@ H5_DLL htri_t H5Pexist(hid_t plist_id, const char *name);
*
* The property name must exist or this routine will fail.
*
* If the \p get callback routine returns an error, \ value will
* If the \p get callback routine returns an error, \p value will
* not be modified.
*
* \since 1.4.0
Expand Down
13 changes: 9 additions & 4 deletions src/H5public.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -343,10 +343,15 @@ typedef int64_t hssize_t;
* \internal Defined as a (minimum) 64-bit unsigned integer type.
*/
typedef uint64_t haddr_t;
#define PRIdHADDR PRId64
#define PRIoHADDR PRIo64
#define PRIuHADDR PRIu64
#define PRIxHADDR PRIx64
/** d print conversion specifier \since 1.8.23 */
#define PRIdHADDR PRId64
/** o print conversion specifier \since 1.8.23 */
#define PRIoHADDR PRIo64
/** u print conversion specifier \since 1.8.23 */
#define PRIuHADDR PRIu64
/** x print conversion specifier \since 1.8.23 */
#define PRIxHADDR PRIx64
/** x print conversion specifier \since 1.8.23 */
#define PRIXHADDR PRIX64
#define H5_SIZEOF_HADDR_T 8
#define HADDR_UNDEF UINT64_MAX
Expand Down
Loading