Skip to content

Commit

Permalink
Update links in documentation from develop to v1_14.
Browse files Browse the repository at this point in the history
  • Loading branch information
lrknox committed Mar 25, 2024
1 parent a7d5f31 commit a043b33
Show file tree
Hide file tree
Showing 11 changed files with 16 additions and 16 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)?
Expand Down
2 changes: 1 addition & 1 deletion doxygen/aliases
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ ALIASES += sa_metadata_ops="\sa \li H5Pget_all_coll_metadata_ops() \li H5Pget_co
ALIASES += ref_cons_semantics="<a href=\"https://docs.hdfgroup.org/hdf5/rfc/RFC%20PHDF5%20Consistency%20Semantics%20MC%20120328.docx.pdf\">Enabling a Strict Consistency Semantics Model in Parallel HDF5</a>"
ALIASES += ref_file_image_ops="<a href=\"https://docs.hdfgroup.org/hdf5/rfc/HDF5FileImageOperations.pdf\">HDF5 File Image Operations</a>"
ALIASES += ref_filter_pipe="<a href=\"https://portal.hdfgroup.org/display/HDF5/HDF5+Data+Flow+Pipeline+for+H5Dread\">Data Flow Pipeline for H5Dread()</a>"
ALIASES += ref_group_impls="<a href=\"https://docs.hdfgroup.org/hdf5/develop/group___h5_g.html\">Group implementations in HDF5</a>"
ALIASES += ref_group_impls="<a href=\"https://docs.hdfgroup.org/hdf5/v1_14/group___h5_g.html\">Group implementations in HDF5</a>"
ALIASES += ref_h5lib_relver="<a href=\"https://docs.hdfgroup.org/archive/support/HDF5/doc/TechNotes/Version.html\">HDF5 Library Release Version Numbers</a>"
ALIASES += ref_mdc_in_hdf5="<a href=\"https://portal.hdfgroup.org/display/HDF5/Metadata+Caching+in+HDF5\">Metadata Caching in HDF5</a>"
ALIASES += ref_mdc_logging="<a href=\"https://portal.hdfgroup.org/display/HDF5/H5F_START_MDC_LOGGING\">Metadata Cache Logging</a>"
Expand Down
4 changes: 2 additions & 2 deletions doxygen/dox/About.dox
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ as a general reference.

All custom commands for this project are located in the
<a href="https://github.com/HDFGroup/hdf5/blob/hdf5_1_14/doxygen/aliases"><tt>aliases</tt></a>
file in the <a href="https://github.com/HDFGroup/hdf5/tree/develop/doxygen"><tt>doxygen</tt></a>
file in the <a href="https://github.com/HDFGroup/hdf5/tree/hdf5_1_14/doxygen"><tt>doxygen</tt></a>
subdirectory of the <a href="https://github.com/HDFGroup/hdf5">main HDF5 repo</a>.

The custom commands are grouped in sections. Find a suitable section for your command or
Expand Down Expand Up @@ -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!

*/
*/
2 changes: 1 addition & 1 deletion doxygen/dox/GettingStarted.dox
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ HDF5-1.10 New Features
</td>
<td>
\li <a href="https://portal.hdfgroup.org/display/HDF5/Introduction+to+the+Virtual+Dataset++-+VDS">Introduction to the Virtual Dataset - VDS</a>
\li <a href="https://docs.hdfgroup.org/hdf5/develop/group___s_w_m_r.html">Introduction to Single-Writer/Multiple-Reader (SWMR)</a>
\li <a href="https://docs.hdfgroup.org/hdf5/v1_14/group___s_w_m_r.html">Introduction to Single-Writer/Multiple-Reader (SWMR)</a>
</td>
</tr>
<tr>
Expand Down
2 changes: 1 addition & 1 deletion doxygen/dox/IntroHDF5.dox
Original file line number Diff line number Diff line change
Expand Up @@ -608,7 +608,7 @@ on the <a href="http://hdfeos.org/">HDF-EOS Tools and Information Center</a> pag
\section secHDF5Examples Examples
\li \ref LBExamples
\li \ref ExAPI
\li <a href="https://github.com/HDFGroup/hdf5/tree/develop/examples">Examples in the Source Code</a>
\li <a href="https://github.com/HDFGroup/hdf5/tree/v1_14/examples">Examples in the Source Code</a>
\li <a href="https://portal.hdfgroup.org/display/HDF5/Other+Examples">Other Examples</a>

