From ee6b4294987ff2fd203f8191792ac5f3b701fd4e Mon Sep 17 00:00:00 2001 From: Michael Hirsch Date: Fri, 1 Jul 2022 07:10:42 -0400 Subject: Help: Clarify that option() is a boolean Also describe `option()` behavior in project vs. script mode. --- Help/command/option.rst | 10 ++++++---- 1 file 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( "" [value]) -Provides an option for the user to select as ``ON`` or ``OFF``. -If no initial ```` is provided, ``OFF`` is used. +If no initial ```` is provided, boolean ``OFF`` is the default value. If ```` 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. -- cgit v0.12