summaryrefslogtreecommitdiff
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2023-03-31 12:41:52 -0400
committerBrad King <brad.king@kitware.com>2023-04-05 12:06:22 -0400
commitf0a67b629192466cec463c41df56ef3244817f70 (patch)
tree631974d37cc909a90034933d8e34cd98bdfd747f /Help
parente259063b0a52768dfb1960401b363437e30baf40 (diff)
downloadcmake-f0a67b629192466cec463c41df56ef3244817f70.tar.gz
VS: Parse comma-separated fields from CMAKE_GENERATOR_PLATFORM
Diffstat (limited to 'Help')
-rw-r--r--Help/variable/CMAKE_GENERATOR_PLATFORM.rst16
1 files changed, 14 insertions, 2 deletions
diff --git a/Help/variable/CMAKE_GENERATOR_PLATFORM.rst b/Help/variable/CMAKE_GENERATOR_PLATFORM.rst
index acb7b2e1a2..0238183d0d 100644
--- a/Help/variable/CMAKE_GENERATOR_PLATFORM.rst
+++ b/Help/variable/CMAKE_GENERATOR_PLATFORM.rst
@@ -29,5 +29,17 @@ See native build system documentation for allowed platform names.
Visual Studio Platform Selection
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-On :ref:`Visual Studio Generators` the selected platform name
-is provided in the :variable:`CMAKE_VS_PLATFORM_NAME` variable.
+The :ref:`Visual Studio Generators` support platform specification
+using one of these forms:
+
+* ``platform``
+* ``platform[,key=value]*``
+* ``key=value[,key=value]*``
+
+The ``platform`` specifies the target platform (VS target architecture),
+such as ``x64``, ``ARM64``, or ``Win32``. The selected platform
+name is provided in the :variable:`CMAKE_VS_PLATFORM_NAME` variable.
+
+The ``key=value`` pairs form a comma-separated list of options to
+specify generator-specific details of the platform selection.
+There are no supported pairs: this syntax is reserved for future use.