\section secHDF5ExamplesCompile How To Compile
Expand Down
8 changes: 4 additions & 4 deletions doxygen/dox/LearnBasics3.dox
Original file line number Diff line number Diff line change
Expand Up @@ -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: <a href="https://github.com/HDFGroup/hdf5/blob/develop/HDF5Examples/C/H5G/h5ex_g_traverse.c">h5ex_g_traverse.c</a>
\li F90: <a href="https://github.com/HDFGroup/hdf5/blob/develop/HDF5Examples/FORTRAN/H5G/h5ex_g_traverse.F90">h5ex_g_traverse_F03.f90</a>
\li C: <a href="https://github.com/HDFGroup/hdf5/blob/v1_14/HDF5Examples/C/H5G/h5ex_g_traverse.c">h5ex_g_traverse.c</a>
\li F90: <a href="https://github.com/HDFGroup/hdf5/blob/v1_14/HDF5Examples/FORTRAN/H5G/h5ex_g_traverse.F90">h5ex_g_traverse_F03.f90</a>

The h5ex_g_visit example traverses a file using H5Ovisit and H5Lvisit:
\li C: <a href="https://github.com/HDFGroup/hdf5/blob/develop/HDF5Examples/C/H5G/h5ex_g_visit.c">h5ex_g_visit.c</a>
\li F90: <a href="https://github.com/HDFGroup/hdf5/blob/develop/HDF5Examples/FORTRAN/H5G/h5ex_g_visit.F90">h5ex_g_visit_F03.f90</a>
\li C: <a href="https://github.com/HDFGroup/hdf5/blob/v1_14/HDF5Examples/C/H5G/h5ex_g_visit.c">h5ex_g_visit.c</a>
\li F90: <a href="https://github.com/HDFGroup/hdf5/blob/v1_14/HDF5Examples/FORTRAN/H5G/h5ex_g_visit.F90">h5ex_g_visit_F03.f90</a>

<hr>
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
Expand Down
2 changes: 1 addition & 1 deletion doxygen/dox/Overview.dox
Original file line number Diff line number Diff line change
Expand Up @@ -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:
- <a href="https://hdfgroup.github.io/hdf5/develop/index.html">HDF5 <code>develop</code> branch</a>
- <a href="https://hdfgroup.github.io/hdf5/v1_14/index.html">HDF5 <code>1.14</code> branch</a>
- <a href="https://hdfgroup.github.io/hdf5/v1_14/index.html">HDF5 1.14.x (this site)</a>
- <a href="https://docs.hdfgroup.org/hdf5/v1_12/index.html">HDF5 1.12.x</a>
- <a href="https://docs.hdfgroup.org/hdf5/v1_10/index.html">HDF5 1.10.x</a>
Expand Down
2 changes: 1 addition & 1 deletion release_docs/USING_HDF5_CMake.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions src/H5Fmodule.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
* <a href="https://docs.hdfgroup.org/hdf5/develop/_view_tools_view.html#subsecViewToolsViewContent_h5dump">
* <a href="https://docs.hdfgroup.org/hdf5/v1_14/_view_tools_view.html#subsecViewToolsViewContent_h5dump">
* Tools</a>
* page under
* <a href="https://docs.hdfgroup.org/hdf5/develop/_view_tools_command.html">Command-line Tools</a>.
* <a href="https://docs.hdfgroup.org/hdf5/v1_14/_view_tools_command.html">Command-line Tools</a>.
* The HDF5 DDL grammar is described in the document \ref DDLBNF114.
*
* \subsection subsec_file_summary File Function Summaries
Expand Down
2 changes: 1 addition & 1 deletion src/H5Ppublic.h
Original file line number Diff line number Diff line change
Expand Up @@ -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 <a href="https://docs.hdfgroup.org/hdf5/develop/group___h5_g.html">Group
* groups. See <a href="https://docs.hdfgroup.org/hdf5/v1_14/group___h5_g.html">Group
* implementations in HDF5</a> 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
Expand Down
2 changes: 1 addition & 1 deletion test/API/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down

0 comments on commit a043b33

Please sign in to comment.