mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-02-23 07:28:51 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge topic 'docopt'

Browse Source 
ee6b429498 Help: Clarify that option() is a boolean

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !7434
This commit is contained in:
Brad King
2022-07-05 21:30:58 +00:00
committed by Kitware Robot
parent 035d6d5251 ee6b429498
commit c3f53b8280
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
Help/command/option.rst
View File

@@ -1,16 +1,18 @@
option
------
Provide an option that the user can optionally select.
Provide a boolean option that the user can optionally select.
.. code-block:: cmake
option(<variable> "<help_text>" [value])
Provides an option for the user to select as ``ON`` or ``OFF``.
If no initial ``<value>`` is provided, ``OFF`` is used.
If no initial ``<value>`` is provided, boolean ``OFF`` is the default value.
If ``<variable>`` is already set as a normal or cache variable,
then the command does nothing (see policy :policy:`CMP0077`).
If you have options that depend on the values of other options, see
For options that depend on the values of other options, see
the module help for :module:`CMakeDependentOption`.
In CMake project mode, a boolean cache variable is created with the option
value. In CMake script mode, a boolean variable is set with the option value.