summaryrefslogtreecommitdiffstats
path: root/Help/command/option.rst
diff options
context:
space:
mode:
authorMichael Scott <michael.scott250@gmail.com>2015-06-04 21:51:22 (GMT)
committerBrad King <brad.king@kitware.com>2015-06-08 20:28:31 (GMT)
commitc3f40f4fd98388a2fd31c707e7225d33a7fc76f6 (patch)
tree4b76a32ab9bf416fe1b5d5bd60bc68e1f267b3a7 /Help/command/option.rst
parentd17aa60659a1a69f9101c61a149eca5842291226 (diff)
downloadCMake-c3f40f4fd98388a2fd31c707e7225d33a7fc76f6.zip
CMake-c3f40f4fd98388a2fd31c707e7225d33a7fc76f6.tar.gz
CMake-c3f40f4fd98388a2fd31c707e7225d33a7fc76f6.tar.bz2
Help: Improve formatting of command documentation
Use inline reStructuredText markup and add cross-references in more places.
Diffstat (limited to 'Help/command/option.rst')
-rw-r--r--Help/command/option.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/Help/command/option.rst b/Help/command/option.rst
index 244ed07..91cd0a7 100644
--- a/Help/command/option.rst
+++ b/Help/command/option.rst
@@ -8,8 +8,8 @@ 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.
+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 CMakeDependentOption.
+the module help for :module:`CMakeDependentOption`.