summaryrefslogtreecommitdiff
path: root/Help/variable
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2014-09-12 09:55:06 -0400
committerBrad King <brad.king@kitware.com>2014-09-15 10:26:59 -0400
commiteb7d8156492c353f9972bdf6e2203657f5d6592e (patch)
tree30eb3dcc6a09032e14044b6866929f86f6ad5093 /Help/variable
parent09c8ad99433df06ed36791bfaef97996cd2de04e (diff)
downloadcmake-eb7d8156492c353f9972bdf6e2203657f5d6592e.tar.gz
cmake: Add -A option to specify a generator platform
Define the 'cmake -A' option to set CMAKE_GENERATOR_PLATFORM without having to spell out the whole variable name. We choose the name '-A' for "platform" because '-P' is already taken, and in the common use case the "platform" is actually an architecture (e.g. x64). Teach the RunCMake test infrastructure to use -A to pass the generator platform. Extend the RunCMake.GeneratorPlatform test with a case to verify that the -A option cannot be repeated.
Diffstat (limited to 'Help/variable')
-rw-r--r--Help/variable/CMAKE_GENERATOR_PLATFORM.rst2
1 files changed, 2 insertions, 0 deletions
diff --git a/Help/variable/CMAKE_GENERATOR_PLATFORM.rst b/Help/variable/CMAKE_GENERATOR_PLATFORM.rst
index 44d7fc41eb..5809b6af8d 100644
--- a/Help/variable/CMAKE_GENERATOR_PLATFORM.rst
+++ b/Help/variable/CMAKE_GENERATOR_PLATFORM.rst
@@ -5,6 +5,8 @@ Generator-specific target platform name specified by user.
Some CMake generators support a target platform name to be given
to the native build system to choose a compiler toolchain.
+If the user specifies a toolset name (e.g. via the cmake -A option)
+the value will be available in this variable.
The value of this variable should never be modified by project code.
A toolchain file specified by the :variable:`CMAKE_TOOLCHAIN_FILE`