summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCraig Scott <craig.scott@crascit.com>2017-08-13 10:58:47 (GMT)
committerKitware Robot <kwrobot@kitware.com>2017-08-13 10:59:01 (GMT)
commite6ca528be37e8a1058828e4633a7a382fb035157 (patch)
tree0aa2cd788169936c0f3fb4f2c5bd252c1515350e
parent02f6bb1a812096558c82ff4c8ae0bee3be85a701 (diff)
parentd2c9efa9473631b3f1a6df30a4113bc13fc368de (diff)
downloadCMake-e6ca528be37e8a1058828e4633a7a382fb035157.zip
CMake-e6ca528be37e8a1058828e4633a7a382fb035157.tar.gz
CMake-e6ca528be37e8a1058828e4633a7a382fb035157.tar.bz2
Merge topic 'cpack-CPACK_COMPONENTS_ALL-extra-docs'
d2c9efa9 CPack: additional CPACK_COMPONENTS_ALL documentation Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !1134
-rw-r--r--Modules/CPackComponent.cmake10
1 files changed, 10 insertions, 0 deletions
diff --git a/Modules/CPackComponent.cmake b/Modules/CPackComponent.cmake
index 3a10b99..2374fbd 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>.