From: maier Date: Fri, 28 Sep 2012 11:15:26 +0000 (+0000) Subject: Update the documentation X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=dfe383e048f735680dd65f76b00b6a4e5347ebb6;p=dealii-svn.git Update the documentation git-svn-id: https://svn.dealii.org/branches/branch_cmake@26825 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/README.CMAKE b/deal.II/README.CMAKE index 81ba7bf34e..8ac36fc13d 100644 --- a/deal.II/README.CMAKE +++ b/deal.II/README.CMAKE @@ -637,11 +637,51 @@ DEVELOPMENT We currently have cmake/check/check_for_compiler_bugs.cmake - + cmake/check/check_for_compiler_bugs_*.cmake cmake/check/check_for_compiler_features.cmake - cmake/check/check_for_cxx_features.cmake + Useful commands: + + - There are a number of readily available platform check macros: + + CHECK_CXX_SOURCE_COMPILES(source variable) + Checks whether it is possible to compile _and_ link the code snipet + . If succesful, variable is set to 1. + + CHECK_CXX_SOURCE_RUNS(source variable) + variable is set to 1 if coulde be succesfully compiled and + linked and the resulting program ran and exited wihtout error. + + CHECK_CXX_COMPILER_BUG(source variable) + Inverts the logic of CHECK_CXX_SOURCE_COMPILES(), i.e. variable is + set to 1 if it was not possible to compile and link . + + CHECK_INCLUDE_FILE_CXX(header variable) + Check whether it is possible to compile and link a dummy program + including
. + + CHECK_FUNCTION_EXISTS(function variable) + Check for the existence of a function prototype with name + . (Don't forget to specify the link libraries, see + below.) + + - Necessary compiler flags can easily set in the string variable + CMAKE_REQUIRED_FLAGS. There are two small macros that do this job + nicely: + + PUSH_TEST_FLAG("-Werror") + CHECK_CXX_SOURCE_COMPILES(...) + POP_TEST_FLAG() + + - Libraries necessary for linkage can be set in the list variable + CMAKE_REQUIRED_LIBRARIES. It is best two hard set this variable to a + specific value and later on cleaning it, instead of appending/removing: + + SET(CMAKE_REQUIRED_LIBRARIES + CHECK_CXX_SOURCE_COMPILES(...) + SET(CMAKE_REQUIRED_LIBRARIES) + General notes: