diff --git a/.github/workflows/release-files.yml b/.github/workflows/release-files.yml index 3d90efee6e1..0faf0d1fc20 100644 --- a/.github/workflows/release-files.yml +++ b/.github/workflows/release-files.yml @@ -230,9 +230,9 @@ jobs: ls -l ${{ github.workspace }} ls ${{ runner.workspace }} - - name: branch-only-docs + - name: rel-branch-only-docs uses: peaceiris/actions-gh-pages@373f7f263a76c20808c831209c920827a82a2847 # v3.9.3 with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ${{ github.workspace }}/${{ steps.get-file-base.outputs.FILE_BASE }}.doxygen - destination_dir: v1_14 + destination_dir: v1_14_4 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 013051dbab1..b4f74326efe 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,12 +16,12 @@ around 10 minutes. ## Table of Contents -* [Workflow](#workflow) -* [Acceptance criteria for a pull request](#criteria) -* [Release Note](#releasenote) -* [Check List](#checklist) +* Workflow +* Acceptance criteria for a pull request +* Release Note +* Check List -# Workflow +

Workflow

The process for contributing code to HDF5 is as follows: @@ -41,7 +41,7 @@ Once a pull request is correctly formatted and passes **ALL** CI tests, it will community members who can approve pull requests. The HDF Group developers will work with you to ensure that the pull request satisfies the acceptance criteria described in the next section. -# Acceptance criteria for a pull request +

Acceptance criteria for a pull request

We appreciate every contribution we receive, but we may not accept them all. Those that we *do* satisfy the following criteria: @@ -84,7 +84,7 @@ application developers and not system administrators. Users who may find the REL application developers, library developers, and system administrators. -# Release Note +

Release Note

* **Entry Syntax** The release note entry syntax is shown below. @@ -112,7 +112,7 @@ You might also consider the following as you describe the solution: * Is there a workaround – a way for users design their software so as not to encounter the issue? If so, what is the workaround? * For a performance fix, how has the performance improved? Links to published documentation would be good. -# Checklist +

Checklist

