From 72bf9e79b6c3586efeee6f2fb633a9a3aa2338c2 Mon Sep 17 00:00:00 2001 From: maier Date: Fri, 1 Mar 2013 22:42:40 +0000 Subject: [PATCH] Finish Config.sample git-svn-id: https://svn.dealii.org/branches/branch_cmake@28707 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/doc/development/Config.sample | 437 +++++++++++++++++--------- 1 file changed, 281 insertions(+), 156 deletions(-) diff --git a/deal.II/doc/development/Config.sample b/deal.II/doc/development/Config.sample index 373ef9e798..499db3b46b 100644 --- a/deal.II/doc/development/Config.sample +++ b/deal.II/doc/development/Config.sample @@ -15,179 +15,133 @@ # # Component configuration: # - -SET(DEAL_II_COMPONENT_COMPAT_FILES ON CACHE BOOL - "Enable installation of the example steps. This adds a COMPONENT \"compat_files\" to the build system." - ) - -SET(DEAL_II_COMPONENT_CONTRIB OFF CACHE BOOL - "Enable installation of contrib packages. This adds a COMPONENT \"contrib\" to the build system." - ) - -SET(DEAL_II_COMPONENT_DOCUMENTATION OFF CACHE BOOL - "Enable configuration, build and installation of the documentation. This adds a COMPONENT \"documentation\" to the build system." - ) - -SET(DEAL_II_COMPONENT_EXAMPLES ON CACHE BOOL - "Enable configuration and installation of the example steps. This adds a COMPONENT \"examples\" to the build system." - ) - # -# General Feature configuration: +# SET(DEAL_II_COMPONENT_COMPAT_FILES ON CACHE BOOL +# "Enable installation of the example steps. This adds a COMPONENT \"compat_files\" to the build system." +# ) # - -SET(DEAL_II_ALLOW_BUNDLED ON CACHE BOOL - "Allow the use of libraries bundled with the source tarball. (DEAL_II_FORCE_BUNDLED* will overwrite this option.)" - ) - -SET(DEAL_II_ALLOW_AUTODETECTION ON CACHE BOOL - "Allow to automatically setup features by setting all undefined DEAL_II_WITH_* variables to ON or OFF" - ) - -SET(DEAL_II_FORCE_AUTODETECTION OFF CACHE BOOL - "Force feature autodetection by undefining all DEAL_II_WITH_* variables prior to configure" - ) - -SET(DEAL_II_FORCE_BUNDLED_BOOST OFF CACHE BOOL - "Always use the bundled boost library instead of an external one." - ) - -SET(DEAL_II_FORCE_BUNDLED_FUNCTIONPARSER OFF CACHE BOOL - "Always use the bundled functionparser library instead of an external one." - ) - -SET(DEAL_II_FORCE_BUNDLED_THREADS OFF CACHE BOOL - "Always use the bundled tbb library instead of an external one." - ) - -SET(DEAL_II_FORCE_BUNDLED_UMFPACK OFF CACHE BOOL - "Always use the bundled umfpack library instead of an external one." - ) - +# SET(DEAL_II_COMPONENT_CONTRIB OFF CACHE BOOL +# "Enable installation of contrib packages. This adds a COMPONENT \"contrib\" to the build system." +# ) # -# Build configuration: +# SET(DEAL_II_COMPONENT_DOCUMENTATION OFF CACHE BOOL +# "Enable configuration, build and installation of the documentation. This adds a COMPONENT \"documentation\" to the build system." +# ) +# +# SET(DEAL_II_COMPONENT_EXAMPLES ON CACHE BOOL +# "Enable configuration and installation of the example steps. This adds a COMPONENT \"examples\" to the build system." +# ) # -SET(CMAKE_BUILD_TYPE "DebugRelease" CACHE STRING - "Choose the type of build, options are: Debug, Release and DebugRelease." - ) - -SET(CMAKE_INSTALL_PREFIX "/usr/local" CACHE PATH - "Install path prefix, prepended onto install directories." - ) - -SET(DEAL_II_ALLOW_PLATFORM_INTROSPECTION ON CACHE BOOL - "Allow platform introspection for CPU command set, SSE and AVX" - ) - -SET(DEAL_II_SETUP_DEFAULT_COMPILER_FLAGS ON CACHE BOOL - "Configure sensible default CFLAGS and CXXFLAGS depending on platform, compiler and build target." - ) # -#SET(CMAKE_CXX_COMPILER "" CACHE STRING "CXX Compiler.") +# General Feature configuration: # -#SET(CMAKE_C_COMPILER "" CACHE STRING "C Compiler.") # - -SET(CMAKE_CXX_FLAGS "" CACHE STRING - "The user supplied cache variable will be appended _at the end_ of the auto generated CMAKE_CXX_FLAGS variable" - ) - -SET(DEAL_II_CXX_FLAGS_DEBUG "" CACHE STRING - "The user supplied cache variable will be appended _at the end_ of the auto generated DEAL_II_CXX_FLAGS_DEBUG variable" - ) - -SET(DEAL_II_CXX_FLAGS_RELEASE "" CACHE STRING - "The user supplied cache variable will be appended _at the end_ of the auto generated DEAL_II_CXX_FLAGS_RELEASE variable" - ) - -SET(CMAKE_SHARED_LINKER_FLAGS "" CACHE STRING - "The user supplied cache variable will be appended _at the end_ of the auto generated CMAKE_SHARED_LINKER_FLAGS variable" - ) - -SET(DEAL_II_SHARED_LINKER_FLAGS_DEBUG "" CACHE STRING - "The user supplied cache variable will be appended _at the end_ of the auto generated DEAL_II_SHARED_LINKER_FLAGS_DEBUG variable" - ) - -SET(DEAL_II_SHARED_LINKER_FLAGS_RELEASE "" CACHE STRING - "The user supplied cache variable will be appended _at the end_ of the auto generated DEAL_II_SHARED_LINKER_FLAGS_RELEASE variable" - ) - -SET(BUILD_SHARED_LIBS "ON" CACHE BOOL - "Build a shared library" - ) - -SET(CMAKE_INSTALL_RPATH_USE_LINK_PATH "ON" CACHE BOOL - "Set the rpath of the library to the external link pathes on installation" - ) - - -########################################################################### -# # -# Advanced Configuration: # -# # -########################################################################### - +# SET(DEAL_II_ALLOW_BUNDLED ON CACHE BOOL +# "Allow the use of libraries bundled with the source tarball. (DEAL_II_FORCE_BUNDLED* will overwrite this option.)" +# ) # -# C++11 support: +# SET(DEAL_II_ALLOW_AUTODETECTION ON CACHE BOOL +# "Allow to automatically setup features by setting all undefined DEAL_II_WITH_* variables to ON or OFF" +# ) # -# C++11 support is autodetected. You can explicitly disable C+11 support by -# specifying +# SET(DEAL_II_FORCE_AUTODETECTION OFF CACHE BOOL +# "Force feature autodetection by undefining all DEAL_II_WITH_* variables prior to configure" +# ) # -# SET(DEAL_II_HAVE_CXX11_FLAG FALSE CACHE BOOL "") +# SET(DEAL_II_FORCE_BUNDLED_BOOST OFF CACHE BOOL +# "Always use the bundled boost library instead of an external one." +# ) # -# A custom C++11 flag can be set by setting +# SET(DEAL_II_FORCE_BUNDLED_FUNCTIONPARSER OFF CACHE BOOL +# "Always use the bundled functionparser library instead of an external one." +# ) # -# SET(DEAL_II_HAVE_CXX11_FLAG TRUE CACHE BOOL "") -# SET(DEAL_II_CXX11_FLAG "-std=c++0x" CACHE STRING "") +# SET(DEAL_II_FORCE_BUNDLED_THREADS OFF CACHE BOOL +# "Always use the bundled tbb library instead of an external one." +# ) +# +# SET(DEAL_II_FORCE_BUNDLED_UMFPACK OFF CACHE BOOL +# "Always use the bundled umfpack library instead of an external one." +# ) # # -# Platform introspection: +# Build configuration: # -# deal.II has some platform dependend tests and configuration options. -# They can be enabled/disabled with DEAL_II_ALLOW_PLATFORM_INTROSPECTION # -# To enable support for AVX and SSE manually, set: +# SET(CMAKE_BUILD_TYPE "DebugRelease" CACHE STRING +# "Choose the type of build, options are: Debug, Release and DebugRelease." +# ) # -# SET(DEAL_II_HAVE_SSE TRUE CACHE BOOL "") -# SET(DEAL_II_HAVE_AVX TRUE CACHE BOOL "") +# SET(DEAL_II_ALLOW_PLATFORM_INTROSPECTION ON CACHE BOOL +# "Allow platform introspection for CPU command set, SSE and AVX" +# ) # - - +# SET(DEAL_II_SETUP_DEFAULT_COMPILER_FLAGS ON CACHE BOOL +# "Configure sensible default CFLAGS and CXXFLAGS depending on platform, compiler and build target." +# ) # -# Threading support: +# SET(CMAKE_CXX_COMPILER "" CACHE STRING +# "CXX Compiler." +# ) # -# SET(DEAL_II_WITH_THREADS ON CACHE BOOL "") +# SET(CMAKE_C_COMPILER "" CACHE STRING +# "C Compiler." +# ) # -# TODO +# SET(CMAKE_CXX_FLAGS "" CACHE STRING +# "The user supplied cache variable will be appended _at the end_ of the auto generated CMAKE_CXX_FLAGS variable" +# ) # - - +# SET(DEAL_II_CXX_FLAGS_DEBUG "" CACHE STRING +# "The user supplied cache variable will be appended _at the end_ of the auto generated DEAL_II_CXX_FLAGS_DEBUG variable" +# ) # -# MPI: +# SET(DEAL_II_CXX_FLAGS_RELEASE "" CACHE STRING +# "The user supplied cache variable will be appended _at the end_ of the auto generated DEAL_II_CXX_FLAGS_RELEASE variable" +# ) # -# SET(DEAL_II_WITH_MPI ON CACHE BOOL "") +# SET(CMAKE_SHARED_LINKER_FLAGS "" CACHE STRING +# "The user supplied cache variable will be appended _at the end_ of the auto generated CMAKE_SHARED_LINKER_FLAGS variable" +# ) # -# SET(DEAL_II_USE_MPICXX ON CACHE BOOL -# "Set the compiler to the detected mpi wrapper" +# SET(DEAL_II_SHARED_LINKER_FLAGS_DEBUG "" CACHE STRING +# "The user supplied cache variable will be appended _at the end_ of the auto generated DEAL_II_SHARED_LINKER_FLAGS_DEBUG variable" # ) # -# TODO +# SET(DEAL_II_SHARED_LINKER_FLAGS_RELEASE "" CACHE STRING +# "The user supplied cache variable will be appended _at the end_ of the auto generated DEAL_II_SHARED_LINKER_FLAGS_RELEASE variable" +# ) # +# SET(BUILD_SHARED_LIBS "ON" CACHE BOOL +# "Build a shared library" +# ) +# +# SET(CMAKE_INSTALL_RPATH_USE_LINK_PATH "ON" CACHE BOOL +# "Set the rpath of the library to the external link pathes on installation" +# ) +# + +########################################################################### +# # +# Advanced Feature Configuration: # +# # +########################################################################### # # Arpack: # -# SET(DEAL_II_WITH_ARPACK ON CACHE BOOL "") +# SET(DEAL_II_WITH_ARPACK ON CACHE BOOL +# "Build deal.II with support for arpack" # # Automatic detection: # # Specify a hint with CMAKE_PREFIX_PATH or by setting -# SET(ARPACK_DIR "/.../..." CACHE PATH "") +# SET(ARPACK_DIR "/.../..." CACHE PATH "") # # Manual setup: # @@ -197,15 +151,49 @@ SET(CMAKE_INSTALL_RPATH_USE_LINK_PATH "ON" CACHE BOOL # +# +# Boost: +# +# SET(DEAL_II_WITH_BOOST ON CACHE BOOL +# "Build deal.II with support for boost" +# FORCE) +# +# SET(DEAL_II_FORCE_BUNDLED_BOOST TRUE CACHE BOOL +# "Always use the bundled boost library instead of an external one." +# ) +# +# Boost is a mandatory build time dependency. +# +# TODO +# + + +# +# Functionparser: +# +# SET(DEAL_II_WITH_FUNCTIONPARSER TRUE CACHE BOOL +# "Build deal.II with support for functionparser" +# ) +# +# SET(DEAL_II_FORCE_BUNDLED_FUNCTIONPARSER TRUE CACHE BOOL +# "Always use the bundled functionparser library instead of an external one." +# ) +# +# Only support for bundled functionparser is available. +# + + # # HDF5: # -# SET(DEAL_II_WITH_HDF5 ON CACHE BOOL "") +# SET(DEAL_II_WITH_HDF5 ON CACHE BOOL +# "Build deal.II with support for hdf5" +# ) # # Automatic detection: # # Specify a hint with CMAKE_PREFIX_PATH or by setting -# SET(HDF5_DIR "/.../..." CACHE PATH "") +# SET(HDF5_DIR "/.../..." CACHE PATH "") # # Manual setup: # @@ -218,7 +206,9 @@ SET(CMAKE_INSTALL_RPATH_USE_LINK_PATH "ON" CACHE BOOL # # Lapack: # -# SET(DEAL_II_WITH_LAPACK ON CACHE BOOL "") +# SET(DEAL_II_WITH_LAPACK ON CACHE BOOL +# "Build deal.II with support for lapack" +# ) # # Automatic detection: # @@ -235,12 +225,14 @@ SET(CMAKE_INSTALL_RPATH_USE_LINK_PATH "ON" CACHE BOOL # # Metis: # -# SET(DEAL_II_WITH_METIS ON CACHE BOOL "") +# SET(DEAL_II_WITH_METIS ON CACHE BOOL +# "Build deal.II with support for metis" +# ) # # Automatic detection: # # Specify a hint with CMAKE_PREFIX_PATH or by setting -# SET(METIS_DIR "/.../..." CACHE PATH "") +# SET(METIS_DIR "/.../..." CACHE PATH "") # # Manual setup: # @@ -250,16 +242,33 @@ SET(CMAKE_INSTALL_RPATH_USE_LINK_PATH "ON" CACHE BOOL # +# +# MPI: +# +# SET(DEAL_II_WITH_MPI ON CACHE BOOL "" +# "Build deal.II with support for mpi" +# ) +# +# SET(DEAL_II_USE_MPICXX ON CACHE BOOL +# "Set the compiler to the detected mpi wrapper" +# ) +# +# TODO +# + + # # Mumps: # -# SET(DEAL_II_WITH_MUMPS ON CACHE BOOL "") +# SET(DEAL_II_WITH_MUMPS ON CACHE BOOL +# "Build deal.II with support for mumps" +# ) # # Automatic detection: # # Specify a hint with CMAKE_PREFIX_PATH or by setting -# SET(MUMPS_DIR "/.../..." CACHE PATH "") -# also, if necessary, SCALAPACK_DIR and BLACS_DIR +# SET(MUMPS_DIR "/.../..." CACHE PATH "") +# also, if necessary, SCALAPACK_DIR and BLACS_DIR # # Manual setup: # @@ -273,12 +282,14 @@ SET(CMAKE_INSTALL_RPATH_USE_LINK_PATH "ON" CACHE BOOL # # Netcdf: # -# SET(DEAL_II_WITH_NETCDF ON CACHE BOOL "") +# SET(DEAL_II_WITH_NETCDF ON CACHE BOOL +# "Build deal.II with support for netcdf" +# ) # # Automatic detection: # # Specify a hint with CMAKE_PREFIX_PATH or by setting -# SET(NETCDF_DIR "/.../..." CACHE PATH "") +# SET(NETCDF_DIR "/.../..." CACHE PATH "") # # Manual setup: # @@ -291,13 +302,15 @@ SET(CMAKE_INSTALL_RPATH_USE_LINK_PATH "ON" CACHE BOOL # # P4EST: # -# SET(DEAL_II_WITH_P4EST ON CACHE BOOL "") +# SET(DEAL_II_WITH_P4EST ON CACHE BOOL +# "Build deal.II with support for p4est" +# ) # # Automatic detection: # # Specify a hint with CMAKE_PREFIX_PATH or by setting -# SET(P4EST_DIR "/.../..." CACHE PATH "") -# also, if necessary, SC_DIR +# SET(P4EST_DIR "/.../..." CACHE PATH "") +# also, if necessary, SC_DIR # # Manual setup: # @@ -311,13 +324,15 @@ SET(CMAKE_INSTALL_RPATH_USE_LINK_PATH "ON" CACHE BOOL # # PETSc: # -# SET(DEAL_II_WITH_PETSC ON CACHE BOOL "") +# SET(DEAL_II_WITH_PETSC ON CACHE BOOL +# "Build deal.II with support for petsc" +# ) # # Automatic detection: # # Specify a hint with CMAKE_PREFIX_PATH or by setting -# SET(PETSC_DIR "/.../..." CACHE PATH "") -# SET(PETSC_ARCH "..." CACHE STRING "") +# SET(PETSC_DIR "/.../..." CACHE PATH "") +# SET(PETSC_ARCH "..." CACHE STRING "") # # Manual setup: # @@ -335,13 +350,15 @@ SET(CMAKE_INSTALL_RPATH_USE_LINK_PATH "ON" CACHE BOOL # # SLEPc: # -# SET(DEAL_II_WITH_SLEPC ON CACHE BOOL "") +# SET(DEAL_II_WITH_SLEPC ON CACHE BOOL +# "Build deal.II with support for slepc" +# ) # # Automatic detection: # # Specify a hint with CMAKE_PREFIX_PATH or by setting -# SET(SLEPC_DIR "/.../..." CACHE PATH "") -# SET(SLEPC_ARCH "..." CACHE STRING "") +# SET(SLEPC_DIR "/.../..." CACHE PATH "") +# SET(SLEPC_ARCH "..." CACHE STRING "") # # Manual setup: # @@ -356,15 +373,28 @@ SET(CMAKE_INSTALL_RPATH_USE_LINK_PATH "ON" CACHE BOOL # +# +# Threading support: +# +# SET(DEAL_II_WITH_THREADS ON CACHE BOOL +# "Build deal.II with support for threads" +# ) +# +# TODO +# + + # # Trilinos: # -# SET(DEAL_II_WITH_TRILINOS ON CACHE BOOL "") +# SET(DEAL_II_WITH_TRILINOS ON CACHE BOOL +# "Build deal.II with support for trilinos" +# ) # # Automatic detection: # # Specify a hint with CMAKE_PREFIX_PATH or by setting -# SET(TRILINOS_DIR "/.../..." CACHE PATH "") +# SET(TRILINOS_DIR "/.../..." CACHE PATH "") # # Manual setup: # @@ -381,13 +411,19 @@ SET(CMAKE_INSTALL_RPATH_USE_LINK_PATH "ON" CACHE BOOL # # UMFPACK: # -# SET(DEAL_II_WITH_UMFPACK ON CACHE BOOL "") +# SET(DEAL_II_WITH_UMFPACK ON CACHE BOOL +# "Build deal.II with support for umfpack" +# ) +# +# SET(DEAL_II_FORCE_BUNDLED_UMFPACK TRUE CACHE BOOL +# "Always use the bundled umfpack library instead of an external one." +# ) # # Automatic detection: # # Specify a hint with CMAKE_PREFIX_PATH or by setting -# SET(UMFPACK_DIR "/.../..." CACHE PATH "") -# also, if necessary, SUITESPARSE_DIR (AMD_DIR, CHOLMOD_DIR, COLAMD_DIR, SUITESPARSECONFIG_DIR) +# SET(UMFPACK_DIR "/.../..." CACHE PATH "") +# also, if necessary, SUITESPARSE_DIR (AMD_DIR, CHOLMOD_DIR, COLAMD_DIR, SUITESPARSECONFIG_DIR) # # Manual setup: # @@ -397,3 +433,92 @@ SET(CMAKE_INSTALL_RPATH_USE_LINK_PATH "ON" CACHE BOOL # SET(UMFPACK_LINKER_FLAGS "..." CACHE STRING "") # + + +########################################################################### +# # +# Advanced Configuration: # +# # +########################################################################### + +# +# C++11 support: +# +# C++11 support is autodetected. You can explicitly disable C+11 support by +# specifying +# +# SET(DEAL_II_HAVE_CXX11_FLAG FALSE CACHE BOOL "") +# +# A custom C++11 flag can be set by setting +# +# SET(DEAL_II_HAVE_CXX11_FLAG TRUE CACHE BOOL "") +# SET(DEAL_II_CXX11_FLAG "-std=c++0x" CACHE STRING "") +# + + +# +# Platform introspection: +# +# deal.II has some platform dependend tests and configuration options. +# They can be enabled/disabled with DEAL_II_ALLOW_PLATFORM_INTROSPECTION +# (see above) +# +# To enable support for AVX and SSE manually, set: +# +# SET(DEAL_II_HAVE_SSE TRUE CACHE BOOL "") +# SET(DEAL_II_HAVE_AVX TRUE CACHE BOOL "") +# + + +# +# Obnoxiously adavanced configuration about paths, install locations and +# names: +# +# SET(DEAL_II_PACKAGE_NAME "deal.II" CACHE STRING +# "The glorious package name" +# ) +# +# SET(DEAL_II_PROJECT_CONFIG_NAME "${DEAL_II_PACKAGE_NAME}" CACHE STRING +# "Basename for the CMake project config file" +# ) +# +# SET(DEAL_II_BASE_NAME "deal_II" CACHE STRING +# "Basename for the library" +# ) +# +# SET(DEAL_II_DEBUG_SUFFIX ".g" CACHE STRING +# "Library suffix for the debug library" +# ) +# +# SET_IF_EMPTY(DEAL_II_RELEASE_SUFFIX "" CACHE STRING +# "Library suffix for the release library" +# ) +# +# SET(DEAL_II_CMAKE_MACROS_RELDIR "cmake/macros" CACHE STRING +# "Relative installation directory for macros" +# ) +# +# SET(DEAL_II_DOCUMENTATION_RELDIR "doc" CACHE STRING +# "Relative installation directory for html documentation" +# ) +# +# SET(DEAL_II_EXAMPLES_RELDIR "examples" CACHE STRING +# "Relative installation directory for examples" +# ) +# +# SET(DEAL_II_EXECUTABLE_RELDIR "bin" CACHE STRING +# "Relative installation directory for binary targets" +# ) +# +# SET(DEAL_II_INCLUDE_RELDIR "include" CACHE STRING +# "Relative installation directory for include files" +# ) +# +# SET(DEAL_II_LIBRARY_RELDIR "lib" CACHE STRING +# "Relative installation directory for library targets" +# ) +# +# SET(DEAL_II_PROJECT_CONFIG_RELDIR "${DEAL_II_LIBRARY_RELDIR}/cmake/${DEAL_II_PROJECT_CONFIG_NAME}" CACHE STRING +# "Relative installation directory for the CMake project configuration" +# ) +# -- 2.39.5