From a043b33878f6c59892c0d8738394659d8f1eccba Mon Sep 17 00:00:00 2001 From: Larry Knox Date: Mon, 25 Mar 2024 14:45:17 -0500 Subject: [PATCH] Update links in documentation from develop to v1_14. --- CONTRIBUTING.md | 2 +- doxygen/aliases | 2 +- doxygen/dox/About.dox | 4 ++-- doxygen/dox/GettingStarted.dox | 2 +- doxygen/dox/IntroHDF5.dox | 2 +- doxygen/dox/LearnBasics3.dox | 8 ++++---- doxygen/dox/Overview.dox | 2 +- release_docs/USING_HDF5_CMake.txt | 2 +- src/H5Fmodule.h | 4 ++-- src/H5Ppublic.h | 2 +- test/API/README.md | 2 +- 11 files changed, 16 insertions(+), 16 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 341d10acfe6..013051dbab1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -122,7 +122,7 @@ 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/develop/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/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)? diff --git a/doxygen/aliases b/doxygen/aliases index 0f5a4a4ed8f..71d0d67709a 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/About.dox b/doxygen/dox/About.dox index 06fbb3cdb87..e60e0fbdc7a 100644 --- a/doxygen/dox/About.dox +++ b/doxygen/dox/About.dox @@ -81,7 +81,7 @@ as a general reference. All custom commands for this project are located in the aliases -file in the doxygen +file in the doxygen subdirectory of the main HDF5 repo. The custom commands are grouped in sections. Find a suitable section for your command or @@ -124,4 +124,4 @@ version. Talk to your friendly IT-team if you need write access, or you need someone to push an updated version for you! -*/ \ No newline at end of file +*/ diff --git a/doxygen/dox/GettingStarted.dox b/doxygen/dox/GettingStarted.dox index feb5f919f9a..58f71f82a4e 100644 --- a/doxygen/dox/GettingStarted.dox +++ b/doxygen/dox/GettingStarted.dox @@ -72,7 +72,7 @@ HDF5-1.10 New Features \li Introduction to the Virtual Dataset - VDS -\li Introduction to Single-Writer/Multiple-Reader (SWMR) +\li Introduction to Single-Writer/Multiple-Reader (SWMR) diff --git a/doxygen/dox/IntroHDF5.dox b/doxygen/dox/IntroHDF5.dox index 33cf4a91ca8..4a00b80b2f8 100644 --- a/doxygen/dox/IntroHDF5.dox +++ b/doxygen/dox/IntroHDF5.dox @@ -608,7 +608,7 @@ on the HDF-EOS Tools and Information Center pag \section secHDF5Examples Examples \li \ref LBExamples \li \ref ExAPI -\li Examples in the Source Code +\li Examples in the Source Code \li Other Examples \section secHDF5ExamplesCompile How To Compile diff --git a/doxygen/dox/LearnBasics3.dox b/doxygen/dox/LearnBasics3.dox index 81e3cb0dac7..67a4b12e106 100644 --- a/doxygen/dox/LearnBasics3.dox +++ b/doxygen/dox/LearnBasics3.dox @@ -294,12 +294,12 @@ Specifically look at the \ref ExAPI. There are examples for different languages, where examples of using #H5Literate and #H5Ovisit/#H5Lvisit are included. The h5ex_g_traverse example traverses a file using H5Literate: -\li C: h5ex_g_traverse.c -\li F90: h5ex_g_traverse_F03.f90 +\li C: h5ex_g_traverse.c +\li F90: h5ex_g_traverse_F03.f90 The h5ex_g_visit example traverses a file using H5Ovisit and H5Lvisit: -\li C: h5ex_g_visit.c -\li F90: h5ex_g_visit_F03.f90 +\li C: h5ex_g_visit.c +\li F90: h5ex_g_visit_F03.f90
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics diff --git a/doxygen/dox/Overview.dox b/doxygen/dox/Overview.dox index 3bb4e17f15e..baea62bdf37 100644 --- a/doxygen/dox/Overview.dox +++ b/doxygen/dox/Overview.dox @@ -23,7 +23,7 @@ documents cover a mix of tasks, concepts, and reference, to help a specific \par Versions Version-specific documentation (see the version in the title area) can be found here: - - HDF5 develop branch + - HDF5 1.14 branch - HDF5 1.14.x (this site) - HDF5 1.12.x - HDF5 1.10.x diff --git a/release_docs/USING_HDF5_CMake.txt b/release_docs/USING_HDF5_CMake.txt index a691647f51d..621a769273a 100644 --- a/release_docs/USING_HDF5_CMake.txt +++ b/release_docs/USING_HDF5_CMake.txt @@ -234,7 +234,7 @@ adjust the forward slash to double backslashes, except for the HDF_DIR environment variable. NOTE: this file is available in the HDF5 repository, for more information see: - https://github.com/HDFGroup/hdf5/blob/develop/release_docs/USING_CMake_Examples.txt + https://github.com/HDFGroup/hdf5/blob/v1_14/release_docs/USING_CMake_Examples.txt ctest -S HDF5_Examples.cmake -C Release -V -O test.log diff --git a/src/H5Fmodule.h b/src/H5Fmodule.h index 1cabd76057d..a5e42aa810c 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 diff --git a/src/H5Ppublic.h b/src/H5Ppublic.h index 43cebec8bc0..ab809a58654 100644 --- a/src/H5Ppublic.h +++ b/src/H5Ppublic.h @@ -8823,7 +8823,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/test/API/README.md b/test/API/README.md index 84f1c04dfc5..bd09b153aa4 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/develop/_h5_v_l__u_g.html). +public API and serve as regression tests for HDF5 [VOL Connectors](https://docs.hdfgroup.org/hdf5/v1_14/_h5_v_l__u_g.html). ## Build Process and options