diff options
| author | Brad King <brad.king@kitware.com> | 2019-08-06 13:57:10 (GMT) |
|---|---|---|
| committer | Kitware Robot <kwrobot@kitware.com> | 2019-08-06 13:57:19 (GMT) |
| commit | a09d14bbce9b68f9249b0d2698c3de7eb4114143 (patch) | |
| tree | 088375f685484159c5e4124b6e1475c35f8ef137 /Modules | |
| parent | fdaad9a067e8fa55816d9cef2481450fc5b1f18b (diff) | |
| parent | d192caefff3a0a750c7ab86582b08b2b98142f08 (diff) | |
| download | CMake-a09d14bbce9b68f9249b0d2698c3de7eb4114143.zip CMake-a09d14bbce9b68f9249b0d2698c3de7eb4114143.tar.gz CMake-a09d14bbce9b68f9249b0d2698c3de7eb4114143.tar.bz2 | |
Merge topic 'cmake-dependent-option-doc'
d192caefff CMakeDependentOption: Document that 4th parameter follows if-syntax
Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !3643
Diffstat (limited to 'Modules')
| -rw-r--r-- | Modules/CMakeDependentOption.cmake | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/Modules/CMakeDependentOption.cmake b/Modules/CMakeDependentOption.cmake index 6046d85..99d5070 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) |