Please make sure that you check the items applicable to your pull request: @@ -122,10 +122,10 @@ Please make sure that you check the items applicable to your pull request: * [ ] If changes were done to Autotools build, were they added to CMake and vice versa? * [ ] Is the pull request applicable to any other branches? If yes, which ones? Please document it in the GitHub issue. * [ ] Is the new code sufficiently documented for future maintenance? - * [ ] Does the new feature require a change to an existing API? See "API Compatibility Macros" document (https://docs.hdfgroup.org/hdf5/v1_14/api-compat-macros.html) + * [ ] Does the new feature require a change to an existing API? See "API Compatibility Macros" document (https://docs.hdfgroup.org/hdf5/v1_14_4/api-compat-macros.html) * Documentation * [ ] Was the change described in the release_docs/RELEASE.txt file? - * [ ] Was the new function documented in the corresponding public header file using [Doxygen](https://hdfgroup.github.io/hdf5/v1_14/_r_m_t.html)? + * [ ] Was the new function documented in the corresponding public header file using [Doxygen](https://hdfgroup.github.io/hdf5/v1_14_4/_r_m_t.html)? * [ ] Was new functionality documented for the HDF5 community (the level of documentation depends on the feature; ask us what would be appropriate) * Testing * [ ] Does the pull request have tests? diff --git a/README.md b/README.md index ce89f1d8f13..6a9aa254022 100644 --- a/README.md +++ b/README.md @@ -21,11 +21,11 @@ DOCUMENTATION ------------- This release is fully functional for the API described in the documentation. - https://docs.hdfgroup.org/hdf5/v1_14/_l_b_a_p_i.html + https://docs.hdfgroup.org/hdf5/v1_14_4/_l_b_a_p_i.html Full Documentation and Programming Resources for this release can be found at - https://docs.hdfgroup.org/hdf5/v1_14/index.html + https://docs.hdfgroup.org/hdf5/v1_14_4/index.html The latest doxygen documentation generated on changes to HDF5 1.14.x is available at: diff --git a/doxygen/Doxyfile.in b/doxygen/Doxyfile.in index 318b2eb848b..7c277241cd8 100644 --- a/doxygen/Doxyfile.in +++ b/doxygen/Doxyfile.in @@ -688,6 +688,7 @@ FILE_PATTERNS = H5*public.h H5*module.h H5*develop.h H5FD*.h \ HDF*.java \ *.F90 \ *.dox \ + *.md \ H5Cpp.h H5AbstractDs.h H5AtomType.h H5Attribute.h H5CommonFG.h H5CompType.h \ H5DataSet.h H5DataSpace.h H5DataType.h H5OcreatProp.h H5DaccProp.h H5DcreatProp.h \ H5DxferProp.h H5EnumType.h H5Exception.h H5FaccProp.h H5FcreatProp.h H5File.h \ @@ -708,8 +709,7 @@ RECURSIVE = YES # Note that relative paths are relative to the directory from which doxygen is # run. -EXCLUDE = examples - +EXCLUDE = # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded # from the input. @@ -734,6 +734,8 @@ EXCLUDE_PATTERNS += */hl/fortran/test/* EXCLUDE_PATTERNS += */hl/fortran/src/*.c EXCLUDE_PATTERNS += */hl/fortran/src/*.h EXCLUDE_PATTERNS += */HDF5Examples/FORTRAN/* +EXCLUDE_PATTERNS += */sanitizer/* + # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the diff --git a/doxygen/aliases b/doxygen/aliases index e2191cd4bd5..d9167d5556d 100644 --- a/doxygen/aliases +++ b/doxygen/aliases @@ -237,7 +237,7 @@ ALIASES += sa_metadata_ops="\sa \li H5Pget_all_coll_metadata_ops() \li H5Pget_co ALIASES += ref_cons_semantics="Enabling a Strict Consistency Semantics Model in Parallel HDF5" ALIASES += ref_file_image_ops="HDF5 File Image Operations" ALIASES += ref_filter_pipe="Data Flow Pipeline for H5Dread()" -ALIASES += ref_group_impls="Group implementations in HDF5" +ALIASES += ref_group_impls="Group implementations in HDF5" ALIASES += ref_h5lib_relver="HDF5 Library Release Version Numbers" ALIASES += ref_mdc_in_hdf5="Metadata Caching in HDF5" ALIASES += ref_mdc_logging="Metadata Cache Logging" diff --git a/doxygen/dox/GettingStarted.dox b/doxygen/dox/GettingStarted.dox index 58f71f82a4e..058d3cd0f7b 100644 --- a/doxygen/dox/GettingStarted.dox +++ b/doxygen/dox/GettingStarted.dox @@ -42,10 +42,10 @@ Parallel HDF5, and the HDF5-1.10 VDS and SWMR new features: @@ -72,7 +72,7 @@ HDF5-1.10 New Features diff --git a/doxygen/dox/Overview.dox b/doxygen/dox/Overview.dox index 3bb4e17f15e..5932014f962 100644 --- a/doxygen/dox/Overview.dox +++ b/doxygen/dox/Overview.dox @@ -24,7 +24,7 @@ documents cover a mix of tasks, concepts, and reference, to help a specific Version-specific documentation (see the version in the title area) can be found here: - HDF5 develop branch - - HDF5 1.14.x (this site) + - HDF5 1.14.x (this site) - HDF5 1.12.x - HDF5 1.10.x - HDF5 1.8.x diff --git a/doxygen/dox/ViewTools.dox b/doxygen/dox/ViewTools.dox index cef6b6f0ef8..73571da5283 100644 --- a/doxygen/dox/ViewTools.dox +++ b/doxygen/dox/ViewTools.dox @@ -997,7 +997,7 @@ In other words, it is an array of four elements, in which each element is a 3 by This dataset is much more complex. Also note that subsetting cannot be done on Array datatypes. -See this section for more information on the Array datatype. +See this section for more information on the Array datatype. \subsubsection subsubsecViewToolsViewDtypes_objref Object Reference An Object Reference is a reference to an entire object (dataset, group, or named datatype). diff --git a/doxygen/examples/FileFormat.html b/doxygen/examples/FileFormat.html index 30428e3cad2..6abf945dec5 100644 --- a/doxygen/examples/FileFormat.html +++ b/doxygen/examples/FileFormat.html @@ -36,7 +36,7 @@

  • Background Reading:

    -
    HDF5 File Format Specification +
    HDF5 File Format Specification
    This describes the current HDF5 file format.
    diff --git a/doxygen/examples/menus/high_level_menu.md b/doxygen/examples/menus/high_level_menu.md index d209bf45430..9e7dc913272 100644 --- a/doxygen/examples/menus/high_level_menu.md +++ b/doxygen/examples/menus/high_level_menu.md @@ -1,4 +1,5 @@ -High-level library +## High-level Library +
    The high-level HDF5 library includes several sets of convenience and standard-use APIs to facilitate common HDF5 operations. diff --git a/fortran/src/README.md b/fortran/src/README.md index 229e546750f..26374128b65 100644 --- a/fortran/src/README.md +++ b/fortran/src/README.md @@ -109,11 +109,7 @@ FOR DEVELOPERS The valid KINDs for integers and reals that are stored in H5config_f.inc are used in the H5_buildiface.F90 file located in the fortran/src directory. During the build process, H5_buildiface.F90 generates all the valid F90 KIND interfaces for the following APIs: h5awrite_f, h5aread_f, h5dwrite_f, h5dread_f, h5pset_fill_value_f, h5pget_fill_value_f, h5pset_f, h5pget_f, h5pregister_f, and h5pinsert_f. These APIs can handle up to and including rank seven arrays for all the found KINDs. Again, it's important to note that no new Fortran APIs should be added to H5_buildiface.F90 since new Fortran APIs should not use F90 specification but should instead use F2003. The source file generated by H5_buildiface.F90 is H5_gen.F90, which is the Fortran module H5_GEN, Figure 1. This module is included in the HDF5 module HDF5.F90. -
    - - -
    Figure 1: During the configure and build phases, Fortran files are generated and compiled. This overview explains the flow steps of the build process.
    -
    + ![Figure 1: During the configure and build phases, Fortran files are generated and compiled. This overview explains the flow steps of the build process.](./FortBuildFlow.svg) Procedure to add a new function -------------------------------- diff --git a/release_docs/NEWSLETTER.txt b/release_docs/NEWSLETTER.txt index c8528a51657..7f0ef698a75 100644 --- a/release_docs/NEWSLETTER.txt +++ b/release_docs/NEWSLETTER.txt @@ -1,4 +1,4 @@ -HDF5 version 1.14.4 currently under development +HDF5 version 1.14.4 released on 2024-04-11 This is a maintenance release with a few changes and updates: ---------------------------------------------------------------------------- diff --git a/src/H5Fmodule.h b/src/H5Fmodule.h index 61c6d387fce..72a7cc86652 100644 --- a/src/H5Fmodule.h +++ b/src/H5Fmodule.h @@ -235,10 +235,10 @@ * Note that the root group, indicated above by /, was automatically created when the file was created. * * h5dump is described on the - * + * * Tools * page under - * Command-line Tools. + * Command-line Tools. * The HDF5 DDL grammar is described in the document \ref DDLBNF114. * * \subsection subsec_file_summary File Function Summaries @@ -712,7 +712,7 @@ * If the application opens an HDF5 file without both determining the driver used to create the file * and setting up the use of that driver, the HDF5 Library will examine the superblock and the * driver definition block to identify the driver. - * See the HDF5 File Format Specification + * See the HDF5 File Format Specification * for detailed descriptions of the superblock and the driver definition block. * * \subsubsection subsubsec_file_alternate_drivers_sec2 The POSIX (aka SEC2) Driver diff --git a/src/H5Ppublic.h b/src/H5Ppublic.h index 67425a9c02a..df9d4ee752c 100644 --- a/src/H5Ppublic.h +++ b/src/H5Ppublic.h @@ -9031,7 +9031,7 @@ H5_DLL herr_t H5Pset_link_phase_change(hid_t plist_id, unsigned max_compact, uns * must be created and maintained in the original style. This is HDF5's default * behavior. If backward compatibility with pre-1.8.0 libraries is not a concern, * greater efficiencies can be obtained with the new-format compact and indexed - * groups. See Group + * groups. See Group * implementations in HDF5 in the \ref H5G API introduction (at the bottom).\n * H5Pset_local_heap_size_hint() is useful for tuning file size when files * contain original-style groups with either zero members or very large diff --git a/src/H5module.h b/src/H5module.h index 296194f6af1..f1c5695d7c6 100644 --- a/src/H5module.h +++ b/src/H5module.h @@ -49,7 +49,7 @@ * The Abstract Data Model is a conceptual model of data, data types, and data organization. The * abstract data model is independent of storage medium or programming environment. The * Storage Model is a standard representation for the objects of the abstract data model. The - * HDF5 File Format Specification + * HDF5 File Format Specification * defines the storage model. * * The Programming Model is a model of the computing environment and includes platforms from @@ -100,7 +100,7 @@ * model, and stored in a storage medium. The stored objects include header blocks, free lists, data * blocks, B-trees, and other objects. Each group or dataset is stored as one or more header and data * blocks. - * @see HDF5 File Format Specification + * @see HDF5 File Format Specification * for more information on how these objects are organized. The HDF5 library can also use other * libraries and modules such as compression. * @@ -125,7 +125,7 @@ * HDF5 abstract data model is up to the application developer. The application program only * needs to deal with the library and the abstract data model. Most applications need not consider * any details of the - * HDF5 File Format Specification + * HDF5 File Format Specification * or the details of how objects of abstract data model are translated to and from storage. * * \subsection subsec_data_model_abstract The Abstract Data Model @@ -408,7 +408,7 @@ * * \subsection subsec_data_model_storage The HDF5 Storage Model * \subsubsection subsubsec_data_model_storage_spec The Abstract Storage Model: the HDF5 Format Specification - * The HDF5 File Format Specification + * The HDF5 File Format Specification * defines how HDF5 objects and data are mapped to a linear * address space. The address space is assumed to be a contiguous array of bytes stored on some * random access medium. The format defines the standard for how the objects of the abstract data diff --git a/test/API/README.md b/test/API/README.md index bd09b153aa4..3491b71c9d2 100644 --- a/test/API/README.md +++ b/test/API/README.md @@ -1,7 +1,7 @@ # HDF5 API Tests This directory contains several test applications that exercise HDF5's -public API and serve as regression tests for HDF5 [VOL Connectors](https://docs.hdfgroup.org/hdf5/v1_14/_h5_v_l__u_g.html). +public API and serve as regression tests for HDF5 [VOL Connectors](https://docs.hdfgroup.org/hdf5/v1_14_4/_h5_v_l__u_g.html). ## Build Process and options @@ -42,7 +42,7 @@ Currently unsupported These API tests currently only support usage with the native HDF5 VOL connector and HDF5 VOL connectors that can be loaded dynamically as a plugin. For information on how to build a VOL -connector in this manner, refer to section 2.3 of the [HDF5 VOL Connector Author Guide](https://docs.hdfgroup.org/hdf5/v1_14/_v_o_l__connector.html). +connector in this manner, refer to section 2.3 of the [HDF5 VOL Connector Author Guide](https://docs.hdfgroup.org/hdf5/v1_14_4/_v_o_l__connector.html). TODO: section on building VOL connectors alongside HDF5 for use with tests
    • -Using the High Level APIs +[Using the High Level API](../examples/menus/high_level_menu.md) -\ref H5LT \ref H5IM \ref H5TB \ref H5PT \ref H5DS +The high-level HDF5 library includes several sets of convenience and standard-use APIs to facilitate common HDF5 operations.
    \li Introduction to the Virtual Dataset - VDS -\li Introduction to Single-Writer/Multiple-Reader (SWMR) +\li Introduction to Single-Writer/Multiple-Reader (SWMR)