echo/CMake
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Help: Replace mentions of `-T and -A` options with role

Browse Source
This commit is contained in:
Alex Turbov 2022-08-04 12:54:43 +04:00
parent d25b232dee
commit b57f27b087
16 changed files with 35 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Help/envvar/CMAKE_GENERATOR_PLATFORM.rst
View File

@ -6,5 +6,5 @@ CMAKE_GENERATOR_PLATFORM
.. include:: ENV_VAR.txt .. include:: ENV_VAR.txt
Default value for :variable:`CMAKE_GENERATOR_PLATFORM` if no Cache entry Default value for :variable:`CMAKE_GENERATOR_PLATFORM` if no Cache entry
is present and no value is specified by :manual:`cmake(1)` ``-A`` option. is present and no value is specified by :option:`cmake -A` option.
This value is only applied if :envvar:`CMAKE_GENERATOR` is set. This value is only applied if :envvar:`CMAKE_GENERATOR` is set.

2
Help/envvar/CMAKE_GENERATOR_TOOLSET.rst
View File

@ -6,5 +6,5 @@ CMAKE_GENERATOR_TOOLSET
.. include:: ENV_VAR.txt .. include:: ENV_VAR.txt
Default value for :variable:`CMAKE_GENERATOR_TOOLSET` if no Cache entry Default value for :variable:`CMAKE_GENERATOR_TOOLSET` if no Cache entry
is present and no value is specified by :manual:`cmake(1)` ``-T`` option. is present and no value is specified by :option:`cmake -T` option.
This value is only applied if :envvar:`CMAKE_GENERATOR` is set. This value is only applied if :envvar:`CMAKE_GENERATOR` is set.

12
Help/generator/Green Hills MULTI.rst
View File

