summaryrefslogtreecommitdiffstats
path: root/release_docs/INSTALL
diff options
context:
space:
mode:
authorLarry Knox <lrknox@hdfgroup.org>2021-07-06 18:21:42 (GMT)
committerLarry Knox <lrknox@hdfgroup.org>2021-07-06 18:21:42 (GMT)
commit820695a78e3a277daea1bdcbb8ad54b8ee6650a5 (patch)
treefe7545305c0a77db3b9671e5a82fdffc4b2cc82e /release_docs/INSTALL
parent9f13ecfa2e93840d1cc45dbf0bfcf8b955814931 (diff)
parent18bbd3f0a7f14adeebf8f342ed242ff191f9b7c5 (diff)
downloadhdf5-hdf5-1_12_1.zip
hdf5-hdf5-1_12_1.tar.gz
hdf5-hdf5-1_12_1.tar.bz2
Merge remote-tracking branch 'origin/hdf5_1_12_1' into 1.12/master forhdf5-1_12_1
HDF5 1.12.1 release.
Diffstat (limited to 'release_docs/INSTALL')
-rw-r--r--release_docs/INSTALL24
1 files changed, 20 insertions, 4 deletions
diff --git a/release_docs/INSTALL b/release_docs/INSTALL
index d61422e..d9db28c 100644
--- a/release_docs/INSTALL
+++ b/release_docs/INSTALL
@@ -351,15 +351,18 @@ CONTENTS
so it can be debugged with gdb, dbx, ddd, etc., or it can be
compiled with various optimizations. To compile for symbolic
debugging (the default for snapshots), say
- `--enable-build-mode=production'; to compile with optimizations
+ `--enable-build-mode=debug'; to compile with optimizations
(the default for supported public releases),
- say `--enable-build-mode=production'. On some systems the
+ say `--enable-build-mode=production'. For a 'clean slate' configuration
+ with optimization disabled and nothing turned on,
+ say `--enable-build-mode=clean'. On some systems the
library can also be compiled for profiling with gprof by saying
- `--enable-production=profile'.
+ `--enable-profiling'.
$ ./configure --enable-build-mode=debug #symbolic debugging
$ ./configure --enable-build-mode=production #optimized code
- $ ./configure --enable-production=profile #for use with gprof
+ $ ./configure --enable-build-mode=clean #'clean slate'
+ $ ./configure --enable-profiling #for use with gprof
Regardless of whether support for symbolic debugging is enabled,
the library can also perform runtime debugging of certain packages
@@ -445,6 +448,19 @@ CONTENTS
$ make -j -l6
+4.4. Building doxygen
+ One can optionally build the doxygen files for the HDF5 C library.
+ By default, this option is disabled. To build the html files, specify
+ '--enable-doxygen'.
+
+ $ ./configure --enable-doxygen
+
+ Configuration will halt if the required applications are not available.
+ To build:
+
+ $ make doxygen
+
+
4.5. Testing
HDF5 comes with various test suites, all of which can be run by
specifying: