CMake/Help/command/option.rst
Michael Scott c3f40f4fd9 Help: Improve formatting of command documentation
Use inline reStructuredText markup and add cross-references in more
places.
2015-06-08 16:28:31 -04:00

16 lines
397 B
ReStructuredText

option
------
Provides an option that the user can optionally select.
::
option(<option_variable> "help string describing option"
[initial value])
Provide an option for the user to select as ``ON`` or ``OFF``. If no
initial value is provided, ``OFF`` is used.
If you have options that depend on the values of other options, see
the module help for :module:`CMakeDependentOption`.