summaryrefslogtreecommitdiff
path: root/Modules/CPackComponent.cmake
diff options
context:
space:
mode:
authorDomen Vrankar <domen.vrankar@gmail.com>2017-08-11 20:03:40 +0200
committerDomen Vrankar <domen.vrankar@gmail.com>2017-08-12 10:54:27 +0200
commitd2c9efa9473631b3f1a6df30a4113bc13fc368de (patch)
treefe93f562406b837fcb815c14c697d197dab6336d /Modules/CPackComponent.cmake
parentc47c011c77bfd1bfb8d2060511a2b957ce181c62 (diff)
downloadcmake-d2c9efa9473631b3f1a6df30a4113bc13fc368de.tar.gz
CPack: additional CPACK_COMPONENTS_ALL documentation
Diffstat (limited to 'Modules/CPackComponent.cmake')
-rw-r--r--Modules/CPackComponent.cmake10
1 files changed, 10 insertions, 0 deletions
diff --git a/Modules/CPackComponent.cmake b/Modules/CPackComponent.cmake
index 3a10b9930c..2374fbda8f 100644
--- a/Modules/CPackComponent.cmake
+++ b/Modules/CPackComponent.cmake
@@ -37,6 +37,16 @@
# components defined by the project. The user may set it to only include the
# specified components.
#
+# Instead of specifying all the desired components, it is possible to obtain a
+# list of all defined components and then remove the unwanted ones from the
+# list. The :command:`get_cmake_property` command can be used to obtain the
+# ``COMPONENTS`` property, then the :command:`list(REMOVE_ITEM)` command can be
+# used to remove the unwanted ones. For example, to use all defined components
+# except ``foo`` and ``bar``::
+#
+# get_cmake_property(CPACK_COMPONENTS_ALL COMPONENTS)
+# list(REMOVE_ITEM CPACK_COMPONENTS_ALL "foo" "bar")
+#
# .. variable:: CPACK_<GENNAME>_COMPONENT_INSTALL
#
# Enable/Disable component install for CPack generator <GENNAME>.