diff options
Diffstat (limited to 'Help/manual/cmake-presets.7.rst')
| -rw-r--r-- | Help/manual/cmake-presets.7.rst | 38 |
1 files changed, 19 insertions, 19 deletions
diff --git a/Help/manual/cmake-presets.7.rst b/Help/manual/cmake-presets.7.rst index 68e6cb9..62c4b7c 100644 --- a/Help/manual/cmake-presets.7.rst +++ b/Help/manual/cmake-presets.7.rst @@ -130,34 +130,34 @@ Format the ``architecture`` field instead. ``architecture`` + ``toolset`` - An optional string representing the platform name to use for generators - that support platforms. + Optional fields representing the platform and toolset, respectively, for + generators that support them. Each may be either a string or an object + with the following fields: - ``toolset`` + ``value`` - An optional string representing the toolset name to use for generators - that support toolsets. + An optional string representing the value. - ``cmakeGeneratorConfig`` + ``strategy`` - An optional string telling CMake how to handle the ``architecture`` and - ``toolset`` fields. Valid values are: + An optional string telling CMake how to handle the ``architecture`` or + ``toolset`` field. Valid values are: - ``"default"`` + ``"set"`` - Set the platform and toolset using the ``architecture`` and ``toolset`` - fields respectively. On non-Visual Studio generators, this will result - in an error if ``architecture`` or ``toolset`` are set. + Set the respective value. This will result in an error for generators + that do not support the respective field. - ``"ignore"`` + ``"external"`` - Do not set the platform or toolset at all, even on Visual Studio - generators. This is useful if, for example, a preset uses the Ninja - generator, and an IDE knows how to set up the Visual C++ environment - from the ``architecture`` and ``toolset`` fields. In that case, CMake - will ignore ``architecture`` and ``toolset``, but the IDE can use them - to set up the environment before invoking CMake. + Do not set the value, even if the generator supports it. This is + useful if, for example, a preset uses the Ninja generator, and an IDE + knows how to set up the Visual C++ environment from the + ``architecture`` and ``toolset`` fields. In that case, CMake will + ignore the field, but the IDE can use them to set up the environment + before invoking CMake. ``binaryDir`` |