@ -28,12 +28,12 @@ Otherwise the ``primaryTarget`` will be composed from the values of :variable:`C
and ``GHS_TARGET_PLATFORM``. Defaulting to the value of ``arm_integrity.tgt`` and ``GHS_TARGET_PLATFORM``. Defaulting to the value of ``arm_integrity.tgt``
* The :variable:`CMAKE_GENERATOR_PLATFORM` variable may be set, perhaps * The :variable:`CMAKE_GENERATOR_PLATFORM` variable may be set, perhaps
via the :manual:`cmake(1)` ``-A`` option. via the :option:`cmake -A` option.
| Typical values of ``arm``, ``ppc``, ``86``, etcetera, are used. | Typical values of ``arm``, ``ppc``, ``86``, etcetera, are used.
* The variable ``GHS_TARGET_PLATFORM`` may be set, perhaps via the :manual:`cmake(1)` * The variable ``GHS_TARGET_PLATFORM`` may be set, perhaps via the :option:`cmake -D`
``-D`` option. option.
| Defaults to ``integrity``. | Defaults to ``integrity``.
| Usual values are ``integrity``, ``threadx``, ``uvelosity``, ``velosity``, | Usual values are ``integrity``, ``threadx``, ``uvelosity``, ``velosity``,
@ -55,11 +55,11 @@ The generator searches for the latest compiler or can be given a location to use
``GHS_TOOLSET_ROOT`` is the directory that is checked for the latest compiler. ``GHS_TOOLSET_ROOT`` is the directory that is checked for the latest compiler.
* The :variable:`CMAKE_GENERATOR_TOOLSET` option may be set, perhaps * The :variable:`CMAKE_GENERATOR_TOOLSET` option may be set, perhaps
via the :manual:`cmake(1)` ``-T`` option, to specify the location of the toolset. via the :option:`cmake -T` option, to specify the location of the toolset.
Both absolute and relative paths are valid. Paths are relative to ``GHS_TOOLSET_ROOT``. Both absolute and relative paths are valid. Paths are relative to ``GHS_TOOLSET_ROOT``.
* The variable ``GHS_TOOLSET_ROOT`` may be set, perhaps via the :manual:`cmake(1)` * The variable ``GHS_TOOLSET_ROOT`` may be set, perhaps via the :option:`cmake -D`
``-D`` option. option.
| Root path for toolset searches and relative paths. | Root path for toolset searches and relative paths.
| Defaults to ``C:/ghs`` in Windows or ``/usr/ghs`` in Linux. | Defaults to ``C:/ghs`` in Windows or ``/usr/ghs`` in Linux.

4
Help/generator/Visual Studio 10 2010.rst
View File

@ -27,7 +27,7 @@ The default target platform name (architecture) is ``Win32``.
.. versionadded:: 3.1 .. versionadded:: 3.1
The :variable:`CMAKE_GENERATOR_PLATFORM` variable may be set, perhaps The :variable:`CMAKE_GENERATOR_PLATFORM` variable may be set, perhaps
via the :manual:`cmake(1)` ``-A`` option, to specify a target platform via the :option:`cmake -A` option, to specify a target platform
name (architecture). For example: name (architecture). For example:
* ``cmake -G "Visual Studio 10 2010" -A Win32`` * ``cmake -G "Visual Studio 10 2010" -A Win32``
@ -49,4 +49,4 @@ Toolset Selection
The ``v100`` toolset that comes with Visual Studio 10 2010 is selected by The ``v100`` toolset that comes with Visual Studio 10 2010 is selected by
default. The :variable:`CMAKE_GENERATOR_TOOLSET` option may be set, perhaps default. The :variable:`CMAKE_GENERATOR_TOOLSET` option may be set, perhaps
via the :manual:`cmake(1)` ``-T`` option, to specify another toolset. via the :option:`cmake -T` option, to specify another toolset.

4
Help/generator/Visual Studio 11 2012.rst
View File

@ -20,7 +20,7 @@ The default target platform name (architecture) is ``Win32``.
.. versionadded:: 3.1 .. versionadded:: 3.1
The :variable:`CMAKE_GENERATOR_PLATFORM` variable may be set, perhaps The :variable:`CMAKE_GENERATOR_PLATFORM` variable may be set, perhaps
via the :manual:`cmake(1)` ``-A`` option, to specify a target platform via the :option:`cmake -A` option, to specify a target platform
name (architecture). For example: name (architecture). For example:
* ``cmake -G "Visual Studio 11 2012" -A Win32`` * ``cmake -G "Visual Studio 11 2012" -A Win32``
@ -47,4 +47,4 @@ Toolset Selection
The ``v110`` toolset that comes with Visual Studio 11 2012 is selected by The ``v110`` toolset that comes with Visual Studio 11 2012 is selected by
default. The :variable:`CMAKE_GENERATOR_TOOLSET` option may be set, perhaps default. The :variable:`CMAKE_GENERATOR_TOOLSET` option may be set, perhaps
via the :manual:`cmake(1)` ``-T`` option, to specify another toolset. via the :option:`cmake -T` option, to specify another toolset.

4
Help/generator/Visual Studio 12 2013.rst
View File

@ -20,7 +20,7 @@ The default target platform name (architecture) is ``Win32``.
.. versionadded:: 3.1 .. versionadded:: 3.1
The :variable:`CMAKE_GENERATOR_PLATFORM` variable may be set, perhaps The :variable:`CMAKE_GENERATOR_PLATFORM` variable may be set, perhaps
via the :manual:`cmake(1)` ``-A`` option, to specify a target platform via the :option:`cmake -A` option, to specify a target platform
name (architecture). For example: name (architecture). For example:
* ``cmake -G "Visual Studio 12 2013" -A Win32`` * ``cmake -G "Visual Studio 12 2013" -A Win32``
@ -42,7 +42,7 @@ Toolset Selection
The ``v120`` toolset that comes with Visual Studio 12 2013 is selected by The ``v120`` toolset that comes with Visual Studio 12 2013 is selected by
default. The :variable:`CMAKE_GENERATOR_TOOLSET` option may be set, perhaps default. The :variable:`CMAKE_GENERATOR_TOOLSET` option may be set, perhaps
via the :manual:`cmake(1)` ``-T`` option, to specify another toolset. via the :option:`cmake -T` option, to specify another toolset.
.. |VS_TOOLSET_HOST_ARCH_DEFAULT| replace:: .. |VS_TOOLSET_HOST_ARCH_DEFAULT| replace::
By default this generator uses the 32-bit variant even on a 64-bit host. By default this generator uses the 32-bit variant even on a 64-bit host.

4
Help/generator/Visual Studio 14 2015.rst
View File

@ -18,7 +18,7 @@ Platform Selection
The default target platform name (architecture) is ``Win32``. The default target platform name (architecture) is ``Win32``.
The :variable:`CMAKE_GENERATOR_PLATFORM` variable may be set, perhaps The :variable:`CMAKE_GENERATOR_PLATFORM` variable may be set, perhaps
via the :manual:`cmake(1)` ``-A`` option, to specify a target platform via the :option:`cmake -A` option, to specify a target platform
name (architecture). For example: name (architecture). For example:
* ``cmake -G "Visual Studio 14 2015" -A Win32`` * ``cmake -G "Visual Studio 14 2015" -A Win32``
@ -40,7 +40,7 @@ Toolset Selection
The ``v140`` toolset that comes with Visual Studio 14 2015 is selected by The ``v140`` toolset that comes with Visual Studio 14 2015 is selected by
default. The :variable:`CMAKE_GENERATOR_TOOLSET` option may be set, perhaps default. The :variable:`CMAKE_GENERATOR_TOOLSET` option may be set, perhaps
via the :manual:`cmake(1)` ``-T`` option, to specify another toolset. via the :option:`cmake -T` option, to specify another toolset.
.. |VS_TOOLSET_HOST_ARCH_DEFAULT| replace:: .. |VS_TOOLSET_HOST_ARCH_DEFAULT| replace::
By default this generator uses the 32-bit variant even on a 64-bit host. By default this generator uses the 32-bit variant even on a 64-bit host.

4
Help/generator/Visual Studio 15 2017.rst
View File

@ -26,7 +26,7 @@ Platform Selection
The default target platform name (architecture) is ``Win32``. The default target platform name (architecture) is ``Win32``.
The :variable:`CMAKE_GENERATOR_PLATFORM` variable may be set, perhaps The :variable:`CMAKE_GENERATOR_PLATFORM` variable may be set, perhaps
via the :manual:`cmake(1)` ``-A`` option, to specify a target platform via the :option:`cmake -A` option, to specify a target platform
name (architecture). For example: name (architecture). For example:
* ``cmake -G "Visual Studio 15 2017" -A Win32`` * ``cmake -G "Visual Studio 15 2017" -A Win32``
@ -49,7 +49,7 @@ Toolset Selection
The ``v141`` toolset that comes with Visual Studio 15 2017 is selected by The ``v141`` toolset that comes with Visual Studio 15 2017 is selected by
default. The :variable:`CMAKE_GENERATOR_TOOLSET` option may be set, perhaps default. The :variable:`CMAKE_GENERATOR_TOOLSET` option may be set, perhaps
via the :manual:`cmake(1)` ``-T`` option, to specify another toolset. via the :option:`cmake -T` option, to specify another toolset.
.. |VS_TOOLSET_HOST_ARCH_DEFAULT| replace:: .. |VS_TOOLSET_HOST_ARCH_DEFAULT| replace::
By default this generator uses the 32-bit variant even on a 64-bit host. By default this generator uses the 32-bit variant even on a 64-bit host.

4
Help/generator/Visual Studio 16 2019.rst
View File

@ -25,7 +25,7 @@ The default target platform name (architecture) is that of the host
and is provided in the :variable:`CMAKE_VS_PLATFORM_NAME_DEFAULT` variable. and is provided in the :variable:`CMAKE_VS_PLATFORM_NAME_DEFAULT` variable.
The :variable:`CMAKE_GENERATOR_PLATFORM` variable may be set, perhaps The :variable:`CMAKE_GENERATOR_PLATFORM` variable may be set, perhaps
via the :manual:`cmake(1)` ``-A`` option, to specify a target platform via the :option:`cmake -A` option, to specify a target platform
name (architecture). For example: name (architecture). For example:
* ``cmake -G "Visual Studio 16 2019" -A Win32`` * ``cmake -G "Visual Studio 16 2019" -A Win32``
@ -38,7 +38,7 @@ Toolset Selection
The ``v142`` toolset that comes with Visual Studio 16 2019 is selected by The ``v142`` toolset that comes with Visual Studio 16 2019 is selected by
default. The :variable:`CMAKE_GENERATOR_TOOLSET` option may be set, perhaps default. The :variable:`CMAKE_GENERATOR_TOOLSET` option may be set, perhaps
via the :manual:`cmake(1)` ``-T`` option, to specify another toolset. via the :option:`cmake -T` option, to specify another toolset.
.. |VS_TOOLSET_HOST_ARCH_DEFAULT| replace:: .. |VS_TOOLSET_HOST_ARCH_DEFAULT| replace::
By default this generator uses the 64-bit variant on x64 hosts and By default this generator uses the 64-bit variant on x64 hosts and

4
Help/generator/Visual Studio 17 2022.rst
View File

@ -25,7 +25,7 @@ The default target platform name (architecture) is that of the host
and is provided in the :variable:`CMAKE_VS_PLATFORM_NAME_DEFAULT` variable. and is provided in the :variable:`CMAKE_VS_PLATFORM_NAME_DEFAULT` variable.
The :variable:`CMAKE_GENERATOR_PLATFORM` variable may be set, perhaps The :variable:`CMAKE_GENERATOR_PLATFORM` variable may be set, perhaps
via the :manual:`cmake(1)` ``-A`` option, to specify a target platform via the :option:`cmake -A` option, to specify a target platform
name (architecture). For example: name (architecture). For example:
* ``cmake -G "Visual Studio 17 2022" -A Win32`` * ``cmake -G "Visual Studio 17 2022" -A Win32``
@ -38,7 +38,7 @@ Toolset Selection
The ``v143`` toolset that comes with VS 17 2022 is selected by default. The ``v143`` toolset that comes with VS 17 2022 is selected by default.
The :variable:`CMAKE_GENERATOR_TOOLSET` option may be set, perhaps The :variable:`CMAKE_GENERATOR_TOOLSET` option may be set, perhaps
via the :manual:`cmake(1)` ``-T`` option, to specify another toolset. via the :option:`cmake -T` option, to specify another toolset.
.. |VS_TOOLSET_HOST_ARCH_DEFAULT| replace:: .. |VS_TOOLSET_HOST_ARCH_DEFAULT| replace::
By default this generator uses the 64-bit variant on x64 hosts and By default this generator uses the 64-bit variant on x64 hosts and

2
Help/generator/Visual Studio 9 2008.rst
View File

@ -10,7 +10,7 @@ The default target platform name (architecture) is ``Win32``.
.. versionadded:: 3.1 .. versionadded:: 3.1
The :variable:`CMAKE_GENERATOR_PLATFORM` variable may be set, perhaps The :variable:`CMAKE_GENERATOR_PLATFORM` variable may be set, perhaps
via the :manual:`cmake(1)` ``-A`` option, to specify a target platform via the :option:`cmake -A` option, to specify a target platform
name (architecture). For example: name (architecture). For example:
* ``cmake -G "Visual Studio 9 2008" -A Win32`` * ``cmake -G "Visual Studio 9 2008" -A Win32``

2
Help/generator/Xcode.rst
View File

@ -13,7 +13,7 @@ Toolset and Build System Selection
By default Xcode is allowed to select its own default toolchain. By default Xcode is allowed to select its own default toolchain.
The :variable:`CMAKE_GENERATOR_TOOLSET` option may be set, perhaps The :variable:`CMAKE_GENERATOR_TOOLSET` option may be set, perhaps
via the :manual:`cmake(1)` ``-T`` option, to specify another toolset. via the :option:`cmake -T` option, to specify another toolset.
.. versionadded:: 3.19 .. versionadded:: 3.19
This generator supports toolset specification using one of these forms: This generator supports toolset specification using one of these forms:

13
Help/guide/user-interaction/index.rst
View File

@ -196,7 +196,8 @@ VisualC++ compiler, or a combination of the two:
$ cmake .. -G "Visual Studio 16 2019" $ cmake .. -G "Visual Studio 16 2019"
Visual Studio generators can target different architectures. Visual Studio generators can target different architectures.
One can specify the target architecture using the `-A` option: One can specify the target architecture using the
:option:`-A <cmake -A>` option:
.. code-block:: console .. code-block:: console
@ -223,7 +224,7 @@ files several other options are available to use when
initially running :manual:`cmake(1)`. initially running :manual:`cmake(1)`.
The Visual Studio toolset can be specified with the The Visual Studio toolset can be specified with the
``-T`` option: :option:`cmake -T` option:
.. code-block:: console .. code-block:: console
@ -232,9 +233,9 @@ The Visual Studio toolset can be specified with the
$ # Build targeting Windows XP $ # Build targeting Windows XP
$ cmake.exe .. -G "Visual Studio 16 2019" -A x64 -T v120_xp $ cmake.exe .. -G "Visual Studio 16 2019" -A x64 -T v120_xp
Whereas the ``-A`` option specifies the _target_ Whereas the :option:`-A <cmake -A>` option specifies the _target_
architecture, the ``-T`` option can be used to specify architecture, the :option:`-T <cmake -T>` option can be used to specify
details of the toolchain used. For example, `-Thost=x64` details of the toolchain used. For example, ``-Thost=x64``
can be given to select the 64-bit version of the host can be given to select the 64-bit version of the host
tools. The following demonstrates how to use 64-bit tools. The following demonstrates how to use 64-bit
tools and also build for a 64-bit target architecture: tools and also build for a 64-bit target architecture:
@ -337,7 +338,7 @@ or later on a subsequent invocation of
$ cd build $ cd build
$ cmake . -DCMAKE_BUILD_TYPE=Debug $ cmake . -DCMAKE_BUILD_TYPE=Debug
The ``-U`` flag may be used to unset variables The :option:`-U <cmake -U>` flag may be used to unset variables
on the :manual:`cmake(1)` command line: on the :manual:`cmake(1)` command line:
.. code-block:: console .. code-block:: console

2
Help/variable/CMAKE_GENERATOR_PLATFORM.rst
View File

@ -7,7 +7,7 @@ Generator-specific target platform specification provided by user.
Some CMake generators support a target platform name to be given Some CMake generators support a target platform name to be given
to the native build system to choose a compiler toolchain. to the native build system to choose a compiler toolchain.
If the user specifies a platform name (e.g. via the :manual:`cmake(1)` ``-A`` If the user specifies a platform name (e.g. via the :option:`cmake -A`
option or via the :envvar:`CMAKE_GENERATOR_PLATFORM` environment variable) option or via the :envvar:`CMAKE_GENERATOR_PLATFORM` environment variable)
the value will be available in this variable. the value will be available in this variable.

2
Help/variable/CMAKE_GENERATOR_TOOLSET.rst
View File

@ -5,7 +5,7 @@ Native build system toolset specification provided by user.
Some CMake generators support a toolset specification to tell the Some CMake generators support a toolset specification to tell the
native build system how to choose a compiler. If the user specifies native build system how to choose a compiler. If the user specifies
a toolset (e.g. via the :manual:`cmake(1)` ``-T`` option or via a toolset (e.g. via the :option:`cmake -T` option or via
the :envvar:`CMAKE_GENERATOR_TOOLSET` environment variable) the value the :envvar:`CMAKE_GENERATOR_TOOLSET` environment variable) the value
will be available in this variable. will be available in this variable.

4
Help/variable/CMAKE_XCODE_PLATFORM_TOOLSET.rst
View File

@ -5,5 +5,5 @@ Xcode compiler selection.
:generator:`Xcode` supports selection of a compiler from one of the installed :generator:`Xcode` supports selection of a compiler from one of the installed
toolsets. CMake provides the name of the chosen toolset in this toolsets. CMake provides the name of the chosen toolset in this
variable, if any is explicitly selected (e.g. via the :manual:`cmake(1)` variable, if any is explicitly selected (e.g. via the :option:`cmake -T`
``-T`` option). option).