diff options
| author | Michael Hirsch <scivision@users.noreply.gitlab.kitware.com> | 2022-07-01 11:10:42 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2022-07-05 15:05:54 (GMT) |
| commit | ee6b4294987ff2fd203f8191792ac5f3b701fd4e (patch) | |
| tree | 1caff955503d59c168ef1617da7c6f8d7a7f8ab1 /Help/command/option.rst | |
| parent | 8fd68f9dd34fb3a151d51eaf833433fd3002d0f9 (diff) | |
| download | CMake-ee6b4294987ff2fd203f8191792ac5f3b701fd4e.zip CMake-ee6b4294987ff2fd203f8191792ac5f3b701fd4e.tar.gz CMake-ee6b4294987ff2fd203f8191792ac5f3b701fd4e.tar.bz2 | |
Help: Clarify that option() is a boolean
Also describe `option()` behavior in project vs. script mode.
Diffstat (limited to 'Help/command/option.rst')
| -rw-r--r-- | Help/command/option.rst | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/Help/command/option.rst b/Help/command/option.rst index 02b8dac..464ad44 100644 --- a/Help/command/option.rst +++ b/Help/command/option.rst @@ -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. |