diff options
| author | Hong Xu <hong@topbug.net> | 2019-08-02 13:30:39 -0700 |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2019-08-05 10:15:21 -0400 |
| commit | d192caefff3a0a750c7ab86582b08b2b98142f08 (patch) | |
| tree | ebde2be3e8a3e5072e95f8e68657e8fea4097ca2 | |
| parent | 7bacf0233be03100b830e65cdd02a0d1fb2c2a13 (diff) | |
| download | cmake-d192caefff3a0a750c7ab86582b08b2b98142f08.tar.gz | |
CMakeDependentOption: Document that 4th parameter follows if-syntax
| -rw-r--r-- | Help/command/if.rst | 2 | ||||
| -rw-r--r-- | Modules/CMakeDependentOption.cmake | 5 |
2 files changed, 5 insertions, 2 deletions
diff --git a/Help/command/if.rst b/Help/command/if.rst index d8e3a45dad..be992df157 100644 --- a/Help/command/if.rst +++ b/Help/command/if.rst @@ -29,6 +29,8 @@ If used, it must be a verbatim repeat of the argument of the opening ``if`` command. +.. _`Condition Syntax`: + Condition Syntax ^^^^^^^^^^^^^^^^ diff --git a/Modules/CMakeDependentOption.cmake b/Modules/CMakeDependentOption.cmake index 6046d85851..99d5070d68 100644 --- a/Modules/CMakeDependentOption.cmake +++ b/Modules/CMakeDependentOption.cmake @@ -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 option is presented again. Example invocation: -:: +.. code-block:: cmake CMAKE_DEPENDENT_OPTION(USE_FOO "Use Foo" ON "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 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. +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) |