diff options
| author | Brad King <brad.king@kitware.com> | 2017-03-13 13:58:42 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2017-03-13 14:36:58 (GMT) |
| commit | 7df38939f9cc21d955c2daf5b6dc2cf70bbfca74 (patch) | |
| tree | f1c7f01cc566fbb7c782a2edf38caf3f9876abf8 | |
| parent | c750b28220ebe3cacb087935871c7750758fc225 (diff) | |
| download | CMake-7df38939f9cc21d955c2daf5b6dc2cf70bbfca74.zip CMake-7df38939f9cc21d955c2daf5b6dc2cf70bbfca74.tar.gz CMake-7df38939f9cc21d955c2daf5b6dc2cf70bbfca74.tar.bz2 | |
Help: Move generator toolset support details to variable docs
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.
| -rw-r--r-- | Help/manual/OPTIONS_BUILD.txt | 16 | ||||
| -rw-r--r-- | Help/variable/CMAKE_GENERATOR_TOOLSET.rst | 17 |
2 files changed, 17 insertions, 16 deletions
diff --git a/Help/manual/OPTIONS_BUILD.txt b/Help/manual/OPTIONS_BUILD.txt index 1dc2a74..e8b87c9 100644 --- a/Help/manual/OPTIONS_BUILD.txt +++ b/Help/manual/OPTIONS_BUILD.txt @@ -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. diff --git a/Help/variable/CMAKE_GENERATOR_TOOLSET.rst b/Help/variable/CMAKE_GENERATOR_TOOLSET.rst index 89abe54..6a24197 100644 --- a/Help/variable/CMAKE_GENERATOR_TOOLSET.rst +++ b/Help/variable/CMAKE_GENERATOR_TOOLSET.rst @@ -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. |