diff options
Diffstat (limited to 'release_docs/CMake.txt')
| -rw-r--r--[-rwxr-xr-x] | release_docs/CMake.txt | 81 |
1 files changed, 75 insertions, 6 deletions
diff --git a/release_docs/CMake.txt b/release_docs/CMake.txt index e916df9..2d15741 100755..100644 --- a/release_docs/CMake.txt +++ b/release_docs/CMake.txt @@ -25,8 +25,11 @@ Notes: This short instruction is written for users who want to quickly build Please send us any comments on how CMake support can be improved on any system. Visit the KitWare site for more information about CMake. - 3. Build and test results can be submitted to our CDash server at: - www.cdash.hdfgroup.org. + 3. If you are building HDF5 on Windows, do NOT use or execute any + files from the windows folder. + + 4. Build and test results can be submitted to our CDash server at: + cdash.hdfgroup.uiuc.edu. Please read the HDF and CDash document at: www.hdfgroup.org/CDash/HowToSubmit. @@ -36,7 +39,7 @@ Notes: This short instruction is written for users who want to quickly build ======================================================================== 1. We suggest you obtain the latest CMake for windows from the Kitware - web site. The HDF5 1.8.x product requires CMake version 2.8.4. + web site. The HDF5 1.8.x product requires CMake version 2.8.6. 2. If you plan to use Zlib or Szip; A. Download the packages and install them @@ -102,8 +105,8 @@ Notes: This short instruction is written for users who want to quickly build <options> is: * SZIP_INCLUDE_DIR:PATH=<path to szip includes directory> * SZIP_LIBRARY:FILEPATH=<path to szip/library file> - * ZLIB_INCLUDE_DIR:PATH=<path to szip includes directory> - * ZLIB_LIBRARY:FILEPATH=<path to szip/library file> + * ZLIB_INCLUDE_DIR:PATH=<path to zlib includes directory> + * ZLIB_LIBRARY:FILEPATH=<path to zlib/library file> * <HDF5OPTION>:BOOL=[ON | OFF] <cacheinit.cmake> is: @@ -124,7 +127,6 @@ Notes: This short instruction is written for users who want to quickly build SET (HDF5_ENABLE_SZIP_ENCODING ON CACHE BOOL "Use SZip Encoding" FORCE) SET (HDF5_ENABLE_SZIP_SUPPORT ON CACHE BOOL "Use SZip Filter" FORCE) SET (HDF5_ENABLE_Z_LIB_SUPPORT ON CACHE BOOL "Enable Zlib Filters" FORCE) - SET (HDF5_USE_H5DUMP_PACKED_BITS ON CACHE BOOL "Use the PACKED BITS feature in h5dump" FORCE) SET (HDF5_ENABLE_COVERAGE OFF CACHE BOOL "Enable code coverage for Libraries and Programs" FORCE) 2. Configure the cache settings @@ -152,6 +154,12 @@ Notes: This short instruction is written for users who want to quickly build cmake -C ../config/cmake/cacheinit.cmake -G "Visual Studio 9 2008" \ -DHDF5_ENABLE_SZIP_SUPPORT:BOOL=OFF -DHDF5_ENABLE_Z_LIB_SUPPORT:BOOL=OFF .. + 2.3 On Windows, if you are using a VS Express version you must be sure that the + following two options are correctly set/unset: + + HDF5_NO_PACKAGES:BOOL=ON + HDF5_USE_FOLDERS:BOOL=OFF + 3. Build HDF5 On Windows, you can build HDF5 using either the Visual Studio Environment @@ -215,6 +223,10 @@ Notes: This short instruction is written for users who want to quickly build NOTE: We have just introduced the packaging capability and it has not been extensively tested. Please send us comments on how it can be improved. + See NSIS note 8 of this document. + Also, if you are using a VS Express version or do not want to enable + the packaging components, set HDF5_NO_PACKAGES to ON (on the command + line add -DHDF5_NO_PACKAGES:BOOL=ON) 6. The files that support building HDF5 with CMake are all the files in the config/cmake folder, the CMakeLists.txt files in each source folder, and @@ -224,6 +236,63 @@ Notes: This short instruction is written for users who want to quickly build 7. More information about using CMake can be found at the KitWare site, www.cmake.org. + + 8. Nullsoft Scriptable Install System + The Nullsoft Scriptable Install System (NSIS) is an open source installation + system. It was created by the WinAmp authors to distribute that application, + but it is now a general-purpose system which anyone might use. NSIS installers + recognize /S for silent installation and /D=dir to specify the + "output directory", which is where the program will be installed. These + options are case-sensitive, so be sure to type them in upper case. + + +======================================================================== + All options for HDF5 C/C++ Libraries with CMake +======================================================================== +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) +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) ************************************************************************ |