From 3c35ea9b72586322a8a12bed8b8fe7ffe23256e3 Mon Sep 17 00:00:00 2001 From: maier Date: Tue, 25 Sep 2012 10:01:38 +0000 Subject: [PATCH] Add some documentation git-svn-id: https://svn.dealii.org/branches/branch_cmake@26711 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/cmake/setup_deal_ii.cmake | 37 ++++++++++++++++++++++++++++++- 1 file changed, 36 insertions(+), 1 deletion(-) diff --git a/deal.II/cmake/setup_deal_ii.cmake b/deal.II/cmake/setup_deal_ii.cmake index d0d0e453d2..10ea87d850 100644 --- a/deal.II/cmake/setup_deal_ii.cmake +++ b/deal.II/cmake/setup_deal_ii.cmake @@ -1,6 +1,41 @@ # # Set up deal.II specific definitions # +# This file defines a long list of variables, used throughout the +# configuration to determine paths, locations and names: +# +# General information about deal: +# +# DEAL_II_PACKAGE_NAME *) +# DEAL_II_PACKAGE_VERSION +# DEAL_II_PACKAGE_STRING +# DEAL_II_PACKAGE_BUGREPORT *) +# DEAL_II_PACKAGE_TARNAME *) +# DEAL_II_PACKAGE_URL *) +# DEAL_II_VERSION_MAJOR +# DEAL_II_VERSION_MINOR +# +# Information about paths, install locations and names: +# +# DEAL_II_PROJECT_CONFIG_NAME *) +# DEAL_II_BASE_NAME *) +# DEAL_II_DEBUG_SUFFIX *) +# DEAL_II_LIBRARY_NAME_DEBUG +# DEAL_II_LIBRARY_NAME_RELEASE +# +# DEAL_II_PATH *) +# DEAL_II_DOCUMENTATION_RELDIR *) +# DEAL_II_EXAMPLES_RELDIR *) +# DEAL_II_INCLUDE_RELDIR *) +# DEAL_II_LIBRARY_RELDIR *) +# DEAL_II_PROJECT_CONFIG_RELDIR *) +# +# DEAL_II_INCLUDE_DIRS +# DEAL_II_LIBRARIES +# +# *) Values marked with *) can be overwritten by the command line via +# -D<...> +# SET_IF_EMPTY(DEAL_II_PACKAGE_NAME "deal.II") @@ -11,7 +46,7 @@ SET(DEAL_II_PACKAGE_STRING SET_IF_EMPTY(DEAL_II_PACKAGE_BUGREPORT "dealii@dealii.org") SET_IF_EMPTY(DEAL_II_PACKAGE_TARNAME ${DEAL_II_PACKAGE_NAME}) #TODO -SET_IF_EMPTY(DEAL_II_PACKAGE_URL "http://www.dealii.org") +SET_IF_EMPTY(DEAL_II_PACKAGE_URL "http://www.dealii.org") #TODO STRING(REGEX REPLACE "^([0-9]+)\\..*" "\\1" DEAL_II_VERSION_MAJOR "${VERSION}" -- 2.39.5