kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
CMake/Help/command/option.rst

16 lines
397 B
ReStructuredText
Raw Normal View History

Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
option
------
Provides an option that the user can optionally select.
::
option(<option_variable> "help string describing option"
[initial value])
Help: Improve formatting of command documentation Use inline reStructuredText markup and add cross-references in more places.
2015-06-05 00:51:22 +03:00
Provide an option for the user to select as ``ON`` or ``OFF``. If no
initial value is provided, ``OFF`` is used.
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
If you have options that depend on the values of other options, see
Help: Improve formatting of command documentation Use inline reStructuredText markup and add cross-references in more places.
2015-06-05 00:51:22 +03:00
the module help for :module:`CMakeDependentOption`.