summaryrefslogtreecommitdiff
path: root/Modules/CMakeDependentOption.cmake
diff options
context:
space:
mode:
authorKitware Robot <kwrobot@kitware.com>2013-10-15 11:17:36 -0400
committerBrad King <brad.king@kitware.com>2013-10-15 14:12:03 -0400
commitf051814ed0e63badbfd68049354f36259dbf4b49 (patch)
treef4e6f885f86c882d723a7dd53d2b702d0c7fdffb /Modules/CMakeDependentOption.cmake
parente94958e99c4dec26c86ce8b76d744c04ba960675 (diff)
downloadcmake-f051814ed0e63badbfd68049354f36259dbf4b49.tar.gz
Convert builtin help to reStructuredText source files
Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
Diffstat (limited to 'Modules/CMakeDependentOption.cmake')
-rw-r--r--Modules/CMakeDependentOption.cmake30
1 files changed, 19 insertions, 11 deletions
diff --git a/Modules/CMakeDependentOption.cmake b/Modules/CMakeDependentOption.cmake
index 990728f9f5..7e9f183f11 100644
--- a/Modules/CMakeDependentOption.cmake
+++ b/Modules/CMakeDependentOption.cmake
@@ -1,15 +1,23 @@
-# - Macro to provide an option dependent on other options.
+#.rst:
+# CMakeDependentOption
+# --------------------
+#
+# Macro to provide an option dependent on other options.
+#
# This macro presents an option to the user only if a set of other
-# conditions are true. When the option is not presented a default
-# value is used, but any value set by the user is preserved for when
-# the option is presented again.
-# Example invocation:
-# CMAKE_DEPENDENT_OPTION(USE_FOO "Use Foo" ON
-# "USE_BAR;NOT USE_ZOT" OFF)
-# If USE_BAR is true and USE_ZOT is false, this provides an option called
-# USE_FOO that defaults to ON. Otherwise, it sets USE_FOO to OFF. If
-# the status of USE_BAR or USE_ZOT ever changes, any value for the
-# USE_FOO option is saved so that when the option is re-enabled it
+# conditions are true. When the option is not presented a default value
+# is used, but any value set by the user is preserved for when the
+# option is presented again. Example invocation:
+#
+# ::
+#
+# CMAKE_DEPENDENT_OPTION(USE_FOO "Use Foo" ON
+# "USE_BAR;NOT USE_ZOT" OFF)
+#
+# If USE_BAR is true and USE_ZOT is false, this provides an option
+# called USE_FOO that defaults to ON. Otherwise, it sets USE_FOO to
+# OFF. If the status of USE_BAR or USE_ZOT ever changes, any value for
+# the USE_FOO option is saved so that when the option is re-enabled it
# retains its old value.
#=============================================================================