summaryrefslogtreecommitdiffstats
path: root/Help/command/FIND_XXX_ROOT.txt
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2015-06-08 19:52:21 (GMT)
committerBrad King <brad.king@kitware.com>2015-06-08 19:52:21 (GMT)
commit3de3544fcd38680652d5bbe0790b78477ffa26f1 (patch)
tree0f4a1d06a1cd1983d735cfb8208cb33616c15413 /Help/command/FIND_XXX_ROOT.txt
parent8c64c4783dde25d84b1549945b95d192c1b7fd68 (diff)
downloadCMake-3de3544fcd38680652d5bbe0790b78477ffa26f1.zip
CMake-3de3544fcd38680652d5bbe0790b78477ffa26f1.tar.gz
CMake-3de3544fcd38680652d5bbe0790b78477ffa26f1.tar.bz2
Help: Improve documentation formatting of find_* commands
Use inline reStructuredText markup and add cross-references in more places.
Diffstat (limited to 'Help/command/FIND_XXX_ROOT.txt')
-rw-r--r--Help/command/FIND_XXX_ROOT.txt16
1 files changed, 11 insertions, 5 deletions
diff --git a/Help/command/FIND_XXX_ROOT.txt b/Help/command/FIND_XXX_ROOT.txt
index b5cab68..fab2303 100644
--- a/Help/command/FIND_XXX_ROOT.txt
+++ b/Help/command/FIND_XXX_ROOT.txt
@@ -16,8 +16,14 @@ search there too. By default at first the directories listed in
directory is searched, and then the non-rooted directories will be
searched. The default behavior can be adjusted by setting
|CMAKE_FIND_ROOT_PATH_MODE_XXX|. This behavior can be manually
-overridden on a per-call basis. By using CMAKE_FIND_ROOT_PATH_BOTH
-the search order will be as described above. If
-NO_CMAKE_FIND_ROOT_PATH is used then :variable:`CMAKE_FIND_ROOT_PATH` will not be
-used. If ONLY_CMAKE_FIND_ROOT_PATH is used then only the re-rooted
-directories and directories below :variable:`CMAKE_STAGING_PREFIX` will be searched.
+overridden on a per-call basis using options:
+
+``CMAKE_FIND_ROOT_PATH_BOTH``
+ Search in the order described above.
+
+``NO_CMAKE_FIND_ROOT_PATH``
+ Do not use the :variable:`CMAKE_FIND_ROOT_PATH` variable.
+
+``ONLY_CMAKE_FIND_ROOT_PATH``
+ Search only the re-rooted directories and directories below
+ :variable:`CMAKE_STAGING_PREFIX`.