diff options
| author | Allen Byrne <byrn@hdfgroup.org> | 2020-11-09 13:55:52 (GMT) |
|---|---|---|
| committer | Allen Byrne <byrn@hdfgroup.org> | 2020-11-09 13:55:52 (GMT) |
| commit | 4e6b6781eebe98d79d32d588ed0f6ea575957e3d (patch) | |
| tree | a30661e097730a8149f2cab08a90bb4962e6c9bd | |
| parent | 2457e584070379240b7a0a721c6fd2a3096a9fd3 (diff) | |
| download | hdf5-4e6b6781eebe98d79d32d588ed0f6ea575957e3d.zip hdf5-4e6b6781eebe98d79d32d588ed0f6ea575957e3d.tar.gz hdf5-4e6b6781eebe98d79d32d588ed0f6ea575957e3d.tar.bz2 | |
Set doxygen default to normally disabled.
| -rw-r--r-- | CMakeLists.txt | 2 | ||||
| -rw-r--r-- | configure.ac | 8 | ||||
| -rw-r--r-- | release_docs/INSTALL_CMake.txt | 2 | ||||
| -rw-r--r-- | release_docs/RELEASE.txt | 1 |
4 files changed, 7 insertions, 6 deletions
diff --git a/CMakeLists.txt b/CMakeLists.txt index 8283fbc..a2aeace 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -535,7 +535,7 @@ endif () #----------------------------------------------------------------------------- # Option to build documentation #----------------------------------------------------------------------------- -option (HDF5_BUILD_DOC "Build documentation" ON) +option (HDF5_BUILD_DOC "Build documentation" OFF) if (HDF5_BUILD_DOC AND EXISTS "${HDF5_DOXYGEN_DIR}" AND IS_DIRECTORY "${HDF5_DOXYGEN_DIR}") # check if Doxygen is installed find_package(Doxygen) diff --git a/configure.ac b/configure.ac index 5b2f776..13c23b7 100644 --- a/configure.ac +++ b/configure.ac @@ -1055,14 +1055,14 @@ fi ## This needs to be exposed for the library info file. AC_SUBST([HDF5_DOXYGEN]) -## Default is to build DOXYGEN -HDF5_DOXYGEN=yes +## Default is to not build DOXYGEN +HDF5_DOXYGEN=no -AC_MSG_CHECKING([if building doxygen is disabled]) +AC_MSG_CHECKING([if building doxygen is enabled]) AC_ARG_ENABLE([doxygen], [AS_HELP_STRING([--enable-doxygen], - [Compile the HDF5 doxygen files [default=yes]])], + [Compile the HDF5 doxygen files [default=no]])], [HDF5_DOXYGEN=$enableval]) if test "X$HDF5_DOXYGEN" = "Xyes"; then diff --git a/release_docs/INSTALL_CMake.txt b/release_docs/INSTALL_CMake.txt index c7a3eac..f42f780 100644 --- a/release_docs/INSTALL_CMake.txt +++ b/release_docs/INSTALL_CMake.txt @@ -791,7 +791,7 @@ if (HDF5_BUILD_FORTRAN) if (BUILD_SHARED_LIBS AND NOT BUILD_STATIC_LIBS) default HDF5_INSTALL_MOD_FORTRAN is SHARED if (NOT BUILD_SHARED_LIBS AND BUILD_STATIC_LIBS) default HDF5_INSTALL_MOD_FORTRAN is STATIC if (NOT BUILD_SHARED_LIBS AND NOT BUILD_STATIC_LIBS) default HDF5_INSTALL_MOD_FORTRAN is SHARED -HDF5_BUILD_DOC "Build documentation" ON +HDF5_BUILD_DOC "Build documentation" OFF HDF5_ENABLE_ANALYZER_TOOLS "enable the use of Clang tools" OFF HDF5_ENABLE_SANITIZERS "execute the Clang sanitizer" OFF HDF5_ENABLE_FORMATTERS "format source files" OFF diff --git a/release_docs/RELEASE.txt b/release_docs/RELEASE.txt index 266f767..639dbe7 100644 --- a/release_docs/RELEASE.txt +++ b/release_docs/RELEASE.txt @@ -50,6 +50,7 @@ New Features ------------- - Autotools and CMake target added to produce doxygen generated documentation + The default is OFF or disabled. Autoconf option is '--enable-doxygen' autotools make target is 'doxygen' and will build all doxygen targets CMake configure option is 'HDF5_BUILD_DOC'. |