dilim/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-08-08 08:40:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

CMakeDependentOption: Document that 4th parameter follows if-syntax

Browse Source
This commit is contained in:
Hong Xu
2019-08-02 13:30:39 -07:00
committed by Brad King
parent 7bacf0233b
commit d192caefff
2 changed files with 5 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Help/command/if.rst
View File

@@ -29,6 +29,8 @@ If used, it must be a verbatim
repeat of the argument of the opening repeat of the argument of the opening
``if`` command. ``if`` command.
.. _`Condition Syntax`:
Condition Syntax Condition Syntax
^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^

5
Modules/CMakeDependentOption.cmake
View File

@@ -12,7 +12,7 @@ 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 is used, but any value set by the user is preserved for when the
option is presented again. Example invocation: option is presented again. Example invocation:
:: .. code-block:: cmake
CMAKE_DEPENDENT_OPTION(USE_FOO "Use Foo" ON CMAKE_DEPENDENT_OPTION(USE_FOO "Use Foo" ON
"USE_BAR;NOT USE_ZOT" OFF) "USE_BAR;NOT USE_ZOT" OFF)
@@ -21,7 +21,8 @@ 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 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 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 the USE_FOO option is saved so that when the option is re-enabled it
retains its old value. retains its old value. Each element in the fourth parameter is
evaluated as an if-condition, so :ref:`Condition Syntax` can be used.
#]=======================================================================] #]=======================================================================]
macro(CMAKE_DEPENDENT_OPTION option doc default depends force) macro(CMAKE_DEPENDENT_OPTION option doc default depends force)