From 531c108da1472cde387506172588ddd7e66b4e1d Mon Sep 17 00:00:00 2001 From: Stephen Kelly Date: Tue, 26 Nov 2013 19:48:20 +0100 Subject: [PATCH] Help: Document the CMAKE_TOOLCHAIN_FILE. Link to the new docs from existing references to the variable. --- Help/manual/cmake-variables.7.rst | 1 + Help/variable/CMAKE_LANG_COMPILER_EXTERNAL_TOOLCHAIN.rst | 2 +- Help/variable/CMAKE_LANG_COMPILER_TARGET.rst | 2 +- Help/variable/CMAKE_SYSROOT.rst | 2 +- Help/variable/CMAKE_TOOLCHAIN_FILE.rst | 9 +++++++++ 5 files changed, 13 insertions(+), 3 deletions(-) create mode 100644 Help/variable/CMAKE_TOOLCHAIN_FILE.rst diff --git a/Help/manual/cmake-variables.7.rst b/Help/manual/cmake-variables.7.rst index 4e24823cf..1f6698b4f 100644 --- a/Help/manual/cmake-variables.7.rst +++ b/Help/manual/cmake-variables.7.rst @@ -64,6 +64,7 @@ Variables that Provide Information /variable/CMAKE_STANDARD_LIBRARIES /variable/CMAKE_STATIC_LIBRARY_PREFIX /variable/CMAKE_STATIC_LIBRARY_SUFFIX + /variable/CMAKE_TOOLCHAIN_FILE /variable/CMAKE_TWEAK_VERSION /variable/CMAKE_VERBOSE_MAKEFILE /variable/CMAKE_VERSION diff --git a/Help/variable/CMAKE_LANG_COMPILER_EXTERNAL_TOOLCHAIN.rst b/Help/variable/CMAKE_LANG_COMPILER_EXTERNAL_TOOLCHAIN.rst index 86c0b0e42..033998d0c 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 7c8efee9b..656c57d2b 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 e42e63a22..7aa04506c 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 000000000..e1a65e12b --- /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.