From bab24f88ac57dbe64b827f4a0b7f16d0a5ca01cf Mon Sep 17 00:00:00 2001 From: maier Date: Fri, 21 Sep 2012 18:29:39 +0000 Subject: [PATCH] Last changes on the documentation git-svn-id: https://svn.dealii.org/branches/branch_cmake@26605 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/CMakeLists.txt | 66 +++++----------------------------- deal.II/README_CMAKE | 81 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 90 insertions(+), 57 deletions(-) diff --git a/deal.II/CMakeLists.txt b/deal.II/CMakeLists.txt index 8257127f1e..f63cb9f70e 100644 --- a/deal.II/CMakeLists.txt +++ b/deal.II/CMakeLists.txt @@ -8,22 +8,16 @@ ########################################################################### - - -SET(VERSION "8.0.pre") - - - - # # This is the main CMakeLists.txt file for the deal.II project -# ============================================================ # # The main purpose of this file is to set all the configuration options and # then call a lot of modules residing under ./cmake/*/ that do the # hard work. # +SET(VERSION "8.0.pre") + @@ -33,13 +27,16 @@ SET(VERSION "8.0.pre") # # ########################################################################### +# +# TODO: Some of the description strings span over multiple lines. Fix +# this. +# + # # Feature selection: external libraries and where to take them (if there # is a choice, e.g. from contrib vs external) # -# TODO: Some of the description strings span over multiple lines. Fix -# this somehow. OPTION(DEAL_II_FEATURE_AUTODETECTION "Enables feature autodetection. This will automatically overwrite all @@ -215,56 +212,11 @@ INCLUDE(setup_deal_ii) INCLUDE(setup_compiler_flags) -########################################################################## -# -# FAT NOTE: # -# To keep things clean, only the following cmake variables should be -# altered in the platform checks and feature configuration -# (beside setting a lot of DEAL_II_* definitions...): -# -# -# For internal use: -# -# CMAKE_SHARED_LINKER_FLAGS -# for setting necessary linker flags for the deal.II library. -# -# CMAKE_CXX_FLAGS (and CMAKE_C_FLAGS) -# for setting necessary compiler flags, e.g. -std=c++11 (if -# available). -# -# INCLUDE_DIRECTORIES() -# For setting necessary include dirs for the compilation of the -# deal.II library. -# -# ADD_DEFINITIONS() -# For setting necessary preprocessor definitions ("-D<...>") for -# the compilation of the deal.II library +# A custom target for all the target dependencies that have to be +# build/prepared before the deal.II library can be compiled # ADD_CUSTOM_TARGET(deal_ii_target_dependencies) -# Used as a dummy target for all the stuff that has to be done -# before the library can be compiled. -# -# -# For internal and external use: -# -# DEAL_II_EXTERNAL_LIBRARIES -# Used to keep track of external libraries, the deal.II library -# and user programs have to be linked against. -# -# -# For external use: -# -# DEAL_II_EXTERNAL_DEFINITIONS -# Used to keep track of external preprocessor definitions, -# necessary for the compilation of user programs. -# -# -# DEAL_II_EXTERNAL_INCLUDE_DIRS -# Used to keep track of external include dirs, necessary for the -# compilation of user programs. -# -########################################################################## # diff --git a/deal.II/README_CMAKE b/deal.II/README_CMAKE index 6f80c3af38..abc070b1fa 100644 --- a/deal.II/README_CMAKE +++ b/deal.II/README_CMAKE @@ -29,6 +29,12 @@ Installation Component selection +Fat note regarding platform checks and feature configuration + +Writing platform checks + +Writing features + @@ -38,6 +44,8 @@ The philosophy »I need a new keyboard, my CAPS-KEY is stuck because of writing all this cmake script...« +TODO + @@ -246,3 +254,76 @@ directories can be overwritten by +Fat note regarding platform checks and feature configuration +============================================================ + + + ============ + + FAT NOTE + + ============ + + +To keep things clean, only the following cmake variables should be +altered in the platform checks and feature configuration +(beside setting a lot of DEAL_II_* definitions...): + + +For internal use: + + CMAKE_SHARED_LINKER_FLAGS + for setting necessary linker flags for the deal.II library. + + CMAKE_CXX_FLAGS (and CMAKE_C_FLAGS) + for setting necessary compiler flags, e.g. -std=c++11 (if + available). + + INCLUDE_DIRECTORIES(...) + For setting necessary include dirs for the compilation of the + deal.II library. + + ADD_DEFINITIONS(...) + For setting necessary preprocessor definitions ("-D<...>") for + the compilation of the deal.II library + + ADD_DEPENDENCIES(deal_ii_target_dependencies ...) + Used as a dummy target for all the stuff that has to be done + before the library can be compiled. + + +For internal and external use: + + DEAL_II_EXTERNAL_LIBRARIES + Used to keep track of external libraries, the deal.II library + and user programs have to be linked against. + + +For external use: + + DEAL_II_EXTERNAL_DEFINITIONS + Used to keep track of external preprocessor definitions, + necessary for the compilation of user programs. + + + DEAL_II_EXTERNAL_INCLUDE_DIRS + Used to keep track of external include dirs, necessary for the + compilation of user programs. + + + + +Writing platform checks +======================= + + +TODO + + + + +Writing features +================ + +TODO + -- 2.39.5