mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-03-13 12:59:55 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge topic 'CMakeDependentOption-doc-improvement' into release-3.23

Browse Source 
7a614977f9 CMakeDependentOption: improve documentation

Acked-by: Kitware Robot <kwrobot@kitware.com>
Acked-by: Rui Oliveira <ruimail24@gmail.com>
Merge-request: !7124
This commit is contained in:
Brad King
2022-03-31 12:46:15 +00:00
committed by Kitware Robot
parent 00677703d0 7a614977f9
commit cc75519e5d
1 changed files with 12 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
Modules/CMakeDependentOption.cmake
View File

@@ -16,13 +16,18 @@ conditions are true.
cmake_dependent_option(<option> "<help_text>" <value> <depends> <force>)
Makes ``<option>`` available to the user if ``<depends>`` is true. When
``<option>`` is available, the given ``<help_text>`` and initial ``<value>``
are used. If the ``<depends>`` condition is not true, ``<option>`` will not be
presented and will always have the value given by ``<force>``. Any value set by
the user is preserved for when the option is presented again. In case ``<depends>``
is a :ref:`semicolon-separated list <CMake Language Lists>`, all elements must
be true in order to initialize ``<option>`` with ``<value>``.
Makes ``<option>`` available to the user if the
:ref:`semicolon-separated list <CMake Language Lists>` of conditions in
``<depends>`` are all true. Otherwise, a local variable named ``<option>``
is set to ``<force>``.
When ``<option>`` is available, the given ``<help_text>`` and initial
``<value>`` are used. Otherwise, any value set by the user is preserved for
when ``<depends>`` is satisfied in the future.
Note that the ``<option>`` variable only has a value which satisfies the
``<depends>`` condition within the scope of the caller because it is a local
variable.
Example invocation: