summaryrefslogtreecommitdiffstats
path: root/Help/command/FIND_XXX_ROOT.txt
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2013-10-01 16:37:02 (GMT)
committerBrad King <brad.king@kitware.com>2013-10-16 13:22:38 (GMT)
commit898216137a184940867a1678b07ca8470b2d7b85 (patch)
tree9609a6314708675177dfe3c48ba19f64f0b8e640 /Help/command/FIND_XXX_ROOT.txt
parent30b21860adaefa7493262c41f0b95b4065d46aa3 (diff)
downloadCMake-898216137a184940867a1678b07ca8470b2d7b85.zip
CMake-898216137a184940867a1678b07ca8470b2d7b85.tar.gz
CMake-898216137a184940867a1678b07ca8470b2d7b85.tar.bz2
Help: Factor out find_* command duplication
These documents were represented in the builtin documentation using a common starting point with placeholders substituted by each command. Convert them back to this approach using the reStructuredText include directive and substitutions to avoid duplication.
Diffstat (limited to 'Help/command/FIND_XXX_ROOT.txt')
-rw-r--r--Help/command/FIND_XXX_ROOT.txt14
1 files changed, 14 insertions, 0 deletions
diff --git a/Help/command/FIND_XXX_ROOT.txt b/Help/command/FIND_XXX_ROOT.txt
new file mode 100644
index 0000000..407375a
--- /dev/null
+++ b/Help/command/FIND_XXX_ROOT.txt
@@ -0,0 +1,14 @@
+The CMake variable CMAKE_FIND_ROOT_PATH specifies one or more
+directories to be prepended to all other search directories. This
+effectively "re-roots" the entire search under given locations. By
+default it is empty. It is especially useful when cross-compiling to
+point to the root directory of the target environment and CMake will
+search there too. By default at first the directories listed in
+CMAKE_FIND_ROOT_PATH 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 CMAKE_FIND_ROOT_PATH will not be
+used. If ONLY_CMAKE_FIND_ROOT_PATH is used then only the re-rooted
+directories will be searched.