mirror of
https://github.com/HDFGroup/hdf5.git
synced 2025-03-31 17:10:47 +08:00
Update documents
This commit is contained in:
Allen Byrne
parent
fd20f7c0bb
commit
5f2700f256
@ -48,6 +48,8 @@ Default installation process:
|
||||
with the CTEST_SOURCE_NAME script option.
|
||||
The default installation folder is defined as "@CMAKE_INSTALL_PREFIX@".
|
||||
It can be changed with the INSTALLDIR script option.
|
||||
(Note: Windows has issues with spaces and paths -The path will need to
|
||||
be set correctly.)
|
||||
The default ctest configuration is defined as "Release". It can be changed
|
||||
with the CTEST_CONFIGURATION_TYPE script option. Note that this must
|
||||
be the same as the value used with the -C command line option.
|
||||
|
||||
@ -225,232 +225,6 @@ Also available at the HDF web site is a CMake application framework template.
|
||||
You can quickly add files to the framework and execute the script to compile
|
||||
your application with an installed HDF5 binary.
|
||||
|
||||
========================================================================
|
||||
ctest use of HDF5_Examples.cmake and HDF5_Examples_options.cmake
|
||||
========================================================================
|
||||
|
||||
cmake_minimum_required (VERSION 3.10)
|
||||
###############################################################################################################
|
||||
# This script will build and run the examples from a folder
|
||||
# Execute from a command line:
|
||||
# ctest -S HDF5_Examples.cmake,OPTION=VALUE -C Release -VV -O test.log
|
||||
###############################################################################################################
|
||||
|
||||
set(CTEST_CMAKE_GENERATOR "@CMAKE_GENERATOR@")
|
||||
if("@CMAKE_GENERATOR_TOOLSET@")
|
||||
set(CMAKE_GENERATOR_TOOLSET "@CMAKE_GENERATOR_TOOLSET@")
|
||||
endif()
|
||||
set(CTEST_DASHBOARD_ROOT ${CTEST_SCRIPT_DIRECTORY})
|
||||
|
||||
# handle input parameters to script.
|
||||
#INSTALLDIR - HDF5 root folder
|
||||
#CTEST_CONFIGURATION_TYPE - Release, Debug, RelWithDebInfo
|
||||
#CTEST_SOURCE_NAME - name of source folder; HDF5Examples
|
||||
if(DEFINED CTEST_SCRIPT_ARG)
|
||||
# transform ctest script arguments of the form
|
||||
# script.ctest,var1=value1,var2=value2
|
||||
# to variables with the respective names set to the respective values
|
||||
string(REPLACE "," ";" script_args "${CTEST_SCRIPT_ARG}")
|
||||
foreach(current_var ${script_args})
|
||||
if("${current_var}" MATCHES "^([^=]+)=(.+)$")
|
||||
set("${CMAKE_MATCH_1}" "${CMAKE_MATCH_2}")
|
||||
endif()
|
||||
endforeach()
|
||||
endif()
|
||||
|
||||
###################################################################
|
||||
### Following Line is one of [Release, RelWithDebInfo, Debug] #####
|
||||
set(CTEST_CONFIGURATION_TYPE "$ENV{CMAKE_CONFIG_TYPE}")
|
||||
if(NOT DEFINED CTEST_CONFIGURATION_TYPE)
|
||||
set(CTEST_CONFIGURATION_TYPE "Release")
|
||||
endif()
|
||||
set(ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DCTEST_CONFIGURATION_TYPE:STRING=${CTEST_CONFIGURATION_TYPE}")
|
||||
##################################################################
|
||||
|
||||
if(NOT DEFINED INSTALLDIR)
|
||||
set(INSTALLDIR "@CMAKE_INSTALL_PREFIX@")
|
||||
endif()
|
||||
|
||||
if(NOT DEFINED CTEST_SOURCE_NAME)
|
||||
set(CTEST_SOURCE_NAME "HDF5Examples")
|
||||
endif()
|
||||
|
||||
if(NOT DEFINED HDF_LOCAL)
|
||||
set(CDASH_LOCAL "NO")
|
||||
else()
|
||||
set(CDASH_LOCAL "YES")
|
||||
endif()
|
||||
if(NOT DEFINED CTEST_SITE)
|
||||
set(CTEST_SITE "local")
|
||||
endif()
|
||||
if(NOT DEFINED CTEST_BUILD_NAME)
|
||||
set(CTEST_BUILD_NAME "examples")
|
||||
endif()
|
||||
set(ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DSITE:STRING=${CTEST_SITE} -DBUILDNAME:STRING=${CTEST_BUILD_NAME}")
|
||||
|
||||
#TAR_SOURCE - name of tarfile
|
||||
#if(NOT DEFINED TAR_SOURCE)
|
||||
# set(CTEST_USE_TAR_SOURCE "HDF5Examples-1.10.7-Source")
|
||||
#endif()
|
||||
|
||||
###############################################################################################################
|
||||
if(WIN32)
|
||||
set(SITE_OS_NAME "Windows")
|
||||
set(ENV{HDF5_DIR} "${INSTALLDIR}/cmake")
|
||||
set(CTEST_BINARY_NAME ${CTEST_SOURCE_NAME}\\build)
|
||||
set(CTEST_SOURCE_DIRECTORY "${CTEST_DASHBOARD_ROOT}\\${CTEST_SOURCE_NAME}")
|
||||
set(CTEST_BINARY_DIRECTORY "${CTEST_DASHBOARD_ROOT}\\${CTEST_BINARY_NAME}")
|
||||
else()
|
||||
set(ENV{HDF5_DIR} "${INSTALLDIR}/share/cmake")
|
||||
set(ENV{LD_LIBRARY_PATH} "${INSTALLDIR}/lib")
|
||||
set(CTEST_BINARY_NAME ${CTEST_SOURCE_NAME}/build)
|
||||
set(CTEST_SOURCE_DIRECTORY "${CTEST_DASHBOARD_ROOT}/${CTEST_SOURCE_NAME}")
|
||||
set(CTEST_BINARY_DIRECTORY "${CTEST_DASHBOARD_ROOT}/${CTEST_BINARY_NAME}")
|
||||
endif()
|
||||
if(${CDASH_LOCAL})
|
||||
set(ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DCDASH_LOCAL:BOOL=ON")
|
||||
endif()
|
||||
set(ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DHDF5_PACKAGE_NAME:STRING=@HDF5_PACKAGE@@HDF_PACKAGE_EXT@")
|
||||
|
||||
###############################################################################################################
|
||||
# For any comments please contact help@hdfgroup.org
|
||||
#
|
||||
###############################################################################################################
|
||||
|
||||
#############################################################################################
|
||||
#### Change default configuration of options in config/cmake/cacheinit.cmake file ###
|
||||
#### format for file: set(ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DXXX:YY=ZZZZ") ###
|
||||
#############################################################################################
|
||||
if(WIN32)
|
||||
include(${CTEST_SCRIPT_DIRECTORY}\\HDF5_Examples_options.cmake)
|
||||
else()
|
||||
include(${CTEST_SCRIPT_DIRECTORY}/HDF5_Examples_options.cmake)
|
||||
endif()
|
||||
|
||||
#-----------------------------------------------------------------------------
|
||||
set (CTEST_CMAKE_COMMAND "\"${CMAKE_COMMAND}\"")
|
||||
## --------------------------
|
||||
if (CTEST_USE_TAR_SOURCE)
|
||||
## Uncompress source if tar or zip file provided
|
||||
## --------------------------
|
||||
if (WIN32)
|
||||
message (STATUS "extracting... [${CMAKE_EXECUTABLE_NAME} -E tar -xvf ${CTEST_USE_TAR_SOURCE}.zip]")
|
||||
execute_process (COMMAND ${CMAKE_EXECUTABLE_NAME} -E tar -xvf ${CTEST_DASHBOARD_ROOT}\\${CTEST_USE_TAR_SOURCE}.zip RESULT_VARIABLE rv)
|
||||
else ()
|
||||
message (STATUS "extracting... [${CMAKE_EXECUTABLE_NAME} -E tar -xvf ${CTEST_USE_TAR_SOURCE}.tar]")
|
||||
execute_process (COMMAND ${CMAKE_EXECUTABLE_NAME} -E tar -xvf ${CTEST_DASHBOARD_ROOT}/${CTEST_USE_TAR_SOURCE}.tar RESULT_VARIABLE rv)
|
||||
endif ()
|
||||
|
||||
if (NOT rv EQUAL 0)
|
||||
message (STATUS "extracting... [error-(${rv}) clean up]")
|
||||
file (REMOVE_RECURSE "${CTEST_SOURCE_DIRECTORY}")
|
||||
message (FATAL_ERROR "error: extract of ${CTEST_SOURCE_NAME} failed")
|
||||
endif ()
|
||||
endif ()
|
||||
|
||||
#-----------------------------------------------------------------------------
|
||||
## Clear the build directory
|
||||
## --------------------------
|
||||
set (CTEST_START_WITH_EMPTY_BINARY_DIRECTORY TRUE)
|
||||
if (EXISTS "${CTEST_BINARY_DIRECTORY}" AND IS_DIRECTORY "${CTEST_BINARY_DIRECTORY}")
|
||||
ctest_empty_binary_directory (${CTEST_BINARY_DIRECTORY})
|
||||
else ()
|
||||
file (MAKE_DIRECTORY "${CTEST_BINARY_DIRECTORY}")
|
||||
endif ()
|
||||
|
||||
# Use multiple CPU cores to build
|
||||
include (ProcessorCount)
|
||||
ProcessorCount (N)
|
||||
if (NOT N EQUAL 0)
|
||||
if (NOT WIN32)
|
||||
set (CTEST_BUILD_FLAGS -j${N})
|
||||
endif ()
|
||||
set (ctest_test_args ${ctest_test_args} PARALLEL_LEVEL ${N})
|
||||
endif ()
|
||||
set (CTEST_CONFIGURE_COMMAND
|
||||
"${CTEST_CMAKE_COMMAND} -C \"${CTEST_SOURCE_DIRECTORY}/config/cmake/cacheinit.cmake\" -DCMAKE_BUILD_TYPE:STRING=${CTEST_CONFIGURATION_TYPE} ${BUILD_OPTIONS} \"-G${CTEST_CMAKE_GENERATOR}\" \"${CTEST_SOURCE_DIRECTORY}\""
|
||||
)
|
||||
|
||||
#-----------------------------------------------------------------------------
|
||||
## -- set output to english
|
||||
set ($ENV{LC_MESSAGES} "en_EN")
|
||||
|
||||
#-----------------------------------------------------------------------------
|
||||
configure_file (${CTEST_SOURCE_DIRECTORY}/config/cmake/CTestCustom.cmake ${CTEST_BINARY_DIRECTORY}/CTestCustom.cmake)
|
||||
ctest_read_custom_files ("${CTEST_BINARY_DIRECTORY}")
|
||||
## NORMAL process
|
||||
## --------------------------
|
||||
ctest_start (Experimental)
|
||||
ctest_configure (BUILD "${CTEST_BINARY_DIRECTORY}")
|
||||
if (LOCAL_SUBMIT)
|
||||
ctest_submit (PARTS Configure Notes)
|
||||
endif ()
|
||||
ctest_build (BUILD "${CTEST_BINARY_DIRECTORY}" APPEND)
|
||||
if (LOCAL_SUBMIT)
|
||||
ctest_submit (PARTS Build)
|
||||
endif ()
|
||||
ctest_test (BUILD "${CTEST_BINARY_DIRECTORY}" APPEND ${ctest_test_args} RETURN_VALUE res)
|
||||
if (LOCAL_SUBMIT)
|
||||
ctest_submit (PARTS Test)
|
||||
endif ()
|
||||
if (res GREATER 0)
|
||||
message (FATAL_ERROR "tests FAILED")
|
||||
endif ()
|
||||
#-----------------------------------------------------------------------------
|
||||
##############################################################################################################
|
||||
|
||||
##############################################################################################################
|
||||
#### HDF5_Examples_options.cmake ###
|
||||
#### Change default configuration of options in config/cmake/cacheinit.cmake file ###
|
||||
##############################################################################################################
|
||||
#############################################################################################
|
||||
#### Change default configuration of options in config/cmake/cacheinit.cmake file ###
|
||||
#### format: set(ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DXXX:YY=ZZZZ") ###
|
||||
#### DEFAULT: ###
|
||||
#### BUILD_SHARED_LIBS:BOOL=OFF ###
|
||||
#### HDF_BUILD_C:BOOL=ON ###
|
||||
#### HDF_BUILD_CXX:BOOL=OFF ###
|
||||
#### HDF_BUILD_FORTRAN:BOOL=OFF ###
|
||||
#### HDF_BUILD_JAVA:BOOL=OFF ###
|
||||
#### BUILD_TESTING:BOOL=OFF ###
|
||||
#### HDF_ENABLE_PARALLEL:BOOL=OFF ###
|
||||
#### HDF_ENABLE_THREADSAFE:BOOL=OFF ###
|
||||
#############################################################################################
|
||||
|
||||
### uncomment/comment and change the following lines for other configuration options
|
||||
### build with shared libraries
|
||||
#set(ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DBUILD_SHARED_LIBS:BOOL=ON")
|
||||
|
||||
#############################################################################################
|
||||
#### languages ####
|
||||
### disable C builds
|
||||
#set(ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DHDF_BUILD_C:BOOL=OFF")
|
||||
|
||||
### enable C++ builds
|
||||
#set(ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DHDF_BUILD_CXX:BOOL=ON")
|
||||
|
||||
### enable Fortran builds
|
||||
#set(ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DHDF_BUILD_FORTRAN:BOOL=ON")
|
||||
|
||||
### enable JAVA builds
|
||||
#set(ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DHDF_BUILD_JAVA:BOOL=ON")
|
||||
|
||||
#############################################################################################
|
||||
### enable parallel program builds
|
||||
#set(ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DHDF_ENABLE_PARALLEL:BOOL=ON")
|
||||
|
||||
#############################################################################################
|
||||
### enable threadsafe program builds
|
||||
#set(ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DHDF_ENABLE_THREADSAFE:BOOL=ON")
|
||||
|
||||
#############################################################################################
|
||||
### enable test program builds, requires reference files in testfiles subdirectory
|
||||
#set(ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DBUILD_TESTING:BOOL=ON")
|
||||
#set(ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DCOMPARE_TESTING:BOOL=ON")
|
||||
|
||||
#############################################################################################
|
||||
|
||||
|
||||
|
||||
========================================================================
|
||||
For further assistance, send email to help@hdfgroup.org
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user