summaryrefslogtreecommitdiff
path: root/Modules/CPackComponent.cmake
diff options
context:
space:
mode:
authorNils Gladitz <nilsgladitz@gmail.com>2016-07-22 08:37:29 +0200
committerNils Gladitz <nilsgladitz@gmail.com>2016-07-22 08:41:22 +0200
commit6f108f84d08a4cc12ef5bafc93d5aad903ba687a (patch)
treebc388672fde93b4894177e9ae30bd1c62fb58c04 /Modules/CPackComponent.cmake
parent811bcf543ceb04f72d0127ac42b7b198be4791dc (diff)
downloadcmake-6f108f84d08a4cc12ef5bafc93d5aad903ba687a.tar.gz
CPackComponent: Document the *_HIDDEN and *_DISABLED variables
Diffstat (limited to 'Modules/CPackComponent.cmake')
-rw-r--r--Modules/CPackComponent.cmake10
1 files changed, 9 insertions, 1 deletions
diff --git a/Modules/CPackComponent.cmake b/Modules/CPackComponent.cmake
index 6a330867e1..25d7d61d42 100644
--- a/Modules/CPackComponent.cmake
+++ b/Modules/CPackComponent.cmake
@@ -75,9 +75,17 @@
#
# The dependencies (list of components) on which this component depends.
#
+# .. variable:: CPACK_COMPONENT_<compName>_HIDDEN
+#
+# True if this component is hidden from the user.
+#
# .. variable:: CPACK_COMPONENT_<compName>_REQUIRED
#
-# True is this component is required.
+# True if this component is required.
+#
+# .. variable:: CPACK_COMPONENT_<compName>_DISABLED
+#
+# True if this component is not selected to be installed by default.
#
# .. command:: cpack_add_component
#