Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make it easier to find version specific docs. #1260

Merged
merged 157 commits into from
Dec 13, 2021
Merged
Show file tree
Hide file tree
Changes from 152 commits
Commits
Show all changes
157 commits
Select commit Hold shift + click to select a range
e772af3
Sketch of the H5S life cycle.
gheber Apr 27, 2021
7c2805e
Committing clang-format changes
github-actions[bot] Apr 27, 2021
b979754
Merge remote-tracking branch 'upstream/develop' into develop
gheber May 6, 2021
9e28ecb
Merge remote-tracking branch 'upstream/develop' into develop
gheber May 7, 2021
4038b73
Fix H5S_UNLIMITED snafu.
gheber May 7, 2021
e4c6263
Merge branch 'develop' of github.com:gheber/hdf5 into develop
gheber May 7, 2021
7a9e732
Updated RM template and RM page.
gheber May 10, 2021
8fb2ef6
Merge remote-tracking branch 'upstream/develop' into develop
gheber May 12, 2021
c6c8128
Added H5S life cycle.
gheber May 12, 2021
d164f71
Committing clang-format changes
github-actions[bot] May 12, 2021
742bd98
Added H5T life cycle.
gheber May 12, 2021
8346775
Merge branch 'develop' of github.com:gheber/hdf5 into develop
gheber May 12, 2021
d121213
Committing clang-format changes
github-actions[bot] May 12, 2021
9397833
Cleaner layout (?)
gheber May 12, 2021
3b3fe9d
Cleaned the H5F life cycle. Called out unfinished biz.
gheber May 13, 2021
c053665
Committing clang-format changes
github-actions[bot] May 13, 2021
742f5c5
Merge remote-tracking branch 'upstream/develop' into develop
gheber May 13, 2021
74410e4
Remaining life cycle skeletons.
gheber May 15, 2021
e6b29bf
Committing clang-format changes
github-actions[bot] May 15, 2021
faa3256
Merge remote-tracking branch 'upstream/develop' into develop
gheber May 17, 2021
aea13c2
Committing clang-format changes
github-actions[bot] May 17, 2021
18737ab
Added H5Z life cycle.
gheber May 17, 2021
8089029
Merge branch 'develop' of github.com:gheber/hdf5 into develop
gheber May 17, 2021
8ad77ae
Committing clang-format changes
github-actions[bot] May 17, 2021
60c16ee
Added H5G life cycle.
gheber May 17, 2021
16b738b
Committing clang-format changes
github-actions[bot] May 17, 2021
a62f964
H5 and H5I life cycle updates.
gheber May 17, 2021
83f9f1c
Committing clang-format changes
github-actions[bot] May 17, 2021
6c415fb
Added H5PL life cycle.
gheber May 17, 2021
d261aca
Committing clang-format changes
github-actions[bot] May 17, 2021
5e1ec5e
Added H5L life cycle.
gheber May 18, 2021
ccc98f6
Committing clang-format changes
github-actions[bot] May 18, 2021
f2fdae6
Merge remote-tracking branch 'upstream/develop' into develop
gheber May 18, 2021
c82c655
Merge remote-tracking branch 'upstream/develop' into develop
gheber May 19, 2021
22ac512
Fix for Chris' comment.
gheber May 19, 2021
29703f3
Add a variable for Doxygen pre-processor definitions.
gheber May 19, 2021
bc8b9cf
Forgot to add the H5M API.
gheber May 19, 2021
b3b565d
Merge remote-tracking branch 'upstream/develop' into develop
gheber May 21, 2021
0d59127
Clarify the H5Z life cycle.
gheber May 21, 2021
2611ae0
Committing clang-format changes
github-actions[bot] May 21, 2021
d2dc346
Merge remote-tracking branch 'upstream/develop' into develop
gheber May 28, 2021
287f5a3
Merge remote-tracking branch 'upstream/develop' into develop
gheber Jun 9, 2021
08bbda4
Add H5Zdevelop.h to Doxygen.in. Added H5I life cycle.
gheber Jun 9, 2021
1a22916
Committing clang-format changes
github-actions[bot] Jun 9, 2021
d3026f7
Clarified introduction and fixed missing label declaration.
gheber Jun 10, 2021
1baf642
Added H5O life cycle.
gheber Jun 10, 2021
fd1e613
Committing clang-format changes
github-actions[bot] Jun 10, 2021
483f71b
Merge remote-tracking branch 'upstream/develop' into develop
gheber Jun 11, 2021
978bae8
H5O cleanup, part 1.
gheber Jun 11, 2021
f342947
Committing clang-format changes
github-actions[bot] Jun 11, 2021
c77f2f4
Cleaned up some of the endless repetition in H5O.
gheber Jun 11, 2021
7b24a22
Committing clang-format changes
github-actions[bot] Jun 11, 2021
bde4932
Merge remote-tracking branch 'upstream/develop' into develop
gheber Jun 11, 2021
532d125
Merge remote-tracking branch 'upstream/develop' into develop
gheber Jun 23, 2021
7f56682
Merge remote-tracking branch 'upstream/develop' into develop
gheber Jul 1, 2021
707975d
Merge remote-tracking branch 'upstream/develop' into develop
gheber Jul 8, 2021
d1cdbd5
Merge remote-tracking branch 'upstream/develop' into develop
gheber Jul 13, 2021
9ac4d31
Cookbook & RFC draft layouts.
gheber Jul 13, 2021
22dead6
Updated manifest.
gheber Jul 13, 2021
e27070a
Updated the manifest, the example paths, and sketched the 1st recipe.
gheber Jul 13, 2021
a352083
Committing clang-format changes
github-actions[bot] Jul 13, 2021
a00de26
Merge remote-tracking branch 'upstream/develop' into develop
gheber Jul 15, 2021
b3a9ef0
Outlined two more recipes.
gheber Jul 15, 2021
216e48a
Committing clang-format changes
github-actions[bot] Jul 15, 2021
60ac8ba
More recipes and RFCs.
gheber Jul 17, 2021
92b7448
Committing clang-format changes
github-actions[bot] Jul 17, 2021
5e79a23
Draft of templatized RFC references.
gheber Jul 19, 2021
4821a38
Another batch of RFC changes.
gheber Jul 19, 2021
293ab74
Another batch of RFCs.
gheber Jul 19, 2021
9396696
Fixed reference.
gheber Jul 19, 2021
5325d43
RFCs in reverse chronological order.
gheber Jul 19, 2021
3ebecf6
First cut of RFCs.
gheber Jul 20, 2021
ff0a35b
Fixed reference.
gheber Jul 20, 2021
5e7b556
Merge remote-tracking branch 'upstream/develop' into develop
gheber Jul 20, 2021
5a0579b
Updated recipes.
gheber Jul 20, 2021
3fc3eaf
Updated recipes.
gheber Jul 20, 2021
11331ef
More RFCs.
gheber Jul 21, 2021
daf83fe
Merge remote-tracking branch 'upstream/develop' into develop
gheber Jul 21, 2021
649fdfe
Merge remote-tracking branch 'upstream/develop' into develop
gheber Jul 23, 2021
2e8173d
Updated D*PL comments.
gheber Jul 26, 2021
ca86f16
Added H5P descriptions.
gheber Jul 26, 2021
329e837
Committing clang-format changes
github-actions[bot] Jul 26, 2021
df72e87
Merge remote-tracking branch 'upstream/develop' into develop
gheber Jul 27, 2021
72f79b3
H5R life-cycle snapshot.
gheber Jul 27, 2021
702f1fa
Committing clang-format changes
github-actions[bot] Jul 27, 2021
85297a7
H5R life-cycle. Added line numbers to life-cycle examples.
gheber Jul 27, 2021
b3da376
Merge branch 'develop' of github.com:gheber/hdf5 into develop
gheber Jul 27, 2021
8675417
Committing clang-format changes
github-actions[bot] Jul 27, 2021
4afa90e
Merge remote-tracking branch 'upstream/develop' into develop
gheber Jul 27, 2021
3434394
Merge remote-tracking branch 'upstream/develop' into develop
gheber Jul 30, 2021
b2dfcc2
Fixed formatting for H5Dchunk_iter().
gheber Jul 30, 2021
a4d3bb6
Merge remote-tracking branch 'upstream/develop' into develop
gheber Aug 2, 2021
c9ce4da
Added comment on collective mode requirement w/ compression.
gheber Aug 3, 2021
007347d
Simplified API compat. macro dox.
gheber Aug 3, 2021
6070b27
More API vers. updates.
gheber Aug 3, 2021
c3f4b1b
Hide the async macro entrails.
gheber Aug 4, 2021
69959bf
Merge remote-tracking branch 'upstream/develop' into develop
gheber Aug 6, 2021
380d9da
Latest VFD SWMR RFC.
gheber Aug 6, 2021
b0b7d17
Create a tag file for permalinks.
gheber Aug 7, 2021
1de8a38
Added TODOs for metadoc.
gheber Aug 7, 2021
f90c39f
Merge remote-tracking branch 'upstream/develop' into develop
gheber Aug 10, 2021
39eeb73
Removed duplication.
gheber Aug 10, 2021
a5388d1
Merge remote-tracking branch 'upstream/develop' into develop
gheber Aug 11, 2021
39f69e4
Revised RM landing page.
gheber Aug 11, 2021
b49cd64
Trimmed more duplication.
gheber Aug 11, 2021
0006d69
Merge remote-tracking branch 'upstream/develop' into develop
gheber Aug 12, 2021
5d9f038
Committing clang-format changes
github-actions[bot] Aug 12, 2021
9f2d8ea
Revised H5D.
gheber Aug 12, 2021
74dbbcc
Merge branch 'develop' of github.com:gheber/hdf5 into develop
gheber Aug 12, 2021
8caf405
Committing clang-format changes
github-actions[bot] Aug 12, 2021
a10e2ea
Merge remote-tracking branch 'upstream/develop' into develop
gheber Aug 16, 2021
0f9fe7f
Updated survey link.
gheber Aug 17, 2021
0f6d98b
Merge remote-tracking branch 'upstream/develop' into develop
gheber Aug 19, 2021
b3ff9b5
Added Doxygen RM entry template link.
gheber Aug 19, 2021
396dee3
Merge remote-tracking branch 'upstream/develop' into develop
gheber Aug 27, 2021
4d3fea8
Added the "Multi-Thread HDF5" RFC.
gheber Aug 27, 2021
87a5f98
Merge remote-tracking branch 'upstream/develop' into develop
gheber Aug 31, 2021
0ad6ec1
Added DOXYGEN_TAG_FILE.
gheber Aug 31, 2021
1ff64d7
Fixed merge conflicts.
gheber Oct 4, 2021
6464427
Merge remote-tracking branch 'upstream/develop' into develop
gheber Oct 4, 2021
d3fb905
Added selection I/O RFC.
gheber Oct 4, 2021
3392720
Sync w/ upstream.
gheber Oct 7, 2021
2b22250
Added the VFD Sub-filing RFC.
gheber Oct 7, 2021
979ef54
Merge remote-tracking branch 'upstream/develop' into develop
gheber Oct 16, 2021
c6797e2
Updated meta-documentation and added two old presentations.
gheber Oct 18, 2021
f639215
Added a few more RFCs (4).
gheber Oct 18, 2021
8b5aa30
Fixed MANIFEST.
gheber Oct 18, 2021
fff48bc
Updated meta-documentation.
gheber Oct 19, 2021
957ee48
Merge remote-tracking branch 'upstream/develop' into develop
gheber Oct 21, 2021
16ca881
Merge remote-tracking branch 'upstream/develop' into develop
gheber Oct 29, 2021
d33c2b2
Merged upstream/develop.
gheber Nov 9, 2021
7eb1514
Added Filters technical note.
gheber Nov 9, 2021
3de20e3
Merge remote-tracking branch 'upstream/develop' into develop
gheber Nov 10, 2021
7f3cbcf
Merge remote-tracking branch 'upstream/develop' into develop
gheber Nov 10, 2021
e00363b
Fixed MANIFEST.
gheber Nov 10, 2021
9d52934
Merge remote-tracking branch 'upstream/develop' into develop
gheber Nov 18, 2021
1e4709d
Restore the path stripper.
gheber Nov 18, 2021
8226a25
Experimental full-text search via Google.
gheber Nov 18, 2021
a2766cf
Better full-text search integration.
gheber Nov 19, 2021
c752c14
Merge remote-tracking branch 'upstream/develop' into develop
gheber Nov 19, 2021
4c65c7a
Whoops. Forgot this one.
gheber Nov 19, 2021
0284e5d
Oh boy.
gheber Nov 19, 2021
61156cf
Make CMake happy.
gheber Nov 19, 2021
2133c56
Added "Debugging HDF5 Applications" technical note.
gheber Nov 19, 2021
ec90098
Merging upstream/develop.
gheber Nov 23, 2021
314e65b
Another batch of RFCs.
gheber Nov 23, 2021
aa311f3
Merge remote-tracking branch 'upstream/develop' into develop
gheber Nov 23, 2021
57f2cd1
Fixes for #1221.
gheber Nov 24, 2021
35022d4
Merge remote-tracking branch 'upstream/develop' into develop
gheber Nov 24, 2021
6aecfa6
Merge remote-tracking branch 'upstream/develop' into develop
gheber Dec 2, 2021
78f3d4d
Updated overview.
gheber Dec 2, 2021
728bf1c
Fixed image dependencies.
gheber Dec 2, 2021
479c427
CMake updates.
gheber Dec 3, 2021
eb457f9
Fixed SET.
gheber Dec 3, 2021
fa580e0
Better?
gheber Dec 3, 2021
17110d3
Merging upstream/develop.
gheber Dec 11, 2021
8fb640a
Update doxygen/dox/Overview.dox
lrknox Dec 13, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions configure.ac
Original file line number Diff line number Diff line change
Expand Up @@ -1214,7 +1214,7 @@ if test "X$HDF5_DOXYGEN" = "Xyes"; then
DOXYGEN_HTML_HEADER='$(SRCDIR)/doxygen/hdf5_header.html'
DOXYGEN_HTML_FOOTER='$(SRCDIR)/doxygen/hdf5_footer.html'
DOXYGEN_HTML_EXTRA_STYLESHEET='$(SRCDIR)/doxygen/hdf5doxy.css'
DOXYGEN_HTML_EXTRA_FILES='$(SRCDIR)/doxygen/hdf5_navtree_hacks.js $(SRCDIR)/doxygen/img/ftv2node.png $(SRCDIR)/doxygen/img/ftv2pnode.png'
DOXYGEN_HTML_EXTRA_FILES='$(SRCDIR)/doxygen/hdf5_navtree_hacks.js $(SRCDIR)/doxygen/img/FF-IH_FileGroup.gif $(SRCDIR)/doxygen/img/FF-IH_FileObject.gif $(SRCDIR)/doxygen/img/FileFormatSpecChunkDiagram.jpg $(SRCDIR)/doxygen/img/ftv2node.png $(SRCDIR)/doxygen/img/ftv2pnode.png $(SRCDIR)/doxygen/img/HDFG-logo.png $(SRCDIR)/doxygen/img/IOFlow2.gif $(SRCDIR)/doxygen/img/IOFlow3.gif $(SRCDIR)/doxygen/img/IOFlow.gif $(SRCDIR)/doxygen/img/PaletteExample1.gif $(SRCDIR)/doxygen/img/Palettes.fm.anc.gif'
byrnHDF marked this conversation as resolved.
Show resolved Hide resolved
DOXYGEN_TAG_FILE=hdf5.tag
DOXYGEN_SERVER_BASED_SEARCH=NO
DOXYGEN_EXTERNAL_SEARCH=NO
Expand Down Expand Up @@ -1686,7 +1686,7 @@ fi
## command-line switch. The value is an include path and/or a library path.
## If the library path is specified then it must be preceded by a comma.
##
AC_SUBST([LL_PATH])
AC_SUBST([LL_PATH])
AC_SUBST([USE_FILTER_SZIP]) USE_FILTER_SZIP="no"
AC_ARG_WITH([szlib],
[AS_HELP_STRING([--with-szlib=DIR],
Expand Down Expand Up @@ -3037,7 +3037,7 @@ if test -n "$PARALLEL"; then
fi

## ----------------------------------------------------------------------
## Build parallel tools if parallel tools, parallel, and build tools options
## Build parallel tools if parallel tools, parallel, and build tools options
## are all enabled.
##
AC_SUBST([PARALLEL_TOOLS])
Expand All @@ -3057,7 +3057,7 @@ if test "X${PARALLEL_TOOLS}" = "Xyes"; then
AC_MSG_ERROR([--enable-tools is required for --enable-parallel-tools])
fi
if test "X${PARALLEL}" != "Xyes"; then
AC_MSG_ERROR([--enable-parallel is required for --enable-parallel-tools])
AC_MSG_ERROR([--enable-parallel is required for --enable-parallel-tools])
fi
fi

Expand Down
37 changes: 25 additions & 12 deletions doxygen/dox/Overview.dox
Original file line number Diff line number Diff line change
@@ -1,14 +1,11 @@

/** \mainpage notitle

This is the documentation set for HDF5. You can
<a href="hdf5-doc.tgz">download</a> it as a tgz archive for offline reading.

This is the documention set for HDF5 in terms of specifications and software
developed and maintained by <a href="https://www.hdfgroup.org/">The HDF
Group</a>. It is impractical to document the entire HDF5 ecosystem in one place,
and you should also consult the documentation sets of the many outstanding
community projects.
This is the documention set for HDF5 and includes specifications and documentation
of software and tools developed and maintained by
<a href="https://www.hdfgroup.org/">The HDF Group</a>. It is impractical to document
the entire HDF5 ecosystem in one place, and you should also consult the documentation
sets of the many outstanding community projects.

For a first contact with HDF5, the best place is to have a look at the \link
GettingStarted getting started \endlink page that shows you how to write and
Expand All @@ -19,12 +16,28 @@ technical documentation consists to varying degrees of information related to
<em>tasks</em>, <em>concepts</em>, or <em>reference</em> material. As its title
suggests, the \link RM Reference Manual \endlink is 100% reference material,
while the \link Cookbook \endlink is focused on tasks. The different guide-type
documents cover a mix of tasks, concepts, and reference, to help a certain
documents cover a mix of tasks, concepts, and reference, to help a specific
<em>audience</em> succeed.

Finally, do not miss the search engine (top right-hand corner)! If you are
looking for a specific function, it'll take you there directly. If unsure, it'll
give you an idea of what's on offer and a few promising leads.
\par Versions
Version-specific documentation (see the version in the title area) can be found
here:
- HDF5 <code>develop</code> branch (this site)
- <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>

\par Search
If you are looking for a specific function, constant, type, etc., use the
search box in the top right-hand corner!\n Otherwise, check out the
\link FTS full-text search\endlink.

\par Offline reading
You can <a href="hdf5-doc.tgz">download</a> it as a tgz archive for offline reading.

\par History
A snapshot (April 2017) of the pre-Doxygen HDF5 documentation can be found
<a href="https://hdfgroup.github.io/archive/hdf5doc/">here</a>.

\par ToDo List
There is plenty of <a href="./todo.html">unfinished business</a>.
Expand Down