mirror of
https://github.com/HDFGroup/hdf5.git
synced 2025-02-23 16:20:57 +08:00
Correct the high-level link (#4399)
* Correct the high-level link * Add md pattern * Fix anchor refs * Use EXCLUDE_PATTERNS * Correct ref syntax
This commit is contained in:
Allen Byrne
GitHub
parent
c3b568ab23
commit
ec0d341133
@ -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)
|
||||
* <a href="#workflow">Workflow</a>
|
||||
* <a href="#criteria">Acceptance criteria for a pull request</a>
|
||||
* <a href="#releasenote">Release Note</a>
|
||||
* <a href="#checklist">Check List</a>
|
||||
|
||||
# Workflow <A NAME="workflow"></A>
|
||||
<h2 id="workflow">Workflow</h2>
|
||||
|
||||
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 <A NAME="criteria"></A>
|
||||
<h2 id="criteria">Acceptance criteria for a pull request</h2>
|
||||
|
||||
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 <A NAME="releasenote"></A>
|
||||
<h2 id="releasenote">Release Note</h2>
|
||||
|
||||
* **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 <A NAME="checklist"></A>
|
||||
<h2 id="checklist">Checklist</h2>
|
||||
|
||||
Please make sure that you check the items applicable to your pull request:
|
||||
|
||||
|
||||
@ -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
|
||||
|
||||
@ -42,10 +42,10 @@ Parallel HDF5, and the HDF5-1.10 VDS and SWMR new features:
|
||||
<table>
|
||||
<tr>
|
||||
<td style="background-color:#F5F5F5">
|
||||
<a href="https://docs.hdfgroup.org/hdf5/develop/high_level.html">Using the High Level APIs</a>
|
||||
[Using the High Level API](../examples/menus/high_level_menu.md)
|
||||
</td>
|
||||
<td>
|
||||
\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.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
|
||||
@ -1,4 +1,5 @@
|
||||
<b>High-level library</b>
|
||||
## High-level Library
|
||||
|
||||
<br />
|
||||
The high-level HDF5 library includes several sets of convenience and standard-use APIs to
|
||||
facilitate common HDF5 operations.
|
||||
|
||||
@ -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>
|
||||
<!-- Xfig graphic -->
|
||||
<img src="./FortBuildFlow.svg">
|
||||
<figcaption>Figure 1: During the configure and build phases, Fortran files are generated and compiled. This overview explains the flow steps of the build process.</figcaption>
|
||||
</figure>
|
||||
|
||||
|
||||
Procedure to add a new function
|
||||
--------------------------------
|
||||
|
||||
Loading…
Reference in New Issue
Block a user