summaryrefslogtreecommitdiff
path: root/share/cmake-3.22/Help/command/option.rst
diff options
context:
space:
mode:
Diffstat (limited to 'share/cmake-3.22/Help/command/option.rst')
-rw-r--r--share/cmake-3.22/Help/command/option.rst16
1 files changed, 16 insertions, 0 deletions
diff --git a/share/cmake-3.22/Help/command/option.rst b/share/cmake-3.22/Help/command/option.rst
new file mode 100644
index 0000000..02b8dac
--- /dev/null
+++ b/share/cmake-3.22/Help/command/option.rst
@@ -0,0 +1,16 @@
+option
+------
+
+Provide an 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 ``<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
+the module help for :module:`CMakeDependentOption`.