summaryrefslogtreecommitdiffstats
path: root/Help/variable
diff options
context:
space:
mode:
authorStephen Kelly <steveire@gmail.com>2013-11-26 18:48:20 (GMT)
committerStephen Kelly <steveire@gmail.com>2013-11-27 12:21:12 (GMT)
commit531c108da1472cde387506172588ddd7e66b4e1d (patch)
tree18c686be9726e02c4a5fa32aa28975e5f16bed98 /Help/variable
parentd05e0aa845a99d2a04f61578ba9882ba9a2949c4 (diff)
downloadCMake-531c108da1472cde387506172588ddd7e66b4e1d.zip
CMake-531c108da1472cde387506172588ddd7e66b4e1d.tar.gz
CMake-531c108da1472cde387506172588ddd7e66b4e1d.tar.bz2
Help: Document the CMAKE_TOOLCHAIN_FILE.
Link to the new docs from existing references to the variable.
Diffstat (limited to 'Help/variable')
-rw-r--r--Help/variable/CMAKE_LANG_COMPILER_EXTERNAL_TOOLCHAIN.rst2
-rw-r--r--Help/variable/CMAKE_LANG_COMPILER_TARGET.rst2
-rw-r--r--Help/variable/CMAKE_SYSROOT.rst2
-rw-r--r--Help/variable/CMAKE_TOOLCHAIN_FILE.rst9
4 files changed, 12 insertions, 3 deletions
diff --git a/Help/variable/CMAKE_LANG_COMPILER_EXTERNAL_TOOLCHAIN.rst b/Help/variable/CMAKE_LANG_COMPILER_EXTERNAL_TOOLCHAIN.rst
index 86c0b0e..033998d 100644
--- a/Help/variable/CMAKE_LANG_COMPILER_EXTERNAL_TOOLCHAIN.rst
+++ b/Help/variable/CMAKE_LANG_COMPILER_EXTERNAL_TOOLCHAIN.rst
@@ -10,4 +10,4 @@ may be set to a path to a path to the external toolchain and will be passed
to the compiler driver if supported.
This variable may only be set in a toolchain file specified by
-the ``CMAKE_TOOLCHAIN_FILE`` variable.
+the :variable:`CMAKE_TOOLCHAIN_FILE` variable.
diff --git a/Help/variable/CMAKE_LANG_COMPILER_TARGET.rst b/Help/variable/CMAKE_LANG_COMPILER_TARGET.rst
index 7c8efee..656c57d 100644
--- a/Help/variable/CMAKE_LANG_COMPILER_TARGET.rst
+++ b/Help/variable/CMAKE_LANG_COMPILER_TARGET.rst
@@ -8,4 +8,4 @@ QNX qcc. These compiler drivers support a command-line argument to specify
the target to cross-compile for.
This variable may only be set in a toolchain file specified by
-the ``CMAKE_TOOLCHAIN_FILE`` variable.
+the :variable:`CMAKE_TOOLCHAIN_FILE` variable.
diff --git a/Help/variable/CMAKE_SYSROOT.rst b/Help/variable/CMAKE_SYSROOT.rst
index e42e63a..7aa0450 100644
--- a/Help/variable/CMAKE_SYSROOT.rst
+++ b/Help/variable/CMAKE_SYSROOT.rst
@@ -9,4 +9,4 @@ necessary on installation. The ``CMAKE_SYSROOT`` is also used to prefix
paths searched by the ``find_*`` commands.
This variable may only be set in a toolchain file specified by
-the ``CMAKE_TOOLCHAIN_FILE`` variable.
+the :variable:`CMAKE_TOOLCHAIN_FILE` variable.
diff --git a/Help/variable/CMAKE_TOOLCHAIN_FILE.rst b/Help/variable/CMAKE_TOOLCHAIN_FILE.rst
new file mode 100644
index 0000000..e1a65e1
--- /dev/null
+++ b/Help/variable/CMAKE_TOOLCHAIN_FILE.rst
@@ -0,0 +1,9 @@
+CMAKE_TOOLCHAIN_FILE
+--------------------
+
+Path to toolchain file supplied to :manual:`cmake(1)`.
+
+This variable is specified on the command line when cross-compiling with CMake.
+It is the path to a file which is read early in the CMake run and which specifies
+locations for compilers and toolchain utilities, and other target platform and
+compiler related information.