mirror/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2024-11-27 02:10:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update and use more URL alias (#4413)

Browse Source
This commit is contained in:
Allen Byrne 2024-04-17 07:56:19 -05:00 committed by GitHub
parent f155eef5bc
commit c548657043
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
12 changed files with 28 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doxygen/aliases
View File

@ -3,10 +3,12 @@ ALIASES += THG="The HDF Group"
################################################################################
# Default URLs (Note that md files do not use any aliases)
################################################################################
ALIASES += ARCURL="docs.hdfgroup.org/hdf5"
ALIASES += HDFURL="docs.hdfgroup.org/hdf5"
ALIASES += ARCURL="docs.hdfgroup.org/archive/support/HDF5/doc"
ALIASES += RFCURL="docs.hdfgroup.org/hdf5/rfc"
ALIASES += DSPURL="portal.hdfgroup.org/display/HDF5"
ALIASES += DOCURL="portal.hdfgroup.org/documentation/hdf5-docs"
ALIASES += DWNURL="portal.hdfgroup.org/downloads"
ALIASES += AEXURL="support.hdfgroup.org/ftp/HDF5/examples"
# doxygen subdir (develop, v1_14)
ALIASES += DOXURL="hdfgroup.github.io/hdf5/develop"
@ -251,7 +253,7 @@ ALIASES += ref_cons_semantics="<a href=\"https://\RFCURL/RFC%20PHDF5%20Consisten
ALIASES += ref_file_image_ops="<a href=\"https://\RFCURL/HDF5FileImageOperations.pdf\">HDF5 File Image Operations</a>"
ALIASES += ref_filter_pipe="<a href=\"https://\DSPURL/HDF5+Data+Flow+Pipeline+for+H5Dread\">Data Flow Pipeline for H5Dread()</a>"
ALIASES += ref_group_impls="<a href=\"\DOXURL/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_h5lib_relver="<a href=\"https://\ARCURL/TechNotes/Version.html\">HDF5 Library Release Version Numbers</a>"
ALIASES += ref_mdc_in_hdf5="<a href=\"https://\DSPURL/Metadata+Caching+in+HDF5\">Metadata Caching in HDF5</a>"
ALIASES += ref_mdc_logging="<a href=\"https://\DSPURL/H5F_START_MDC_LOGGING\">Metadata Cache Logging</a>"
ALIASES += ref_news_112="<a href=\"https://\DOCURL/release_specifics/new_features_1_12.html\">New Features in HDF5 Release 1.12</a>"

2
doxygen/dox/LearnBasics3.dox
View File

@ -167,7 +167,7 @@ to a new with a new layout.
\section secLBDsetLayoutSource Sources of Information
<a href="https://\DOCURL/chunking_in_hdf5.html">Chunking in HDF5</a>
(See the documentation on <a href="https://confluence.hdfgroup.org/display/HDF5/Advanced+Topics+in+HDF5">Advanced Topics in HDF5</a>)
(See the documentation on <a href="https://\DOCURL/advanced_topics_list.html">Advanced Topics in HDF5</a>)
\see \ref sec_plist in the HDF5 \ref UG.
<hr>

2
doxygen/dox/LearnHDFView.dox
View File

@ -7,7 +7,7 @@ This tutorial enables you to get a feel for HDF5 by using the HDFView browser. I
any programming experience.
\section sec_learn_hv_install HDFView Installation
\li Download and install HDFView. It can be downloaded from the <a href="https://portal.hdfgroup.org/downloads/hdfview/hdfview3_3_1.html">Download HDFView</a> page.
\li Download and install HDFView. It can be downloaded from the <a href="https://\DWNURL/hdfview/hdfview3_3_1.html">Download HDFView</a> page.
\li Obtain the <a href="https://\AEXURL/files/tutorial/storm1.txt">storm1.txt</a> text file, used in the tutorial.
\section sec_learn_hv_begin Begin Tutorial

6
doxygen/dox/Overview.dox
View File

@ -25,9 +25,9 @@ documents cover a mix of tasks, concepts, and reference, to help a specific
here:
- <a href="https://\DOXURL/index.html">HDF5 <code>develop</code> branch (this site)</a>
- <a href="https://hdfgroup.github.io/hdf5/v1_14/index.html">HDF5 1.14.x</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>
- <a href="https://docs.hdfgroup.org/hdf5/v1_8/index.html">HDF5 1.8.x</a>
- <a href="https://\HDFURL/v1_12/index.html">HDF5 1.12.x</a>
- <a href="https://\HDFURL/v1_10/index.html">HDF5 1.10.x</a>
- <a href="https://\HDFURL/v1_8/index.html">HDF5 1.8.x</a>
\par Search
If you are looking for a specific function, constant, type, etc., use the

18
doxygen/dox/UsersGuide.dox
View File

@ -342,7 +342,7 @@ These documents provide additional information for the use and tuning of specifi
</tr>
<tr style="height: 36.00pt;">
<td style="width: 234.000pt; border-bottom-style: solid; border-bottom-width: 1px; border-bottom-color: #228a22; vertical-align: top;padding-left: 6.00pt; padding-top: 3.00pt; padding-right: 6.00pt; padding-bottom: 3.00pt;">
<p style="font-style: italic; color: #0000ff;"><span><a href="http://www.hdfgroup.org/HDF5/doc/Advanced/Chunking/index.html">Chunking in HDF5</a></span></p>
<p style="font-style: italic; color: #0000ff;"><span><a href="http://\ARCURL/Advanced/Chunking/index.html">Chunking in HDF5</a></span></p>
</td>
<td style="width: 198.000pt; border-bottom-style: solid; border-bottom-width: 1px; border-bottom-color: #228a22; vertical-align: top;padding-left: 6.00pt; padding-top: 3.00pt; padding-right: 6.00pt; padding-bottom: 3.00pt;">
<p>Structuring the use of chunking and tuning it for performance.</p>
@ -350,7 +350,7 @@ These documents provide additional information for the use and tuning of specifi
</tr>
<tr style="height: 36.00pt;">
<td style="width: 234.000pt; border-bottom-style: solid; border-bottom-width: 1px; border-bottom-color: #228a22; vertical-align: top;padding-left: 6.00pt; padding-top: 3.00pt; padding-right: 6.00pt; padding-bottom: 3.00pt;">
<p style="font-style: italic; color: #0000ff;"><span class="FM_LT_LinkText"><a href="http://www.hdfgroup.org/HDF5/doc/Advanced/DirectChunkWrite/UsingDirectChunkWrite.pdf">Using the Direct Chunk Write Function</a></span></p>
<p style="font-style: italic; color: #0000ff;"><span class="FM_LT_LinkText"><a href="http://\ARCURL/Advanced/DirectChunkWrite/UsingDirectChunkWrite.pdf">Using the Direct Chunk Write Function</a></span></p>
</td>
<td style="width: 198.000pt; border-bottom-style: solid; border-bottom-width: 1px; border-bottom-color: #228a22; vertical-align: top;padding-left: 6.00pt; padding-top: 3.00pt; padding-right: 6.00pt; padding-bottom: 3.00pt;">
<p>Describes another way that chunks can be written to datasets.</p>
@ -358,7 +358,7 @@ These documents provide additional information for the use and tuning of specifi
</tr>
<tr style="height: 88.00pt;">
<td style="width: 234.000pt; border-bottom-style: solid; border-bottom-width: 1px; border-bottom-color: #228a22; vertical-align: top;padding-left: 6.00pt; padding-top: 3.00pt; padding-right: 6.00pt; padding-bottom: 3.00pt;">
<p style="font-style: italic; color: #0000ff;"><span><a href="http://www.hdfgroup.org/HDF5/doc/Advanced/CommittedDatatypeCopying/CopyingCommittedDatatypesWithH5Ocopy.pdf">Copying Committed Datatypes with H5Ocopy</a></span></p>
<p style="font-style: italic; color: #0000ff;"><span><a href="http://\ARCURL/Advanced/CommittedDatatypeCopying/CopyingCommittedDatatypesWithH5Ocopy.pdf">Copying Committed Datatypes with H5Ocopy</a></span></p>
</td>
<td style="width: 198.000pt; border-bottom-style: solid; border-bottom-width: 1px; border-bottom-color: #228a22; vertical-align: top;padding-left: 6.00pt; padding-top: 3.00pt; padding-right: 6.00pt; padding-bottom: 3.00pt;">
<p>Describes how to copy to another file a dataset that uses a committed datatype or an object with an attribute that uses a committed datatype so that the committed datatype in the destination file can be used by multiple objects.</p>
@ -366,7 +366,7 @@ These documents provide additional information for the use and tuning of specifi
</tr>
<tr style="height: 36.00pt;">
<td style="width: 234.000pt; border-bottom-style: solid; border-bottom-width: 1px; border-bottom-color: #228a22; vertical-align: top;padding-left: 6.00pt; padding-top: 3.00pt; padding-right: 6.00pt; padding-bottom: 3.00pt;">
<p style="font-style: italic; color: #0000ff;"><span><a href="http://www.hdfgroup.org/HDF5/doc/Advanced/MetadataCache/index.html">Metadata Caching in HDF5</a></span></p>
<p style="font-style: italic; color: #0000ff;"><span><a href="http://\ARCURL/Advanced/MetadataCache/index.html">Metadata Caching in HDF5</a></span></p>
</td>
<td style="width: 198.000pt; border-bottom-style: solid; border-bottom-width: 1px; border-bottom-color: #228a22; vertical-align: top;padding-left: 6.00pt; padding-top: 3.00pt; padding-right: 6.00pt; padding-bottom: 3.00pt;">
<p>Managing the HDF5 metadata cache and tuning it for performance.</p>
@ -390,7 +390,7 @@ These documents provide additional information for the use and tuning of specifi
</tr>
<tr style="height: 62.00pt;">
<td style="width: 234.000pt; border-bottom-style: solid; border-bottom-width: 1px; border-bottom-color: #228a22; vertical-align: top;padding-left: 6.00pt; padding-top: 3.00pt; padding-right: 6.00pt; padding-bottom: 3.00pt;">
<p style="font-style: italic; color: #0000ff;"><span><a href="https://docs.hdfgroup.org/archive/support/HDF5/doc/Advanced/ModifiedRegionWrites/ModifiedRegionWrites.pdf">Modified Region Writes</a></span></p>
<p style="font-style: italic; color: #0000ff;"><span><a href="https://\ARCURL/Advanced/ModifiedRegionWrites/ModifiedRegionWrites.pdf">Modified Region Writes</a></span></p>
</td>
<td style="width: 198.000pt; border-bottom-style: solid; border-bottom-width: 1px; border-bottom-color: #228a22; vertical-align: top;padding-left: 6.00pt; padding-top: 3.00pt; padding-right: 6.00pt; padding-bottom: 3.00pt;">
<p>Describes how to set write operations for in-memory files so that only modified regions are written to storage. Available when the Core (Memory) VFD is used.</p>
@ -398,7 +398,7 @@ These documents provide additional information for the use and tuning of specifi
</tr>
<tr style="height: 36.00pt;">
<td style="width: 234.000pt; border-bottom-style: solid; border-bottom-width: 1px; border-bottom-color: #228a22; vertical-align: top;padding-left: 6.00pt; padding-top: 3.00pt; padding-right: 6.00pt; padding-bottom: 3.00pt;">
<p style="font-style: italic; color: #0000ff;"><span><a href="http://www.hdfgroup.org/HDF5/doc/Advanced/UsingIdentifiers/index.html">Using Identifiers</a></span></p>
<p style="font-style: italic; color: #0000ff;"><span><a href="http://\ARCURL/Advanced/UsingIdentifiers/index.html">Using Identifiers</a></span></p>
</td>
<td style="width: 198.000pt; border-bottom-style: solid; border-bottom-width: 1px; border-bottom-color: #228a22; vertical-align: top;padding-left: 6.00pt; padding-top: 3.00pt; padding-right: 6.00pt; padding-bottom: 3.00pt;">
<p>Describes how identifiers behave and how they should be treated.</p>
@ -406,7 +406,7 @@ These documents provide additional information for the use and tuning of specifi
</tr>
<tr style="height: 36.00pt;">
<td style="width: 234.000pt; border-bottom-style: solid; border-bottom-width: 1px; border-bottom-color: #228a22; vertical-align: top;padding-left: 6.00pt; padding-top: 3.00pt; padding-right: 6.00pt; padding-bottom: 3.00pt;">
<p style="font-style: italic; color: #0000ff;"><span><a href="http://www.hdfgroup.org/HDF5/doc/Advanced/UsingUnicode/index.html">Using UTF-8 Encoding in HDF5 Applications</a></span></p>
<p style="font-style: italic; color: #0000ff;"><span><a href="http://\ARCURL/Advanced/UsingUnicode/index.html">Using UTF-8 Encoding in HDF5 Applications</a></span></p>
</td>
<td style="width: 198.000pt; border-bottom-style: solid; border-bottom-width: 1px; border-bottom-color: #228a22; vertical-align: top;padding-left: 6.00pt; padding-top: 3.00pt; padding-right: 6.00pt; padding-bottom: 3.00pt;">
<p>Describes the use of UTF-8 Unicode character encodings in HDF5 applications.</p>
@ -414,7 +414,7 @@ These documents provide additional information for the use and tuning of specifi
</tr>
<tr style="height: 49.00pt;">
<td style="width: 234.000pt; border-bottom-style: solid; border-bottom-width: 1px; border-bottom-color: #228a22; vertical-align: top;padding-left: 6.00pt; padding-top: 3.00pt; padding-right: 6.00pt; padding-bottom: 3.00pt;">
<p style="font-style: italic; color: #0000ff;"><span><a href="http://www.hdfgroup.org/HDF5/doc/Advanced/FreeingMemory/FreeingMemoryAllocatedByTheHdf5Library.pdf">Freeing Memory Allocated by the HDF5 Library</a></span></p>
<p style="font-style: italic; color: #0000ff;"><span><a href="http://\ARCURL/Advanced/FreeingMemory/FreeingMemoryAllocatedByTheHdf5Library.pdf">Freeing Memory Allocated by the HDF5 Library</a></span></p>
</td>
<td style="width: 198.000pt; border-bottom-style: solid; border-bottom-width: 1px; border-bottom-color: #228a22; vertical-align: top;padding-left: 6.00pt; padding-top: 3.00pt; padding-right: 6.00pt; padding-bottom: 3.00pt;">
<p>Describes how inconsistent memory management can cause heap corruption or resource leaks and possible solutions.</p>
@ -422,7 +422,7 @@ These documents provide additional information for the use and tuning of specifi
</tr>
<tr style="height: 23.00pt;">
<td style="width: 234.000pt; border-bottom-style: solid; border-bottom-width: 1px; border-bottom-color: #228a22; vertical-align: top;padding-left: 6.00pt; padding-top: 3.00pt; padding-right: 6.00pt; padding-bottom: 3.00pt;">
<p style="font-style: italic; color: #0000ff;"><span><a href="http://www.hdfgroup.org/HDF5/doc/Glossary.html">HDF5 Glossary</a></span></p>
<p style="font-style: italic; color: #0000ff;"><span>@ref GLS</span></p>
</td>
<td style="width: 198.000pt; border-bottom-style: solid; border-bottom-width: 1px; border-bottom-color: #228a22; vertical-align: top;padding-left: 6.00pt; padding-top: 3.00pt; padding-right: 6.00pt; padding-bottom: 3.00pt;">
<p>A glossary of terms.</p>

2
doxygen/dox/ViewTools.dox
View File

@ -48,7 +48,7 @@ Navigate back: \ref index "Main" / \ref GettingStarted
\section secViewToolsCommandObtain Obtain Tools and Files (Optional)
Pre-built binaries for Linux and Windows are distributed within the respective HDF5 binary release
packages, which can be obtained from the <a href="https://portal.hdfgroup.org/downloads/index.html">Download HDF5</a> page.
packages, which can be obtained from the <a href="https://\DWNURL/index.html">Download HDF5</a> page.
HDF5 files can be obtained from various places such as \ref HDF5Examples and <a href="http://www.hdfeos.org/">HDF-EOS and Tools and
Information Center</a>. Specifically, the following examples are used in this tutorial topic:

2
java/src/hdf/overview.html
View File

@ -91,6 +91,6 @@ The <i><b>H5</b> </i>class automatically loads the native method implementations
and the HDF5 library.
<h3>To Obtain</h3>
The JHI5 is included with the <a href="https://portal.hdfgroup.org/display/support/Downloads">HDF5</a> library.
The JHI5 is included with the <a href="https://portal.hdfgroup.org/downloads/index.html">HDF5</a> library.
</body>

2
release_docs/INSTALL
View File

@ -10,7 +10,7 @@ This file provides instructions for installing the HDF5 software.
For help with installing, questions can be posted to the HDF Forum or sent to the HDF Helpdesk:
HDF Forum: https://forum.hdfgroup.org/
HDF Helpdesk: https://hdfgroup.atlassian.net/servicedesk/customer/portals
HDF Helpdesk: https://help.hdfgroup.org/
CONTENTS
--------

6
release_docs/INSTALL_Auto.txt
View File

@ -15,7 +15,7 @@ Section V: Windows Configuration and Build
For help with installing, questions can be posted to the HDF Forum or sent to the HDF Helpdesk:
HDF Forum: https://forum.hdfgroup.org/
HDF Helpdesk: https://hdfgroup.atlassian.net/servicedesk/customer/portals
HDF Helpdesk: https://help.hdfgroup.org/
========================================================================
@ -361,7 +361,7 @@ III. Full installation instructions for source distributions
source code. For additional configuration options and other details,
see "API Compatibility Macros":
hdfgroup.github.io/hdf5/develop/api-compat-macros.html
https://hdfgroup.github.io/hdf5/develop/api-compat-macros.html
4. Building
The library, confidence tests, and programs can be built by
@ -492,7 +492,7 @@ IV. Using the Library
For information on using HDF5 see the documentation, tutorials and examples
found here:
https://portal.hdfgroup.org/display/HDF5/HDF5
https://portal.hdfgroup.org/documentation/index.html
A summary of the features included in the built HDF5 installation can be found
in the libhdf5.settings file in the same directory as the static and/or

2
release_docs/INSTALL_parallel
View File

@ -44,7 +44,7 @@ and the parallel file system.
For help with installing, questions can be posted to the HDF Forum or sent to the HDF Helpdesk:
HDF Forum: https://forum.hdfgroup.org/
HDF Helpdesk: https://portal.hdfgroup.org/display/support/The+HDF+Help+Desk
HDF Helpdesk: https://help.hdfgroup.org/
In your mail, please include the output of "uname -a". If you have run the
"configure" command, attach the output of the command and the content of

2
src/H5module.h
View File

@ -778,7 +778,7 @@
* item must be closed separately.
*
* For more information,
* @see <a href="http://www.hdfgroup.org/HDF5/doc/Advanced/UsingIdentifiers/index.html">Using Identifiers</a>
* @see <a href="http://\ARCURL/Advanced/UsingIdentifiers/index.html">Using Identifiers</a>
* in the HDF5 Application Developer's Guide under General Topics in HDF5.
*
* <h4>How Closing a File Effects Other Open Structural Elements</h4>

4
test/API/README.md
View File

@ -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://hdfgroup.github.io/hdf5/develop/_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/develop/_v_o_l__connector.html).
connector in this manner, refer to section 2.3 of the [HDF5 VOL Connector Author Guide](https://hdfgroup.github.io/hdf5/develop/_v_o_l__connector.html).
TODO: section on building VOL connectors alongside HDF5 for use with tests