summaryrefslogtreecommitdiff
path: root/share/cmake-3.2/Help/command/FIND_XXX_ROOT.txt
diff options
context:
space:
mode:
Diffstat (limited to 'share/cmake-3.2/Help/command/FIND_XXX_ROOT.txt')
-rw-r--r--share/cmake-3.2/Help/command/FIND_XXX_ROOT.txt23
1 files changed, 23 insertions, 0 deletions
diff --git a/share/cmake-3.2/Help/command/FIND_XXX_ROOT.txt b/share/cmake-3.2/Help/command/FIND_XXX_ROOT.txt
new file mode 100644
index 0000000..b5cab68
--- /dev/null
+++ b/share/cmake-3.2/Help/command/FIND_XXX_ROOT.txt
@@ -0,0 +1,23 @@
+The CMake variable :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.
+Paths which are descendants of the :variable:`CMAKE_STAGING_PREFIX` are excluded
+from this re-rooting, because that variable is always a path on the host system.
+By default the :variable:`CMAKE_FIND_ROOT_PATH` is empty.
+
+The :variable:`CMAKE_SYSROOT` variable can also be used to specify exactly one
+directory to use as a prefix. Setting :variable:`CMAKE_SYSROOT` also has other
+effects. See the documentation for that variable for more.
+
+These variables are 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
+:variable:`CMAKE_FIND_ROOT_PATH` are searched, then the :variable:`CMAKE_SYSROOT`
+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.