From ed082ac981a23eea56d7e15f1bc1fd2d6f9dd5bd Mon Sep 17 00:00:00 2001 From: Dana Robinson <43805+derobins@users.noreply.github.com> Date: Thu, 2 Jan 2025 10:09:46 -0800 Subject: [PATCH 1/4] Fix 'unused parameter' warnings in C++ tests (#5199) --- c++/test/dsets.cpp | 4 ++++ c++/test/tarray.cpp | 4 ++++ c++/test/tattr.cpp | 4 ++++ c++/test/tcompound.cpp | 4 ++++ c++/test/tdspl.cpp | 4 ++++ c++/test/tfile.cpp | 11 ++++++----- c++/test/tfilter.cpp | 4 ++++ c++/test/th5s.cpp | 4 ++++ c++/test/titerate.cpp | 4 ++++ c++/test/tlinks.cpp | 4 ++++ c++/test/tobject.cpp | 10 ++++------ c++/test/trefer.cpp | 4 ++++ c++/test/ttypes.cpp | 4 ++++ c++/test/tvlstr.cpp | 4 ++++ 14 files changed, 58 insertions(+), 11 deletions(-) diff --git a/c++/test/dsets.cpp b/c++/test/dsets.cpp index d61389b0842..949c8161c01 100644 --- a/c++/test/dsets.cpp +++ b/c++/test/dsets.cpp @@ -1457,6 +1457,8 @@ test_dset(const void *params) fapl_id = h5_fileaccess(); // in h5test.c, returns a file access template int nerrors = 0; // keep track of number of failures occur + (void)params; + try { // Use the file access template id to create a file access prop. // list object to pass in H5File::H5File @@ -1505,6 +1507,8 @@ test_dset(const void *params) extern "C" void cleanup_dsets(void *params) { + (void)params; + if (GetTestCleanup()) { HDremove(FILE1.c_str()); HDremove(FILE_ACCPLIST.c_str()); diff --git a/c++/test/tarray.cpp b/c++/test/tarray.cpp index 9be2e5c85c8..4fbc8c91776 100644 --- a/c++/test/tarray.cpp +++ b/c++/test/tarray.cpp @@ -479,6 +479,8 @@ test_array_info() extern "C" void test_array(const void *params) { + (void)params; + // Output message about test being performed MESSAGE(5, ("Testing Array Datatypes\n")); @@ -504,6 +506,8 @@ test_array(const void *params) extern "C" void cleanup_array(void *params) { + (void)params; + if (GetTestCleanup()) { HDremove(FILENAME.c_str()); } diff --git a/c++/test/tattr.cpp b/c++/test/tattr.cpp index dec33972599..51932f2674f 100644 --- a/c++/test/tattr.cpp +++ b/c++/test/tattr.cpp @@ -1958,6 +1958,8 @@ test_attr_corder_create_basic(FileCreatPropList &fcpl, FileAccPropList &fapl) extern "C" void test_attr(const void *params) { + (void)params; + // Output message about test being performed MESSAGE(5, ("Testing Attributes\n")); @@ -2043,6 +2045,8 @@ test_attr(const void *params) extern "C" void cleanup_attr(void *params) { + (void)params; + if (GetTestCleanup()) { HDremove(FILE_BASIC.c_str()); HDremove(FILE_COMPOUND.c_str()); diff --git a/c++/test/tcompound.cpp b/c++/test/tcompound.cpp index 29d3120bc53..5e73d42a7b0 100644 --- a/c++/test/tcompound.cpp +++ b/c++/test/tcompound.cpp @@ -731,6 +731,8 @@ test_compound_set_size() extern "C" void test_compound(const void *params) { + (void)params; + // Output message about test being performed MESSAGE(5, ("Testing Compound Data Type operations\n")); @@ -755,6 +757,8 @@ test_compound(const void *params) extern "C" void cleanup_compound(void *params) { + (void)params; + if (GetTestCleanup()) { HDremove(COMPFILE.c_str()); } diff --git a/c++/test/tdspl.cpp b/c++/test/tdspl.cpp index fc261db1505..0982b304134 100644 --- a/c++/test/tdspl.cpp +++ b/c++/test/tdspl.cpp @@ -116,6 +116,8 @@ test_transfplist() extern "C" void test_dsproplist(const void *params) { + (void)params; + // Output message about test being performed MESSAGE(5, ("Testing Generic Dataset Property Lists\n")); @@ -134,6 +136,8 @@ test_dsproplist(const void *params) extern "C" void cleanup_dsproplist(void *params) { + (void)params; + if (GetTestCleanup()) { HDremove(FILENAME.c_str()); } diff --git a/c++/test/tfile.cpp b/c++/test/tfile.cpp index 3f1f8115239..250be27e1d3 100644 --- a/c++/test/tfile.cpp +++ b/c++/test/tfile.cpp @@ -970,6 +970,8 @@ test_file_info() extern "C" void test_file(const void *params) { + (void)params; + // Output message about test being performed MESSAGE(5, ("Testing File I/O Operations\n")); @@ -992,12 +994,11 @@ test_file(const void *params) * Return none *------------------------------------------------------------------------- */ -#ifdef __cplusplus -extern "C" -#endif - void - cleanup_file(void *params) +extern "C" void +cleanup_file(void *params) { + (void)params; + if (GetTestCleanup()) { HDremove(FILE1.c_str()); HDremove(FILE2.c_str()); diff --git a/c++/test/tfilter.cpp b/c++/test/tfilter.cpp index 9d426c1e2e0..c46a2217ef2 100644 --- a/c++/test/tfilter.cpp +++ b/c++/test/tfilter.cpp @@ -229,6 +229,8 @@ const H5std_string FILE1("tfilters.h5"); extern "C" void test_filters(const void *params) { + (void)params; + // Output message about test being performed MESSAGE(5, ("Testing Various Filters\n")); @@ -261,6 +263,8 @@ test_filters(const void *params) extern "C" void cleanup_filters(void *params) { + (void)params; + if (GetTestCleanup()) { HDremove(FILE1.c_str()); } diff --git a/c++/test/th5s.cpp b/c++/test/th5s.cpp index 8b18ec011fe..2953a4c08d2 100644 --- a/c++/test/th5s.cpp +++ b/c++/test/th5s.cpp @@ -473,6 +473,8 @@ test_h5s_compound_scalar_read() extern "C" void test_h5s(const void *params) { + (void)params; + // Output message about test being performed MESSAGE(5, ("Testing Dataspaces\n")); @@ -495,6 +497,8 @@ test_h5s(const void *params) extern "C" void cleanup_h5s(void *params) { + (void)params; + if (GetTestCleanup()) { HDremove(DATAFILE.c_str()); } diff --git a/c++/test/titerate.cpp b/c++/test/titerate.cpp index 593ba507973..de27a9eaaaf 100644 --- a/c++/test/titerate.cpp +++ b/c++/test/titerate.cpp @@ -442,6 +442,8 @@ test_HDFFV_9920() extern "C" void test_iterate(const void *params) { + (void)params; + // Output message about test being performed MESSAGE(5, ("Testing Iterate Feature\n")); @@ -466,6 +468,8 @@ test_iterate(const void *params) extern "C" void cleanup_iterate(void *params) { + (void)params; + if (GetTestCleanup()) { HDremove(FILE_ITERATE.c_str()); HDremove(FILE_NAME.c_str()); diff --git a/c++/test/tlinks.cpp b/c++/test/tlinks.cpp index ec6f8eee210..c76291d742f 100644 --- a/c++/test/tlinks.cpp +++ b/c++/test/tlinks.cpp @@ -714,6 +714,8 @@ test_links(const void *params) hid_t fapl_id, fapl2_id; /* File access property lists */ unsigned new_format; /* Whether to use the new format or not */ + (void)params; + if ((fapl_id = h5_fileaccess()) < 0) throw Exception("test_links", "Unable to get file access property list"); @@ -771,6 +773,8 @@ test_links(const void *params) extern "C" void cleanup_links(void *params) { + (void)params; + if (GetTestCleanup()) { HDremove(FILENAME[0]); HDremove(FILENAME[1]); diff --git a/c++/test/tobject.cpp b/c++/test/tobject.cpp index adf7c58abde..5b29df38c3f 100644 --- a/c++/test/tobject.cpp +++ b/c++/test/tobject.cpp @@ -512,8 +512,6 @@ test_open_object_header() * file will return the same file "number". * * Return None - * - * July, 2018 *------------------------------------------------------------------------- */ const H5std_string FILE_OBJINFO("tobject_getinfo.h5"); @@ -599,8 +597,6 @@ test_getobjectinfo_same_file() * the property setting. * * Return None - * - * April, 2019 *------------------------------------------------------------------------- */ const H5std_string FILE_INTERGRPS("tobject_intergrps.h5"); @@ -713,13 +709,13 @@ test_intermediate_groups() * * Return Success: 0 * Failure: -1 - * - * March 4, 2014 *------------------------------------------------------------------------- */ extern "C" void test_object(const void *params) { + (void)params; + // Output message about test being performed MESSAGE(5, ("Testing Object Functions\n")); @@ -744,6 +740,8 @@ test_object(const void *params) extern "C" void cleanup_object(void *params) { + (void)params; + if (GetTestCleanup()) { HDremove(FILE_OBJECTS.c_str()); HDremove(FILE_OBJHDR.c_str()); diff --git a/c++/test/trefer.cpp b/c++/test/trefer.cpp index 4a9a2f0447b..83224eb3186 100644 --- a/c++/test/trefer.cpp +++ b/c++/test/trefer.cpp @@ -829,6 +829,8 @@ test_reference_region_1D() extern "C" void test_reference(const void *params) { + (void)params; + // Output message about test being performed MESSAGE(5, ("Testing References\n")); @@ -850,6 +852,8 @@ test_reference(const void *params) extern "C" void cleanup_reference(void *params) { + (void)params; + if (GetTestCleanup()) { HDremove(FILE1.c_str()); HDremove(FILE2.c_str()); diff --git a/c++/test/ttypes.cpp b/c++/test/ttypes.cpp index 1959331c59e..5bac64cb379 100644 --- a/c++/test/ttypes.cpp +++ b/c++/test/ttypes.cpp @@ -1095,6 +1095,8 @@ test_operators() extern "C" void test_types(const void *params) { + (void)params; + // Output message about test being performed MESSAGE(5, ("Testing Generic Data Types\n")); @@ -1122,6 +1124,8 @@ test_types(const void *params) extern "C" void cleanup_types(void *params) { + (void)params; + if (GetTestCleanup()) { for (int i = 0; i < 6; i++) HDremove(FILENAME[i]); diff --git a/c++/test/tvlstr.cpp b/c++/test/tvlstr.cpp index db616cd0571..cfd37632eea 100644 --- a/c++/test/tvlstr.cpp +++ b/c++/test/tvlstr.cpp @@ -936,6 +936,8 @@ test_vl_rewrite() extern "C" void test_vlstrings(const void *params) { + (void)params; + // Output message about test being performed MESSAGE(5, ("Testing Variable-Length Strings")); @@ -969,6 +971,8 @@ test_vlstrings(const void *params) extern "C" void cleanup_vlstrings(void *params) { + (void)params; + if (GetTestCleanup()) { HDremove(FILENAME.c_str()); HDremove(FILENAME2.c_str()); From c0192e236122f483c71723d66dddee2cdc80ed5a Mon Sep 17 00:00:00 2001 From: aled-ua Date: Fri, 3 Jan 2025 07:47:30 -0600 Subject: [PATCH 2/4] Fix vuln OSV-2024-390 (#5201) --- src/H5Ocache.c | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/H5Ocache.c b/src/H5Ocache.c index a5bf35aa7ba..8d06f282077 100644 --- a/src/H5Ocache.c +++ b/src/H5Ocache.c @@ -781,6 +781,10 @@ H5O__cache_chk_serialize(const H5F_t *f, void *image, size_t len, void *_thing) /* copy the chunk into the image -- this is potentially expensive. * Can we rework things so that the chunk and the cache share a buffer? */ + /* Ensure len does not exceed the size of the source buffer */ + if (len > chk_proxy->oh->chunk[chk_proxy->chunkno].size) + HGOTO_ERROR(H5E_OHDR, H5E_OVERFLOW, FAIL, "buffer overflow detected"); + H5MM_memcpy(image, chk_proxy->oh->chunk[chk_proxy->chunkno].image, len); done: From 85bef9d1a71c0345f7204e4ad56bfc95b8aaca39 Mon Sep 17 00:00:00 2001 From: Allen Byrne <50328838+byrnHDF@users.noreply.github.com> Date: Fri, 3 Jan 2025 09:59:24 -0600 Subject: [PATCH 3/4] Fix cygwin CI (#5203) * use mingw generator * disable ninja * Disable ZFP and zstd because of C++ issue --- .github/workflows/cygwin-cmake.yml | 2 ++ config/cmake/scripts/HDF5config.cmake | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/cygwin-cmake.yml b/.github/workflows/cygwin-cmake.yml index 8c10a35552c..f28f985b69e 100644 --- a/.github/workflows/cygwin-cmake.yml +++ b/.github/workflows/cygwin-cmake.yml @@ -104,6 +104,8 @@ jobs: set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DLIBAEC_USE_LOCALCONTENT:BOOL=OFF") set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DZLIB_USE_LOCALCONTENT:BOOL=OFF") set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DPLUGIN_USE_LOCALCONTENT:BOOL=OFF") + set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DENABLE_ZFP:BOOL=OFF") + set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DENABLE_ZSTD:BOOL=OFF") - name: Run ctest (Cygwin) shell: C:\cygwin\bin\bash.exe -eo pipefail -o igncr '{0}' diff --git a/config/cmake/scripts/HDF5config.cmake b/config/cmake/scripts/HDF5config.cmake index 3da5f0ecd5e..3598cacaa2a 100644 --- a/config/cmake/scripts/HDF5config.cmake +++ b/config/cmake/scripts/HDF5config.cmake @@ -180,7 +180,7 @@ if (NOT DEFINED HPC) if (DEFINED NINJA) set (CTEST_CMAKE_GENERATOR "Ninja") else () - if (MINGW) + if (BUILD_GENERATOR STREQUAL "MINGW") set (CTEST_CMAKE_GENERATOR "MinGW Makefiles") else () set (CTEST_CMAKE_GENERATOR "Unix Makefiles") From 67d074cac744507daef68cff6d6d9356d365d191 Mon Sep 17 00:00:00 2001 From: Allen Byrne <50328838+byrnHDF@users.noreply.github.com> Date: Mon, 6 Jan 2025 11:32:52 -0600 Subject: [PATCH 4/4] Fix doxygen missing references (#5205) --- .gitattributes | 2 +- doc/parallel-compression.md | 2 +- java/src/Makefile.am | 2 +- java/src/hdf/hdf5lib/CMakeLists.txt | 2 +- java/src/hdf/hdf5lib/H5.java | 19 +++++++++---------- .../hdf/hdf5lib/callbacks/H5A_iterate_cb.java | 2 +- .../{Callbacks.java => H5Callbacks.java} | 8 ++++---- .../hdf/hdf5lib/callbacks/H5D_append_cb.java | 2 +- .../hdf/hdf5lib/callbacks/H5D_iterate_cb.java | 2 +- .../hdf/hdf5lib/callbacks/H5E_walk_cb.java | 2 +- .../hdf/hdf5lib/callbacks/H5L_iterate_t.java | 2 +- .../hdf/hdf5lib/callbacks/H5O_iterate_t.java | 2 +- .../callbacks/H5P_cls_close_func_cb.java | 2 +- .../callbacks/H5P_cls_copy_func_cb.java | 2 +- .../callbacks/H5P_cls_create_func_cb.java | 2 +- .../hdf/hdf5lib/callbacks/H5P_iterate_cb.java | 2 +- .../callbacks/H5P_prp_close_func_cb.java | 2 +- .../callbacks/H5P_prp_compare_func_cb.java | 2 +- .../callbacks/H5P_prp_copy_func_cb.java | 2 +- .../callbacks/H5P_prp_create_func_cb.java | 2 +- .../callbacks/H5P_prp_delete_func_cb.java | 2 +- .../callbacks/H5P_prp_get_func_cb.java | 2 +- .../callbacks/H5P_prp_set_func_cb.java | 2 +- .../hdf/hdf5lib/callbacks/package-info.java | 4 ++-- release_docs/RELEASE.txt | 6 +++++- release_docs/RELEASE_PROCESS.md | 4 ++-- src/H5FDmodule.h | 4 ++++ src/H5FDonion.h | 2 +- src/H5FDpublic.h | 2 +- src/H5Pmodule.h | 4 ++++ src/H5Tmodule.h | 2 ++ src/H5Zmodule.h | 2 ++ 32 files changed, 57 insertions(+), 42 deletions(-) rename java/src/hdf/hdf5lib/callbacks/{Callbacks.java => H5Callbacks.java} (88%) diff --git a/.gitattributes b/.gitattributes index 7e37bf00fee..4ae913ea368 100644 --- a/.gitattributes +++ b/.gitattributes @@ -204,7 +204,7 @@ java/src/hdf/hdf5lib/H5.java -text java/src/hdf/hdf5lib/HDF5Constants.java -text java/src/hdf/hdf5lib/HDFArray.java -text java/src/hdf/hdf5lib/HDFNativeData.java -text -java/src/hdf/hdf5lib/callbacks/Callbacks.java -text +java/src/hdf/hdf5lib/callbacks/H5Callbacks.java -text java/src/hdf/hdf5lib/callbacks/H5A_iterate_cb.java -text java/src/hdf/hdf5lib/callbacks/H5A_iterate_t.java -text java/src/hdf/hdf5lib/callbacks/H5D_append_cb.java -text diff --git a/doc/parallel-compression.md b/doc/parallel-compression.md index 9879f6efc91..523aa758fec 100644 --- a/doc/parallel-compression.md +++ b/doc/parallel-compression.md @@ -341,7 +341,7 @@ hid_t file_id = H5Fcreate("file.h5", H5F_ACC_TRUNC, H5P_DEFAULT, fapl_id); [u6]: https://hdfgroup.github.io/hdf5/develop/group___d_c_p_l.html#ga4335bb45b35386daa837b4ff1b9cd4a4 [u7]: https://hdfgroup.github.io/hdf5/develop/group___d_c_p_l.html#ga6bd822266b31f86551a9a1d79601b6a2 [u8]: https://www.hdfgroup.org/2022/03/04/parallel-compression-improvements-in-hdf5-1-13-1/ -[u9]: https://support.hdfgroup.org/releases/hdf5/documentation/advanced_topics/chunking_in_hdf5.md +[u9]: https://hdfgroup.github.io/hdf5/develop/chunking__in__hdf5_8dox.html [u10]: https://support.hdfgroup.org/releases/hdf5/documentation/hdf5_topics/HDF5ImprovingIOPerformanceCompressedDatasets.pdf [u11]: https://hdfgroup.github.io/hdf5/develop/group___f_a_p_l.html#gab99d5af749aeb3896fd9e3ceb273677a [u12]: https://hdfgroup.github.io/hdf5/develop/group___f_c_p_l.html#ga167ff65f392ca3b7f1933b1cee1b9f70 diff --git a/java/src/Makefile.am b/java/src/Makefile.am index e194a0fce5d..7fac1f2eb98 100644 --- a/java/src/Makefile.am +++ b/java/src/Makefile.am @@ -41,7 +41,7 @@ CLASSPATH_ENV=CLASSPATH=.:$(top_srcdir)/java/lib/slf4j-api-2.0.6.jar:$$CLASSPATH AM_JAVACFLAGS = $(H5_JAVACFLAGS) -deprecation hdf5_java_JAVA = \ - ${pkgpath}/callbacks/Callbacks.java \ + ${pkgpath}/callbacks/H5Callbacks.java \ ${pkgpath}/callbacks/H5A_iterate_cb.java \ ${pkgpath}/callbacks/H5A_iterate_t.java \ ${pkgpath}/callbacks/H5D_append_cb.java \ diff --git a/java/src/hdf/hdf5lib/CMakeLists.txt b/java/src/hdf/hdf5lib/CMakeLists.txt index 69b5a93b664..8c0b6daa48c 100644 --- a/java/src/hdf/hdf5lib/CMakeLists.txt +++ b/java/src/hdf/hdf5lib/CMakeLists.txt @@ -10,7 +10,7 @@ SET_GLOBAL_VARIABLE (HDF5_JAVA_SOURCE_PACKAGES ) set (HDF5_JAVA_HDF_HDF5_CALLBACKS_SOURCES - callbacks/Callbacks.java + callbacks/H5Callbacks.java callbacks/H5A_iterate_cb.java callbacks/H5A_iterate_t.java callbacks/H5D_append_cb.java diff --git a/java/src/hdf/hdf5lib/H5.java b/java/src/hdf/hdf5lib/H5.java index fe51f4e511d..f630faba8e5 100644 --- a/java/src/hdf/hdf5lib/H5.java +++ b/java/src/hdf/hdf5lib/H5.java @@ -5348,7 +5348,7 @@ public synchronized static native void H5Fset_libver_bounds(long file_id, int lo // herr_t H5Fget_mpi_atomicity(hid_t file_id, hbool_t *flag); // #endif /* H5_HAVE_PARALLEL */ - // /** + // /* // * H5Fget_vfd_handle returns a pointer to the file handle from the // low-level file driver // * currently being used by the HDF5 library for file I/O. @@ -5365,7 +5365,7 @@ public synchronized static native void H5Fset_libver_bounds(long file_id, int lo // H5Fget_vfd_handle(int file_id, int fapl) // throws HDF5LibraryException; - // /** + // /* // * H5Fget_mdc_config loads the current metadata cache configuration into // * the instance of H5AC_cache_config_t pointed to by the config_ptr // parameter. @@ -5382,7 +5382,7 @@ public synchronized static native void H5Fset_libver_bounds(long file_id, int lo // public synchronized static native void H5Fget_mdc_config(int file_id, H5AC_cache_config_t config_ptr) // throws HDF5LibraryException, NullPointerException; - // /** + // /* // * H5Fset_mdc_config attempts to configure the file's metadata cache // according to the configuration supplied. // * @@ -10028,7 +10028,7 @@ public synchronized static native String H5Pget_virtual_dsetname(long dcpl_id, l throws HDF5LibraryException, IllegalArgumentException; // ///// unimplemented ///// - // /** + // /* // * H5Pget_vds_file_cache_size retrieves the size of the vds link open file cache. // * // * @param fapl_id @@ -10043,7 +10043,7 @@ public synchronized static native String H5Pget_virtual_dsetname(long dcpl_id, l // public synchronized static native int H5Pget_vds_file_cache_size(long fapl_id) throws // HDF5LibraryException; // - // /** + // /* // * H5Pset_vds_file_cache_size sets the number of files that can be held open in an vds link open // * file cache. // * @@ -10075,10 +10075,9 @@ public synchronized static native String H5Pget_virtual_dsetname(long dcpl_id, l * @param size * OUT: the offset value and the size of the external file data. * - *
-     *      size[0] = offset // a location to return an offset value
-     *      size[1] = size // a location to return the size of
-     *                // the external file data.
+     * 
+     *    size[0] = offset // a location to return an offset value
+     *    size[1] = size // a location to return the size of the external file data.
      * 
* * @return a non-negative value if successful @@ -13929,7 +13928,7 @@ public synchronized static native boolean H5Tdetect_class(long type_id, int cls) public synchronized static native int H5Tencode(long obj_id, byte[] buf, long nalloc) throws HDF5LibraryException, NullPointerException; - // /** + // /* // * @ingroup JH5T // * // * H5Tencode converts a data type description into binary form in a buffer. diff --git a/java/src/hdf/hdf5lib/callbacks/H5A_iterate_cb.java b/java/src/hdf/hdf5lib/callbacks/H5A_iterate_cb.java index b7471805d68..bdef19f2160 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5A_iterate_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5A_iterate_cb.java @@ -18,7 +18,7 @@ * Information class for link callback for H5Aiterate. * */ -public interface H5A_iterate_cb extends Callbacks { +public interface H5A_iterate_cb extends H5Callbacks { /** * @ingroup JCALLBK * diff --git a/java/src/hdf/hdf5lib/callbacks/Callbacks.java b/java/src/hdf/hdf5lib/callbacks/H5Callbacks.java similarity index 88% rename from java/src/hdf/hdf5lib/callbacks/Callbacks.java rename to java/src/hdf/hdf5lib/callbacks/H5Callbacks.java index a106ab67625..d0af5c81e32 100644 --- a/java/src/hdf/hdf5lib/callbacks/Callbacks.java +++ b/java/src/hdf/hdf5lib/callbacks/H5Callbacks.java @@ -13,11 +13,11 @@ package hdf.hdf5lib.callbacks; /** - * @page CALLBACKS HDF5 Java Callbacks Interface + * @page CALLBACKS HDF5 Java H5Callbacks Interface * All callback definitions must derive from this interface. Any * derived interfaces must define a single public method named "callback". * You are responsible for deregistering your callback (if necessary) - * in its {@link Object#finalize} method. If native code attempts to call + * in its Object finalize method. If native code attempts to call * a callback which has been GC'd, you will likely crash the VM. If * there is no method to deregister the callback (e.g. atexit * in the C library), you must ensure that you always keep a live reference @@ -28,7 +28,7 @@ * exceptions thrown will be passed to the default callback exception * handler. * - * @defgroup JCALLBK HDF5 Library Java Callbacks + * @defgroup JCALLBK HDF5 Library Java H5Callbacks */ -public interface Callbacks { +public interface H5Callbacks { } diff --git a/java/src/hdf/hdf5lib/callbacks/H5D_append_cb.java b/java/src/hdf/hdf5lib/callbacks/H5D_append_cb.java index d29a4199fa0..7059f88d903 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5D_append_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5D_append_cb.java @@ -16,7 +16,7 @@ * Information class for link callback for H5Pset/get_append_flush. * */ -public interface H5D_append_cb extends Callbacks { +public interface H5D_append_cb extends H5Callbacks { /** * @ingroup JCALLBK * diff --git a/java/src/hdf/hdf5lib/callbacks/H5D_iterate_cb.java b/java/src/hdf/hdf5lib/callbacks/H5D_iterate_cb.java index 02f3069572d..4ecb45ac2d1 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5D_iterate_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5D_iterate_cb.java @@ -16,7 +16,7 @@ * Information class for link callback for H5Diterate. * */ -public interface H5D_iterate_cb extends Callbacks { +public interface H5D_iterate_cb extends H5Callbacks { /** * @ingroup JCALLBK * diff --git a/java/src/hdf/hdf5lib/callbacks/H5E_walk_cb.java b/java/src/hdf/hdf5lib/callbacks/H5E_walk_cb.java index b4e9eb61592..a48f9b03090 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5E_walk_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5E_walk_cb.java @@ -18,7 +18,7 @@ * Information class for link callback for H5Ewalk. * */ -public interface H5E_walk_cb extends Callbacks { +public interface H5E_walk_cb extends H5Callbacks { /** * @ingroup JCALLBK * diff --git a/java/src/hdf/hdf5lib/callbacks/H5L_iterate_t.java b/java/src/hdf/hdf5lib/callbacks/H5L_iterate_t.java index 1aaaabea5d6..771556e6372 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5L_iterate_t.java +++ b/java/src/hdf/hdf5lib/callbacks/H5L_iterate_t.java @@ -18,7 +18,7 @@ * Information class for link callback for H5Lvisit/H5Lvisit_by_name. * */ -public interface H5L_iterate_t extends Callbacks { +public interface H5L_iterate_t extends H5Callbacks { /** * @ingroup JCALLBK * diff --git a/java/src/hdf/hdf5lib/callbacks/H5O_iterate_t.java b/java/src/hdf/hdf5lib/callbacks/H5O_iterate_t.java index 74836a2eb5c..bb556310ec8 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5O_iterate_t.java +++ b/java/src/hdf/hdf5lib/callbacks/H5O_iterate_t.java @@ -18,7 +18,7 @@ * Information class for link callback for H5Ovisit/H5Ovisit_by_name. * */ -public interface H5O_iterate_t extends Callbacks { +public interface H5O_iterate_t extends H5Callbacks { /** * @ingroup JCALLBK * diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_cls_close_func_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_cls_close_func_cb.java index 4eccb24a003..f96eaabf0ac 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5P_cls_close_func_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5P_cls_close_func_cb.java @@ -16,7 +16,7 @@ * Information class for link callback for H5Pcreate_class. * */ -public interface H5P_cls_close_func_cb extends Callbacks { +public interface H5P_cls_close_func_cb extends H5Callbacks { /** * @ingroup JCALLBK * diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_cls_copy_func_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_cls_copy_func_cb.java index 332181079d8..f9fc94cb962 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5P_cls_copy_func_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5P_cls_copy_func_cb.java @@ -16,7 +16,7 @@ * Information class for link callback for H5Pcreate_class * */ -public interface H5P_cls_copy_func_cb extends Callbacks { +public interface H5P_cls_copy_func_cb extends H5Callbacks { /** * @ingroup JCALLBK * diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_cls_create_func_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_cls_create_func_cb.java index 43f915a4943..b16d9cdd249 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5P_cls_create_func_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5P_cls_create_func_cb.java @@ -16,7 +16,7 @@ * Information class for link callback for H5Pcreate_class. * */ -public interface H5P_cls_create_func_cb extends Callbacks { +public interface H5P_cls_create_func_cb extends H5Callbacks { /** * @ingroup JCALLBK * diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_iterate_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_iterate_cb.java index 6586a6aca8f..6fd4ecfd396 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5P_iterate_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5P_iterate_cb.java @@ -16,7 +16,7 @@ * Information class for link callback for H5Piterate. * */ -public interface H5P_iterate_cb extends Callbacks { +public interface H5P_iterate_cb extends H5Callbacks { /** * @ingroup JCALLBK * diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_prp_close_func_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_prp_close_func_cb.java index 4eb3b33ba19..a1cdcd7f7e0 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5P_prp_close_func_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5P_prp_close_func_cb.java @@ -16,7 +16,7 @@ * Information class for link callback for H5Pregister2. * */ -public interface H5P_prp_close_func_cb extends Callbacks { +public interface H5P_prp_close_func_cb extends H5Callbacks { /** * @ingroup JCALLBK * diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_prp_compare_func_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_prp_compare_func_cb.java index 91c2863c95a..f85935837e5 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5P_prp_compare_func_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5P_prp_compare_func_cb.java @@ -16,7 +16,7 @@ * Information class for link callback for H5Pregister2. * */ -public interface H5P_prp_compare_func_cb extends Callbacks { +public interface H5P_prp_compare_func_cb extends H5Callbacks { /** * @ingroup JCALLBK * diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_prp_copy_func_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_prp_copy_func_cb.java index 49827d1666b..4f5f7d16762 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5P_prp_copy_func_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5P_prp_copy_func_cb.java @@ -16,7 +16,7 @@ * Information class for link callback for H5Pregister2. * */ -public interface H5P_prp_copy_func_cb extends Callbacks { +public interface H5P_prp_copy_func_cb extends H5Callbacks { /** * @ingroup JCALLBK * diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_prp_create_func_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_prp_create_func_cb.java index 0391596994f..963ce4c0276 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5P_prp_create_func_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5P_prp_create_func_cb.java @@ -16,7 +16,7 @@ * Information class for link callback for H5Pregister2. * */ -public interface H5P_prp_create_func_cb extends Callbacks { +public interface H5P_prp_create_func_cb extends H5Callbacks { /** * @ingroup JCALLBK * diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_prp_delete_func_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_prp_delete_func_cb.java index 477612ff23b..2340de94b99 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5P_prp_delete_func_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5P_prp_delete_func_cb.java @@ -16,7 +16,7 @@ * Information class for link callback for H5Pregister2. * */ -public interface H5P_prp_delete_func_cb extends Callbacks { +public interface H5P_prp_delete_func_cb extends H5Callbacks { /** * @ingroup JCALLBK * diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_prp_get_func_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_prp_get_func_cb.java index 2bf08ce4322..7b4c3aca4ca 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5P_prp_get_func_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5P_prp_get_func_cb.java @@ -16,7 +16,7 @@ * Information class for link callback for H5Pregister2. * */ -public interface H5P_prp_get_func_cb extends Callbacks { +public interface H5P_prp_get_func_cb extends H5Callbacks { /** * @ingroup JCALLBK * diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_prp_set_func_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_prp_set_func_cb.java index 11f00d65fad..cffeaefcede 100644 --- a/java/src/hdf/hdf5lib/callbacks/H5P_prp_set_func_cb.java +++ b/java/src/hdf/hdf5lib/callbacks/H5P_prp_set_func_cb.java @@ -16,7 +16,7 @@ * Information class for link callback for H5Pregister2. * */ -public interface H5P_prp_set_func_cb extends Callbacks { +public interface H5P_prp_set_func_cb extends H5Callbacks { /** * @ingroup JCALLBK * diff --git a/java/src/hdf/hdf5lib/callbacks/package-info.java b/java/src/hdf/hdf5lib/callbacks/package-info.java index 323442c79b1..f0cefdfca78 100644 --- a/java/src/hdf/hdf5lib/callbacks/package-info.java +++ b/java/src/hdf/hdf5lib/callbacks/package-info.java @@ -11,8 +11,8 @@ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ /** - * @page CALLBACKS_UG HDF5 Java Callbacks Interface - * All callback definitions must derive from the Callbacks interface. Any + * @page CALLBACKS_UG HDF5 Java H5Callbacks Interface + * All callback definitions must derive from the H5Callbacks interface. Any * derived interfaces must define a single public method named "callback". * You are responsible for deregistering your callback (if necessary) * in its {@link Object#finalize} method. If native code attempts to call diff --git a/release_docs/RELEASE.txt b/release_docs/RELEASE.txt index 80a7019fed3..6cf9cfe5b44 100644 --- a/release_docs/RELEASE.txt +++ b/release_docs/RELEASE.txt @@ -537,7 +537,11 @@ Bug Fixes since HDF5-2.0.0 release Java Library ------------ - - + - Renamed the Callbacks.java file to H5Callbacks.java + + The Callbacks.java file was renamed to H5Callbacks.java to match the file + pattern used by doxygen. This change only affects the Java filenames and + does not change the classname or the package name. Configuration diff --git a/release_docs/RELEASE_PROCESS.md b/release_docs/RELEASE_PROCESS.md index a57a1dbe904..4bf8c3601cc 100644 --- a/release_docs/RELEASE_PROCESS.md +++ b/release_docs/RELEASE_PROCESS.md @@ -197,7 +197,7 @@ For more information on the HDF5 versioning and backward and forward compatibili - Change 'HDF5 target bucket directory' to 'vX_Y/vX_Y_Z' - Press "Run Workflow" -### 10. Add the contents of the RELEASE.txt file in the release code to the HISTORY- file in the **support** branch, just below the introductory lines at the top of the HISTORY file. +### 10. Add the contents of the RELEASE.txt file in the release code to the HISTORY-X_Y file in the **support** branch, just below the introductory lines at the top of the HISTORY file. ### 11. Conduct Release Retrospective (Release Manager) 1. Schedule time and solicit comments from retrospective @@ -216,5 +216,5 @@ For more information on the HDF5 versioning and backward and forward compatibili [u11]: https://github.com/HDFGroup/hdf5/blob/develop/src/CMakeLists.txt [u12]: https://github.com/HDFGroup/hdf5/blob/develop/configure.ac [u13]: https://hdfgroup.github.io/hdf5/develop/api-compat-macros.html -[u14]: https://github.com/HDFGroup/hdf5/releases/tag/snapshot-2.0.0 +[u14]: https://github.com/HDFGroup/hdf5/releases/tag/snapshot-1.14 [u15]: https://github.com/HDFGroup/hdf5/releases/tag/snapshot diff --git a/src/H5FDmodule.h b/src/H5FDmodule.h index d692b8fef0d..13b8dbd69d8 100644 --- a/src/H5FDmodule.h +++ b/src/H5FDmodule.h @@ -25,5 +25,9 @@ #define H5_MY_PKG H5FD #define H5_MY_PKG_ERR H5E_VFL #define H5_MY_PKG_INIT YES +/** + * \defgroup H5VFD Virtual File Driver Features + * + */ #endif /* H5FDmodule_H */ diff --git a/src/H5FDonion.h b/src/H5FDonion.h index 5c374bb16dd..080970297a5 100644 --- a/src/H5FDonion.h +++ b/src/H5FDonion.h @@ -162,7 +162,7 @@ H5_DLL herr_t H5Pset_fapl_onion(hid_t fapl_id, const H5FD_onion_fapl_info_t *fa) /** * -------------------------------------------------------------------------- - * \ingroup H5FD + * \ingroup H5VFD * * \brief get the number of revisions * diff --git a/src/H5FDpublic.h b/src/H5FDpublic.h index 0fc45125226..40c64c760a4 100644 --- a/src/H5FDpublic.h +++ b/src/H5FDpublic.h @@ -418,7 +418,7 @@ extern "C" { /* Function prototypes */ /** - * \ingroup H5FD + * \ingroup H5VFD * * \brief Allows querying a VFD ID for features before the file is opened * diff --git a/src/H5Pmodule.h b/src/H5Pmodule.h index 6a65f3a269b..cd747b5a8f9 100644 --- a/src/H5Pmodule.h +++ b/src/H5Pmodule.h @@ -1114,6 +1114,10 @@ * TAPL isn't supported yet. * * + * \defgroup MAPL VOL Data Mapping Properties + * \ingroup H5P + * Empty property class. + * * */ diff --git a/src/H5Tmodule.h b/src/H5Tmodule.h index 44aba1cb7fa..5d9ee022d8c 100644 --- a/src/H5Tmodule.h +++ b/src/H5Tmodule.h @@ -4087,6 +4087,8 @@ filled according to the value of this property. The padding can be: * \ingroup H5T * \defgroup ATOM Atomic Datatypes * \ingroup H5T + * \defgroup COMPLEX Complex Datatypes + * \ingroup H5T * \defgroup CONV Conversion Function * \ingroup H5T * \defgroup OPAQUE Opaque Datatypes diff --git a/src/H5Zmodule.h b/src/H5Zmodule.h index d8e01676d6f..4458481d36f 100644 --- a/src/H5Zmodule.h +++ b/src/H5Zmodule.h @@ -130,6 +130,8 @@ * \ingroup H5ZPRE * \defgroup SZIP Szip Filter * \ingroup H5ZPRE + * \defgroup NBIT N-bit Filter + * \ingroup H5ZPRE * */