From f2413bccbea5666dc5c1acb6d4358dd7601e96d4 Mon Sep 17 00:00:00 2001 From: Allen Byrne <50328838+byrnHDF@users.noreply.github.com> Date: Tue, 17 Sep 2024 16:55:31 -0500 Subject: [PATCH] Use the correct doxygen URL in 1.14 branches (#4844) --- CONTRIBUTING.md | 4 ++-- README.md | 6 +++--- doc/parallel-compression.md | 22 +++++++++++----------- doxygen/aliases | 2 +- doxygen/examples/H5.format.1.1.html | 4 ++-- release_docs/INSTALL_Autotools.txt | 2 +- release_docs/RELEASE_PROCESS.md | 2 +- test/API/README.md | 4 ++-- 8 files changed, 23 insertions(+), 23 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a1a22aa3fcb..56ba40a0963 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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://hdfgroup.github.io/hdf5/v1_14/api-compat-macros.html) + * [ ] Does the new feature require a change to an existing API? See "API Compatibility Macros" document (https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/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://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_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 b4b88ad7540..d978f2b0994 100644 --- a/README.md +++ b/README.md @@ -23,15 +23,15 @@ DOCUMENTATION ------------- This release is fully functional for the API described in the documentation. - https://hdfgroup.github.io/hdf5/v1_14/_l_b_a_p_i.html + https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_l_b_a_p_i.html Full Documentation and Programming Resources for this release can be found at - https://hdfgroup.github.io/hdf5/v1_14/index.html + https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/index.html The latest doxygen documentation generated on changes to HDF5 1.14.x is available at: - https://hdfgroup.github.io/hdf5/v1_14 + https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen See the [RELEASE.txt](release_docs/RELEASE.txt) file in the [release_docs/](release_docs/) directory for information specific to the features and updates included in this release of the library. diff --git a/doc/parallel-compression.md b/doc/parallel-compression.md index ba46fd6de72..d1c8ce63bf7 100644 --- a/doc/parallel-compression.md +++ b/doc/parallel-compression.md @@ -335,17 +335,17 @@ hid_t file_id = H5Fcreate("file.h5", H5F_ACC_TRUNC, H5P_DEFAULT, fapl_id); [u1]: https://github.com/HDFGroup/hdf5/blob/hdf5_1_14/HDF5Examples/C/H5PAR/ph5_filtered_writes.c [u2]: https://github.com/HDFGroup/hdf5/blob/hdf5_1_14/HDF5Examples/C/H5PAR/ph5_filtered_writes_no_sel.c -[u3]: https://hdfgroup.github.io/hdf5/hdf5_1_14/group___h5_d.html#gaf6213bf3a876c1741810037ff2bb85d8 -[u4]: https://hdfgroup.github.io/hdf5/hdf5_1_14/group___h5_d.html#ga8eb1c838aff79a17de385d0707709915 -[u5]: https://hdfgroup.github.io/hdf5/hdf5_1_14/group___d_c_p_l.html#ga85faefca58387bba409b65c470d7d851 -[u6]: https://hdfgroup.github.io/hdf5/hdf5_1_14/group___d_c_p_l.html#ga4335bb45b35386daa837b4ff1b9cd4a4 -[u7]: https://hdfgroup.github.io/hdf5/hdf5_1_14/group___d_c_p_l.html#ga6bd822266b31f86551a9a1d79601b6a2 +[u3]: https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/group___h5_d.html#gaf6213bf3a876c1741810037ff2bb85d8 +[u4]: https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/group___h5_d.html#ga8eb1c838aff79a17de385d0707709915 +[u5]: https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/group___d_c_p_l.html#ga85faefca58387bba409b65c470d7d851 +[u6]: https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/group___d_c_p_l.html#ga4335bb45b35386daa837b4ff1b9cd4a4 +[u7]: https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/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 [u10]: https://support.hdfgroup.org/releases/hdf5/documentation/hdf5_topics/HDF5ImprovingIOPerformanceCompressedDatasets.pdf -[u11]: https://hdfgroup.github.io/hdf5/hdf5_1_14/group___f_a_p_l.html#gab99d5af749aeb3896fd9e3ceb273677a -[u12]: https://hdfgroup.github.io/hdf5/hdf5_1_14/group___f_c_p_l.html#ga167ff65f392ca3b7f1933b1cee1b9f70 -[u13]: https://hdfgroup.github.io/hdf5/hdf5_1_14/group___f_c_p_l.html#gad012d7f3c2f1e1999eb1770aae3a4963 -[u14]: https://hdfgroup.github.io/hdf5/hdf5_1_14/group___d_x_p_l.html#ga001a22b64f60b815abf5de8b4776f09e -[u15]: https://hdfgroup.github.io/hdf5/hdf5_1_14/group___d_x_p_l.html#gacb30d14d1791ec7ff9ee73aa148a51a3 -[u16]: https://hdfgroup.github.io/hdf5/hdf5_1_14/group___f_a_p_l.html#gacbe1724e7f70cd17ed687417a1d2a910 +[u11]: https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/group___f_a_p_l.html#gab99d5af749aeb3896fd9e3ceb273677a +[u12]: https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/group___f_c_p_l.html#ga167ff65f392ca3b7f1933b1cee1b9f70 +[u13]: https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/group___f_c_p_l.html#gad012d7f3c2f1e1999eb1770aae3a4963 +[u14]: https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/group___d_x_p_l.html#ga001a22b64f60b815abf5de8b4776f09e +[u15]: https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/group___d_x_p_l.html#gacb30d14d1791ec7ff9ee73aa148a51a3 +[u16]: https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/group___f_a_p_l.html#gacbe1724e7f70cd17ed687417a1d2a910 diff --git a/doxygen/aliases b/doxygen/aliases index d35fc24cb7a..90a6cf9fd5b 100644 --- a/doxygen/aliases +++ b/doxygen/aliases @@ -15,7 +15,7 @@ ALIASES += DWNURL="\HDFURL/releases/hdf5/downloads" ALIASES += RFCURL="\DOCURL/rfc" ALIASES += AEXURL="\HDFURL/archive/support/ftp/HDF5/examples" # doxygen subdir (develop, v1_14) -ALIASES += DOXURL="hdfgroup.github.io/hdf5/v1_14" +ALIASES += DOXURL="support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen" #branch name (develop, hdf5_1_14) ALIASES += SRCURL="github.com/HDFGroup/hdf5/blob/hdf5_1_14" #Other projects that contribute to HDF5 diff --git a/doxygen/examples/H5.format.1.1.html b/doxygen/examples/H5.format.1.1.html index 418afd5ab88..9d9dc662618 100644 --- a/doxygen/examples/H5.format.1.1.html +++ b/doxygen/examples/H5.format.1.1.html @@ -5558,8 +5558,8 @@

Name: Data Storage - Filter Pipeline

1If you are reading an earlier version of this document, this link may have changed. If the link does not work, use the latest version of this document - on The HDF Group’s website, - + on The HDF Group’s website, + H5.format.html; the link there will always be correct. (Return) diff --git a/release_docs/INSTALL_Autotools.txt b/release_docs/INSTALL_Autotools.txt index 7ff6e7c5a59..16ecd034029 100644 --- a/release_docs/INSTALL_Autotools.txt +++ b/release_docs/INSTALL_Autotools.txt @@ -359,7 +359,7 @@ III. Full installation instructions for source distributions source code. For additional configuration options and other details, see "API Compatibility Macros": - https://hdfgroup.github.io/hdf5/v1_14/api-compat-macros.html + https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/api-compat-macros.html 4. Building The library, confidence tests, and programs can be built by diff --git a/release_docs/RELEASE_PROCESS.md b/release_docs/RELEASE_PROCESS.md index 5ba4e0dbabc..4dd9a1b7922 100644 --- a/release_docs/RELEASE_PROCESS.md +++ b/release_docs/RELEASE_PROCESS.md @@ -175,6 +175,6 @@ For more information on the HDF5 versioning and backward and forward compatibili [u10]: https://github.com/HDFGroup/hdf5/blob/hdf5_1_14/bin/h5vers [u11]: https://github.com/HDFGroup/hdf5/blob/hdf5_1_14/src/CMakeLists.txt [u12]: https://github.com/HDFGroup/hdf5/blob/hdf5_1_14/configure.ac -[u13]: https://hdfgroup.github.io/hdf5/v1_14/api-compat-macros.html +[u13]: https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/api-compat-macros.html [u14]: https://github.com/HDFGroup/hdf5/releases/tag/snapshot-1.14 [u15]: https://github.com/HDFGroup/hdf5/releases/tag/snapshot diff --git a/test/API/README.md b/test/API/README.md index 02554eb8609..272268e90db 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://hdfgroup.github.io/hdf5/v1_14/_h5_v_l__u_g.html). +public API and serve as regression tests for HDF5 [VOL Connectors](https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_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://hdfgroup.github.io/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://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_v_o_l__connector.html). TODO: section on building VOL connectors alongside HDF5 for use with tests