summaryrefslogtreecommitdiff
path: root/Source/CPack
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2013-09-16 14:38:23 -0400
committerBrad King <brad.king@kitware.com>2013-10-16 09:22:36 -0400
commit399e9c46d88c12507f1a762e69225c5ab9f4ac08 (patch)
treeb220aa74b78aaccdb819e7a4d76a78dea3654b1f /Source/CPack
parent6035c0458e511bae94959ff4e01800dd14384fc2 (diff)
downloadcmake-399e9c46d88c12507f1a762e69225c5ab9f4ac08.tar.gz
Drop builtin property documentation
Drop all DefineProperty calls for non-chained properties. Drop the documentation from the chained ones. The documentation for all properties is now in Help/prop_*/*.rst files.
Diffstat (limited to 'Source/CPack')
-rw-r--r--Source/CPack/cmCPackDocumentVariables.cxx122
-rw-r--r--Source/CPack/cmCPackDocumentVariables.h21
-rw-r--r--Source/CPack/cpack.cxx1
3 files changed, 0 insertions, 144 deletions
diff --git a/Source/CPack/cmCPackDocumentVariables.cxx b/Source/CPack/cmCPackDocumentVariables.cxx
deleted file mode 100644
index 8b16ae985e..0000000000
--- a/Source/CPack/cmCPackDocumentVariables.cxx
+++ /dev/null
@@ -1,122 +0,0 @@
-#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_PACKAGING_INSTALL_PREFIX", cmProperty::VARIABLE,
- "The prefix used in the built package.",
- "Each CPack generator has a default value (like /usr)."
- " This default value may"
- " be overwritten from the CMakeLists.txt or the cpack command line"
- " by setting an alternative value.\n"
- "e.g. "
- " set(CPACK_PACKAGING_INSTALL_PREFIX \"/opt\")\n"
- "This is not the same purpose as CMAKE_INSTALL_PREFIX which"
- " is used when installing from the build tree without building"
- " a package."
- "", false,
- "Variables common to all CPack generators");
-
- cm->DefineProperty
- ("CPACK_INCLUDE_TOPLEVEL_DIRECTORY", cmProperty::VARIABLE,
- "Boolean toggle to include/exclude top level directory.",
- "When preparing a package CPack installs the item under"
- " the so-called top level directory. The purpose of"
- " is to include (set to 1 or ON or TRUE) the top level directory"
- " in the package or not (set to 0 or OFF or FALSE).\n"
- "Each CPack generator has a built-in default value for this"
- " variable. E.g. Archive generators (ZIP, TGZ, ...) includes"
- " the top level whereas RPM or DEB don't. The user may override"
- " the default value by setting this variable.\n"
- "There is a similar variable "
- "CPACK_COMPONENT_INCLUDE_TOPLEVEL_DIRECTORY "
- "which may be used to override the behavior for the component"
- " packaging case which may have different default value for"
- " historical (now backward compatibility) reason.", false,
- "Variables common to all CPack generators");
-
- cm->DefineProperty
- ("CPACK_COMPONENT_INCLUDE_TOPLEVEL_DIRECTORY", cmProperty::VARIABLE,
- "Boolean toggle to include/exclude top level directory "
- "(component case).",
- "Similar usage as CPACK_INCLUDE_TOPLEVEL_DIRECTORY"
- " but for the component case. "
- "See CPACK_INCLUDE_TOPLEVEL_DIRECTORY documentation for"
- " the detail.", false,
- "Variables common to all CPack generators");
-
- cm->DefineProperty
- ("CPACK_SET_DESTDIR", cmProperty::VARIABLE,
- "Boolean toggle to make CPack use DESTDIR mechanism when"
- " packaging.", "DESTDIR means DESTination DIRectory."
- " It is commonly used by makefile "
- "users in order to install software at non-default location. It "
- "is a basic relocation mechanism that should not be used on"
- " Windows (see CMAKE_INSTALL_PREFIX documentation). "
- "It is usually invoked like this:\n"
- " make DESTDIR=/home/john install\n"
- "which will install the concerned software using the"
- " installation prefix, e.g. \"/usr/local\" prepended with "
- "the DESTDIR value which finally gives \"/home/john/usr/local\"."
- " When preparing a package, CPack first installs the items to be "
- "packaged in a local (to the build tree) directory by using the "
- "same DESTDIR mechanism. Nevertheless, if "
- "CPACK_SET_DESTDIR is set then CPack will set DESTDIR before"
- " doing the local install. The most noticeable difference is"
- " that without CPACK_SET_DESTDIR, CPack uses "
- "CPACK_PACKAGING_INSTALL_PREFIX as a prefix whereas with "
- "CPACK_SET_DESTDIR set, CPack will use CMAKE_INSTALL_PREFIX as"
- " a prefix.\n"
- "Manually setting CPACK_SET_DESTDIR may help (or simply be"
- " necessary) if some install rules uses absolute "
- "DESTINATION (see CMake INSTALL command)."
- " However, starting with"
- " CPack/CMake 2.8.3 RPM and DEB installers tries to handle DESTDIR"
- " automatically so that it is seldom necessary for the user to set"
- " it.", false,
- "Variables common to all CPack generators");
-
- cm->DefineProperty
- ("CPACK_INSTALL_SCRIPT", cmProperty::VARIABLE,
- "Extra CMake script provided by the user.",
- "If set this CMake script will be executed by CPack "
- "during its local [CPack-private] installation "
- "which is done right before packaging the files."
- " The script is not called by e.g.: make install.", false,
- "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.",
- "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.",
- "The fatal error is emitted before the installation of "
- "the offending file takes place. Some CPack generators, like NSIS,"
- "enforce this internally. "
- "This variable triggers the definition of"
- "CMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION when CPack runs"
- "Variables common to all CPack generators");
-}
diff --git a/Source/CPack/cmCPackDocumentVariables.h b/Source/CPack/cmCPackDocumentVariables.h
deleted file mode 100644
index e7971be131..0000000000
--- a/Source/CPack/cmCPackDocumentVariables.h
+++ /dev/null
@@ -1,21 +0,0 @@
-/*============================================================================
- CMake - Cross Platform Makefile Generator
- Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
-
- Distributed under the OSI-approved BSD License (the "License");
- see accompanying file Copyright.txt for details.
-
- This software is distributed WITHOUT ANY WARRANTY; without even the
- implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
- See the License for more information.
-============================================================================*/
-#ifndef cmCPackDocumentVariables_h
-#define cmCPackDocumentVariables_h
-class cmake;
-class cmCPackDocumentVariables
-{
-public:
- static void DefineVariables(cmake* cm);
-};
-
-#endif
diff --git a/Source/CPack/cpack.cxx b/Source/CPack/cpack.cxx
index 0a6d8b9335..f8f61394e9 100644
--- a/Source/CPack/cpack.cxx
+++ b/Source/CPack/cpack.cxx
@@ -14,7 +14,6 @@
// Need these for documentation support.
#include "cmake.h"
#include "cmDocumentation.h"
-#include "cmCPackDocumentVariables.h"
#include "cmCPackGeneratorFactory.h"
#include "cmCPackGenerator.h"
#include "cmake.h"