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.
32 lines
1.1 KiB
Markdown
32 lines
1.1 KiB
Markdown
# The `config` directory
|
|
|
|
## Intro
|
|
|
|
HDF5 can be configured using CMake.
|
|
|
|
Configuration information for the HDF5 library and tools is
|
|
specific to the repository folders. Each subdirectory of the project
|
|
has its own CMake build and test files. Basic library configuration will generally
|
|
be found in the root's `CMakeLists.txt` with support for macros and settings
|
|
in this config directory.
|
|
|
|
|
|
This directory contains a few important things:
|
|
|
|
* Support files for optional components (in `cmake`)
|
|
* Compiler and platform parameters (in `flags`)
|
|
* Warning files (in `*-warnings` directories)
|
|
* Toolchain files (in `toolchain`)
|
|
* Sanitizer files (in `sanitizer`)
|
|
* Example install scripts (in `examples`)
|
|
* Installation support files (in `install`)
|
|
|
|
CMake is documented in the following files in the `docs/` directory:
|
|
|
|
* [INSTALL.md](../docs/INSTALL.md)
|
|
* [INSTALL_CMake.md](../docs/INSTALL_CMake.md)
|
|
* [USING_HDF5_CMake.md](../docs/USING_HDF5_CMake.md)
|
|
* [USING_HDF5_VS.md](../docs/USING_HDF5_VS.md)
|
|
* [INSTALL_Windows.md](../docs/INSTALL_Windows.md)
|
|
* [USING_CMake_Examples.md](../docs/USING_CMake_Examples.md)
|