summaryrefslogtreecommitdiffstats
path: root/Source/CPack/cmCPackDocumentVariables.cxx
diff options
context:
space:
mode:
authorEric NOULARD <eric.noulard@gmail.com>2011-11-13 21:44:53 (GMT)
committerEric NOULARD <eric.noulard@gmail.com>2012-01-22 10:42:49 (GMT)
commitc6a016944211b737c45385423fc7df10462e34ab (patch)
tree3971d56823c84108bbb663360034bba8fd28225d /Source/CPack/cmCPackDocumentVariables.cxx
parenta668c9f059cebad61138511f7e91fbe49a414666 (diff)
downloadCMake-c6a016944211b737c45385423fc7df10462e34ab.zip
CMake-c6a016944211b737c45385423fc7df10462e34ab.tar.gz
CMake-c6a016944211b737c45385423fc7df10462e34ab.tar.bz2
CPack begin the implementation of --help-command* and --help-variables*
This modifications set tries to keep the unified doc for cmake/ctest/cpack while introducing tool specific documentation separated. Some documentation sections for CMake do not fit well to CPack.
Diffstat (limited to 'Source/CPack/cmCPackDocumentVariables.cxx')
-rw-r--r--Source/CPack/cmCPackDocumentVariables.cxx30
1 files changed, 30 insertions, 0 deletions
diff --git a/Source/CPack/cmCPackDocumentVariables.cxx b/Source/CPack/cmCPackDocumentVariables.cxx
new file mode 100644
index 0000000..1c98e7c
--- /dev/null
+++ b/Source/CPack/cmCPackDocumentVariables.cxx
@@ -0,0 +1,30 @@
+#include "cmCPackDocumentVariables.h"
+#include "cmake.h"
+
+void cmCPackDocumentVariables::DefineVariables(cmake* cm)
+{
+ // Subsection: variables defined/used by cpack,
+ // which are common to all CPack generators
+ cm->DefineProperty
+ ("CPACK_PACKAGE_NAME", cmProperty::VARIABLE,
+ "The name of the package (or application).",
+ "If not specified, defaults to the project name."
+ "", false,
+ "Variables common to all CPack generators");
+
+ cm->DefineProperty
+ ("CPACK_PACKAGE_VENDOR", cmProperty::VARIABLE,
+ "The name of the package vendor.",
+ "If not specified, defaults to \"Humanity\"."
+ "", false,
+ "Variables common to all CPack generators");
+
+ // Subsection: variables defined/used by cpack,
+ // which are specific to one CPack generator
+ cm->DefineProperty
+ ("CPACK_RPM_PACKAGE_NAME", cmProperty::VARIABLE,
+ "RPM specific package name.",
+ "If not specified, defaults to CPACK_PACKAGE_NAME."
+ "", false,
+ "Variables specific to a CPack generator");
+}