mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-01-04 12:49:36 -06:00
Code Issues Packages Projects Releases Wiki Activity

Help: Move generator toolset support details to variable docs

Browse Source 
Move the details about support for generator toolset specification
to the `CMAKE_GENERATOR_TOOLSET` variable documentation.  This is
a more suitable place because it is shared by all means to set this
variable, not just the `cmake -T` option.
This commit is contained in:
Brad King
2017-03-13 09:58:42 -04:00
parent c750b28220
commit 7df38939f9
2 changed files with 17 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
Help/manual/OPTIONS_BUILD.txt
View File

@@ -48,18 +48,12 @@
build system. Possible generator names are specified in the
:manual:`cmake-generators(7)` manual.
``-T <toolset-name>``
Specify toolset name if supported by generator.
``-T <toolset-spec>``
Toolset specification for the generator, if supported.
Some CMake generators support a toolset name to be given to the
native build system to choose a compiler.
See the :variable:`CMAKE_GENERATOR_TOOLSET` variable.
This is supported only on specific generators:
* :ref:`Visual Studio Generators` for VS 2010 and above
* The :generator:`Xcode` generator for Xcode 3.0 and above
See native build system documentation for allowed toolset names.
Some CMake generators support a toolset specification to tell
the native build system how to choose a compiler. See the
:variable:`CMAKE_GENERATOR_TOOLSET` variable for details.
``-A <platform-name>``
Specify platform name if supported by generator.

17
Help/variable/CMAKE_GENERATOR_TOOLSET.rst
View File

@@ -1,15 +1,22 @@
CMAKE_GENERATOR_TOOLSET
-----------------------
Native build system toolset name specified by user.
Native build system toolset specification provided by user.
Some CMake generators support a toolset name to be given to the native
build system to choose a compiler. If the user specifies a toolset
name (e.g. via the :manual:`cmake(1)` ``-T`` option) the value will be
available in this variable.
Some CMake generators support a toolset specification to tell the
native build system how to choose a compiler. If the user specifies
a toolset (e.g. via the :manual:`cmake(1)` ``-T`` 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`
variable may initialize ``CMAKE_GENERATOR_TOOLSET``. Once a given
build tree has been initialized with a particular value for this
variable, changing the value has undefined behavior.
Toolset specification is supported only on specific generators:
* :ref:`Visual Studio Generators` for VS 2010 and above
* The :generator:`Xcode` generator for Xcode 3.0 and above
See native build system documentation for allowed toolset names.