[svn-r22261] Update list of CMake options

1 files changed, 62 insertions, 45 deletions

diff --git a/release_docs/CMake.txt b/release_docs/CMake.txt
index 173650c..6da3620 100644
--- a/release_docs/CMake.txt
+++ b/release_docs/CMake.txt
@@ -248,52 +248,69 @@ Notes: This short instruction is written for users who want to quickly build
                                                                          
 ========================================================================
           All options for HDF5 C/C++ Libraries with CMake
+          Option Name --- Option Description --- Option Default
 ========================================================================
-OPTION (HDF5_Enable_Clear_File_Buffers "Securely clear file buffers before writing to file" ON)
-OPTION (HDF5_Enable_Instrument "Instrument The library" HDF5_Enable_Instrument)
-OPTION (HDF5_STRICT_FORMAT_CHECKS "Whether to perform strict file format checks" OFF)
-OPTION (HDF5_METADATA_TRACE_FILE "Enable metadata trace file collection" OFF)
-OPTION (HDF5_WANT_DATA_ACCURACY "IF data accuracy is guaranteed during data conversions" ON)
-OPTION (HDF5_WANT_DCONV_EXCEPTION "exception handling functions is checked during data conversions" ON)
-OPTION (HDF5_ENABLE_CODESTACK "Enable the function stack tracing (for developer debugging)." OFF)
-OPTION (HDF5_ENABLE_HSIZET "Enable datasets larger than memory" ON)
-OPTION (HDF5_ENABLE_LARGE_FILE "Enable support for large (64-bit) files on Linux." ON)
-OPTION (HDF5_ENABLE_GPFS "Enable GPFS hints for the MPI/POSIX file driver" OFF)
-IF (APPLE) OPTION (HDF5_BUILD_WITH_INSTALL_NAME "Build with library install_name set to the installation path" OFF)
-IF (WIN32 AND NOT CYGWIN) OPTION (HDF_LEGACY_NAMING "Use Legacy Names for Libraries and Programs" OFF)
-OPTION (BUILD_SHARED_LIBS "Build Shared Libraries" OFF)
-OPTION (BUILD_STATIC_EXECS "Build Static Executabless" OFF)
-OPTION (BUILD_STATIC_PIC "Build Static PIC" OFF)
-OPTION (HDF5_ENABLE_COVERAGE "Enable code coverage for Libraries and Programs" OFF)
-OPTION (HDF5_ENABLE_USING_MEMCHECKER "Indicate that a memory checker is used" OFF)
-OPTION (HDF5_ENABLE_DEPRECATED_SYMBOLS "Enable deprecated public API symbols" ON)
-OPTION (HDF5_ENABLE_TRACE "Enable API tracing capability" ON)
-OPTION (HDF5_ENABLE_TRACE "Enable API tracing capability" OFF)
-OPTION (HDF5_ENABLE_EMBEDDED_LIBINFO "embed library info into executables" ON)
-OPTION (HDF5_DISABLE_COMPILER_WARNINGS "Disable compiler warnings" OFF)
-OPTION (HDF5_ENABLE_PARALLEL "Enable parallel build (requires MPI)" OFF)
-OPTION (HDF5_USE_16_API_DEFAULT "Use the HDF5 1.6.x API by default" OFF)
-OPTION (HDF5_USE_18_API_DEFAULT "Use the HDF5 1.8.x API by default" OFF)
-OPTION (HDF5_USE_FILTER_${FILTER} "Use the ${FILTER} Filter" ON)
-OPTION (HDF5_ALLOW_EXTERNAL_SUPPORT "Allow External Library Building" "NO")
-OPTION (ZLIB_USE_EXTERNAL "Use External Library Building for ZLIB" 0)
-OPTION (SZIP_USE_EXTERNAL "Use External Library Building for SZIP" 0)
-OPTION (HDF5_ENABLE_Z_LIB_SUPPORT "Enable Zlib Filters" OFF)
-OPTION (HDF5_ENABLE_SZIP_SUPPORT "Use SZip Filter" OFF)
-IF (HDF5_ENABLE_SZIP_SUPPORT) OPTION (HDF5_ENABLE_SZIP_ENCODING "Use SZip Encoding" OFF)
-OPTION (HDF5_PACKAGE_EXTLIBS "CPACK - include external libraries" OFF)
-IF (WIN32 AND NOT CYGWIN) OPTION (HDF5_ENABLE_THREADSAFE "Enable Threadsafety" OFF)
-OPTION (BUILD_TESTING "Build HDF5 Unit Testing" OFF)
-OPTION (HDF5_TEST_VFD "Execute tests with different VFDs" OFF)
-IF (HDF5_TEST_VFD) OPTION (HDF5_TEST_FHEAP_VFD "Execute tests with different VFDs" ON)
-OPTION (HDF5_BUILD_FORTRAN "Build FORTRAN support" OFF)
-IF (HDF5_BUILD_FORTRAN) OPTION (HDF5_ENABLE_F2003 "Enable FORTRAN 2003 Standard" OFF)
-OPTION (HDF5_BUILD_EXAMPLES  "Build HDF5 Library Examples" OFF)
-OPTION (HDF5_BUILD_CPP_LIB  "Build HDF5 C++ Library" OFF)
-OPTION (HDF5_BUILD_TOOLS  "Build HDF5 Tools" OFF)
-OPTION (HDF5_BUILD_HL_LIB  "Build HIGH Level HDF5 Library" OFF)
-OPTION (HDF5_NO_PACKAGES "Do not include CPack Packaging" OFF)
-OPTION (HDF5_USE_FOLDERS "Do not include CPack Packaging" OFF)
+---------------- General Build Options ---------------------
+BUILD_SHARED_LIBS "Build Shared Libraries" OFF
+BUILD_STATIC_EXECS "Build Static Executabless" OFF
+BUILD_STATIC_PIC "Build Static PIC" OFF
+BUILD_TESTING "Build HDF5 Unit Testing" OFF
+
+---------------- HDF5 Build Options ---------------------
+HDF5_BUILD_CPP_LIB  "Build HDF5 C++ Library" OFF
+HDF5_BUILD_EXAMPLES  "Build HDF5 Library Examples" OFF
+HDF5_BUILD_FORTRAN "Build FORTRAN support" OFF
+HDF5_BUILD_HL_LIB  "Build HIGH Level HDF5 Library" OFF
+HDF5_BUILD_TOOLS  "Build HDF5 Tools" OFF
+IF (HDF5_BUILD_FORTRAN) 
+    HDF5_ENABLE_F2003 "Enable FORTRAN 2003 Standard" OFF
+
+---------------- HDF5 Advanced Options ---------------------
+HDF5_DISABLE_COMPILER_WARNINGS "Disable compiler warnings" OFF
+HDF5_Enable_Clear_File_Buffers "Securely clear file buffers before writing to file" ON
+HDF5_Enable_Instrument "Instrument The library" HDF5_Enable_Instrument
+HDF5_ENABLE_CODESTACK "Enable the function stack tracing (for developer debugging)." OFF
+HDF5_ENABLE_COVERAGE "Enable code coverage for Libraries and Programs" OFF
+HDF5_ENABLE_DEPRECATED_SYMBOLS "Enable deprecated public API symbols" ON
+HDF5_ENABLE_EMBEDDED_LIBINFO "embed library info into executables" ON
+HDF5_ENABLE_GPFS "Enable GPFS hints for the MPI/POSIX file driver" OFF
+HDF5_ENABLE_HSIZET "Enable datasets larger than memory" ON
+HDF5_ENABLE_LARGE_FILE "Enable support for large (64-bit) files on Linux." ON
+HDF5_ENABLE_PARALLEL "Enable parallel build (requires MPI)" OFF
+HDF5_ENABLE_TRACE "Enable API tracing capability" OFF
+HDF5_ENABLE_USING_MEMCHECKER "Indicate that a memory checker is used" OFF
+HDF5_METADATA_TRACE_FILE "Enable metadata trace file collection" OFF
+HDF5_NO_PACKAGES "Do not include CPack Packaging" OFF
+HDF5_PACKAGE_EXTLIBS "CPACK - include external libraries" OFF
+HDF5_STRICT_FORMAT_CHECKS "Whether to perform strict file format checks" OFF
+HDF5_TEST_VFD "Execute tests with different VFDs" OFF
+HDF5_USE_16_API_DEFAULT "Use the HDF5 1.6.x API by default" OFF
+HDF5_USE_18_API_DEFAULT "Use the HDF5 1.8.x API by default" OFF
+HDF5_USE_FOLDERS "Do not include CPack Packaging" OFF
+HDF5_WANT_DATA_ACCURACY "IF data accuracy is guaranteed during data conversions" ON
+HDF5_WANT_DCONV_EXCEPTION "exception handling functions is checked during data conversions" ON
+IF (APPLE) 
+    HDF5_BUILD_WITH_INSTALL_NAME "Build with library install_name set to the installation path" OFF
+IF (CMAKE_BUILD_TYPE MATCHES Debug) 
+    HDF5_ENABLE_TRACE "Enable API tracing capability" ON
+IF (HDF5_TEST_VFD) 
+    HDF5_TEST_FHEAP_VFD "Execute tests with different VFDs" ON
+IF (WIN32 AND NOT CYGWIN) 
+    HDF_LEGACY_NAMING "Use Legacy Names for Libraries and Programs" OFF
+    HDF5_ENABLE_THREADSAFE "Enable Threadsafety" OFF
+
+---------------- External Library Options ---------------------
+HDF5_ALLOW_EXTERNAL_SUPPORT "Allow External Library Building" "NO"
+HDF5_ENABLE_SZIP_SUPPORT "Use SZip Filter" OFF
+HDF5_ENABLE_Z_LIB_SUPPORT "Enable Zlib Filters" OFF
+ZLIB_USE_EXTERNAL "Use External Library Building for ZLIB" 0
+SZIP_USE_EXTERNAL "Use External Library Building for SZIP" 0
+HDF5_USE_FILTER_FLETCHER32 "Use the FLETCHER32 Filter" ON
+HDF5_USE_FILTER_NBIT "Use the NBIT Filter" ON
+HDF5_USE_FILTER_SCALEOFFSET "Use the SCALEOFFSET Filter" ON
+HDF5_USE_FILTER_SHUFFLE "Use the SHUFFLE Filter" ON
+IF (HDF5_ENABLE_SZIP_SUPPORT) 
+    HDF5_ENABLE_SZIP_ENCODING "Use SZip Encoding" OFF
 
 
 ************************************************************************