summaryrefslogtreecommitdiffstats
path: root/Source/CPack/cmCPackDocumentVariables.cxx
diff options
context:
space:
mode:
authorEric NOULARD <eric.noulard@gmail.com>2012-05-20 15:28:54 (GMT)
committerEric NOULARD <eric.noulard@gmail.com>2012-05-20 15:28:54 (GMT)
commit4986d525afcddcad6f8610c85cc7d2cf46701ad5 (patch)
tree070cafea4f5f2b6bd2c26a190288a3634f203616 /Source/CPack/cmCPackDocumentVariables.cxx
parentf90223cafc4be83a1556e2d238e2af596afbd616 (diff)
downloadCMake-4986d525afcddcad6f8610c85cc7d2cf46701ad5.zip
CMake-4986d525afcddcad6f8610c85cc7d2cf46701ad5.tar.gz
CMake-4986d525afcddcad6f8610c85cc7d2cf46701ad5.tar.bz2
Use CPACK_xxx and CMAKE_xxx in a consistent way.
CMAKE_xxx vars are now used in the CMake-generated cmake_install.cmake script while CPACK_xxx equivalent vars are used from within CPack. CPack is responsible for getting/forwarding definitions of CPACK_xxxx var corresponding to CMAKE_xxxx when invoking CMake-generated install scripts. As a consequence: CMAKE_ABSOLUTE_DESTINATION_FILES CMAKE_WARN_ON_ABSOLUTE_INSTALL_DESTINATION CMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION may be used from outside CPack as well. e.g. cmake -DCMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION=1 -P cmake_install.cmake works as expected.
Diffstat (limited to 'Source/CPack/cmCPackDocumentVariables.cxx')
-rw-r--r--Source/CPack/cmCPackDocumentVariables.cxx21
1 files changed, 18 insertions, 3 deletions
diff --git a/Source/CPack/cmCPackDocumentVariables.cxx b/Source/CPack/cmCPackDocumentVariables.cxx
index b529480..edbef45 100644
--- a/Source/CPack/cmCPackDocumentVariables.cxx
+++ b/Source/CPack/cmCPackDocumentVariables.cxx
@@ -79,18 +79,33 @@ void cmCPackDocumentVariables::DefineVariables(cmake* cm)
"Variables common to all CPack generators");
cm->DefineProperty
+ ("CPACK_ABSOLUTE_DESTINATION_FILES", cmProperty::VARIABLE,
+ "List of files which have been installed using "
+ " an ABSOLUTE DESTINATION path.",
+ "This variable is a Read-Only variable which is set internally"
+ " by CPack during installation and before packaging using"
+ " CMAKE_ABSOLUTE_DESTINATION_FILES defined in cmake_install.cmake "
+ "scripts. The value can be used within CPack project configuration"
+ " file and/or CPack<GEN>.cmake file of <GEN> generator.", false,
+ "Variables common to all CPack generators");
+
+ cm->DefineProperty
("CPACK_WARN_ON_ABSOLUTE_INSTALL_DESTINATION", cmProperty::VARIABLE,
"Ask CPack to warn each time a file with absolute INSTALL"
" DESTINATION is encountered.",
- "", false,
+ "This variable triggers the definition of "
+ "CMAKE_WARN_ON_ABSOLUTE_INSTALL_DESTINATION when CPack runs"
+ " cmake_install.cmake scripts.", false,
"Variables common to all CPack generators");
cm->DefineProperty
("CPACK_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION", cmProperty::VARIABLE,
"Ask CPack to error out as soon as a file with absolute INSTALL"
- " DESTINATION is encountered",
+ " DESTINATION is encountered.",
"The fatal error is emitted before the installation of "
"the offending file takes place. Some CPack generators, like NSIS,"
- "enforce this internally.", false,
+ "enforce this internally. "
+ "This variable triggers the definition of"
+ "CMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION when CPack runs"
"Variables common to all CPack generators");
}