summaryrefslogtreecommitdiffstats
path: root/Help/variable/CMAKE_GENERATOR_PLATFORM.rst
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2017-03-13 13:56:45 (GMT)
committerBrad King <brad.king@kitware.com>2017-03-13 14:36:57 (GMT)
commitc750b28220ebe3cacb087935871c7750758fc225 (patch)
treee829b8760dc40bcd041aa997b77ce2f4d11c58d2 /Help/variable/CMAKE_GENERATOR_PLATFORM.rst
parent10f444a5c6015a10ef0b520c32ad65097facba2b (diff)
downloadCMake-c750b28220ebe3cacb087935871c7750758fc225.zip
CMake-c750b28220ebe3cacb087935871c7750758fc225.tar.gz
CMake-c750b28220ebe3cacb087935871c7750758fc225.tar.bz2
Help: Move generator platform support details to variable docs
Move the details about support for generator platform specification to the `CMAKE_GENERATOR_PLATFORM` variable documentation. This is a more suitable place because it is shared by all means to set this variable, not just the `cmake -A` option.
Diffstat (limited to 'Help/variable/CMAKE_GENERATOR_PLATFORM.rst')
-rw-r--r--Help/variable/CMAKE_GENERATOR_PLATFORM.rst9
1 files changed, 8 insertions, 1 deletions
diff --git a/Help/variable/CMAKE_GENERATOR_PLATFORM.rst b/Help/variable/CMAKE_GENERATOR_PLATFORM.rst
index a5c284a..161ef20 100644
--- a/Help/variable/CMAKE_GENERATOR_PLATFORM.rst
+++ b/Help/variable/CMAKE_GENERATOR_PLATFORM.rst
@@ -1,7 +1,7 @@
CMAKE_GENERATOR_PLATFORM
------------------------
-Generator-specific target platform name specified by user.
+Generator-specific target platform specification provided by user.
Some CMake generators support a target platform name to be given
to the native build system to choose a compiler toolchain.
@@ -13,3 +13,10 @@ A toolchain file specified by the :variable:`CMAKE_TOOLCHAIN_FILE`
variable may initialize ``CMAKE_GENERATOR_PLATFORM``. Once a given
build tree has been initialized with a particular value for this
variable, changing the value has undefined behavior.
+
+Platform specification is supported only on specific generators:
+
+* For :ref:`Visual Studio Generators` with VS 2005 and above this
+ specifies the target architecture.
+
+See native build system documentation for allowed platform names.