mirror of
https://github.com/HDFGroup/hdf5.git
synced 2026-09-25 04:09:44 +03:00
Scot Breitenfeld
05676d1abe
* Consolidate documentation under doc/ directory
Move user-facing guides from release_docs/ and doxygen/ into a single
doc/ root. release_docs/ now holds only release artifacts (changelogs,
history, release process, maintainer info).
- git mv release_docs/INSTALL*.md, USING_*.md, README_HPC.md,
BuildSystemNotes.md, AutotoolsToCMakeOptions.md,
HDF5_Library_2.0.0_Migration_Guide.md → doc/
- git mv doxygen/ → doc/doxygen/
- Update CMakeLists.txt: HDF5_DOXYGEN_DIR and add_subdirectory path
- Update CMakeInstallation.cmake: all install paths for moved files
- Update bin/make_vers: hardcoded doxygen/ path substitution
- Update doc/doxygen/CMakeLists.txt: EXAMPLES_DIRECTORY and comments
- Update README.md, CONTRIBUTING.md, SECURITY.md, config/README.md,
release_docs/RELEASE_PROCESS.md: links to moved files
- Update doxygen .dox files: release_docs/ URLs for moved guides
- Rewrite release_docs/README.md for narrowed scope
* Add HDF5_DOCS_DIR variable for doc/ root path
Introduce HDF5_DOCS_DIR = \${HDF5_SOURCE_DIR}/doc so that
CMakeInstallation.cmake and future callers reference the doc/
directory symbolically rather than by hardcoded path.
HDF5_DOXYGEN_DIR is now derived from HDF5_DOCS_DIR.
45 lines
1.8 KiB
Plaintext
45 lines
1.8 KiB
Plaintext
/** \page Accessibility
|
|
|
|
Navigate back: \ref index "Main" / \ref Cookbook
|
|
<hr>
|
|
|
|
\section secAccessibility Accessibility
|
|
|
|
\subsection CB_MaintainCompat Maintaining Compatibility with other HDF5 Library Versions
|
|
|
|
\par Problem
|
|
You want to ensure that the HDF5 files you produce or modify are accessible by all
|
|
releavnt tools and applications
|
|
|
|
\par Solution
|
|
For HDF5 items (objects, attributes, etc.) that you would like to
|
|
create in new or existing HDF5 files, ascertain the supported range of HDF5
|
|
library versions as lower and upper bounds. When creating new or opening
|
|
existing HDF5 files, use a file access property list and configure the supported
|
|
range via the H5Pset_libver_bounds() function.\n
|
|
In the example below, we restrict HDF5 item creation to the HDF5 1.8.x family of
|
|
library versions.
|
|
\snippet{lineno} Accessibility.c set_libver_bounds
|
|
|
|
\par Discussion
|
|
See RFC \ref_rfc20160105 for a detailed and comprehensive account of HDF5
|
|
versioning (library, file format spec., etc.) and the H5Pset_libver_bounds()
|
|
function.\n
|
|
The default range #H5F_LIBVER_EARLIEST (low) - #H5F_LIBVER_LATEST (high) offers the
|
|
widest compatibility range, but may not be suitable for certain (feature-)use
|
|
cases.\n
|
|
The HDF5 library comes with a \Emph{forward-} and \Emph{backward-compatibility}
|
|
guarantee: This means that the latest version of the library can always read
|
|
HDF5 files created by a version realesed earlier (backward compatibility).
|
|
It also means that a given release of the library can read the contents of
|
|
HDF5 files created with later versions of the library as long as the files
|
|
do not contain features introduced in later versions (forward compatibility).
|
|
|
|
\par See Also
|
|
See the recipe \ref CB_LargeAttributes for an example where we use HDF5
|
|
compatibility settings to enable the creation of large HDF5 attributes.
|
|
|
|
<hr>
|
|
Navigate back: \ref index "Main" / \ref Cookbook
|
|
|
|
*/ |