diff options
| author | Robert Maynard <rmaynard@nvidia.com> | 2021-04-26 15:51:27 (GMT) |
|---|---|---|
| committer | Robert Maynard <rmaynard@nvidia.com> | 2021-04-28 21:22:25 (GMT) |
| commit | a9b968bb9894902e2183a4aea4c23701d5666733 (patch) | |
| tree | b41ad0388074d1ea666f0e210e69ec389f3d2ff7 /Help/manual | |
| parent | 0eb42defc222372b660983ac46ea1266543af7e0 (diff) | |
| download | CMake-a9b968bb9894902e2183a4aea4c23701d5666733.zip CMake-a9b968bb9894902e2183a4aea4c23701d5666733.tar.gz CMake-a9b968bb9894902e2183a4aea4c23701d5666733.tar.bz2 | |
cmake-presets: Introduce `toolchainFile` preset option
In v3 of the presets, the `--toolchain` command line argument now
has a preset mapping.
Diffstat (limited to 'Help/manual')
| -rw-r--r-- | Help/manual/cmake-presets.7.rst | 8 | ||||
| -rw-r--r-- | Help/manual/presets/schema.json | 5 |
2 files changed, 13 insertions, 0 deletions
diff --git a/Help/manual/cmake-presets.7.rst b/Help/manual/cmake-presets.7.rst index 3714004..57c8ccf 100644 --- a/Help/manual/cmake-presets.7.rst +++ b/Help/manual/cmake-presets.7.rst @@ -182,6 +182,14 @@ that may contain the following fields: ignore the field, but the IDE can use them to set up the environment before invoking CMake. +``toolchainFile`` + + An optional string representing the path to the toolchain file. + This field supports `macro expansion`_. If a relative path is specified, + it is calculated relative to the build directory, and if not found, + relative to the source directory. Takes precedence over any `CMAKE_TOOLCHAIN_FILE` + value. This is allowed in preset files specifying version ``3`` or above. + ``binaryDir`` An optional string representing the path to the output binary directory. diff --git a/Help/manual/presets/schema.json b/Help/manual/presets/schema.json index e066362..0d51b1f 100644 --- a/Help/manual/presets/schema.json +++ b/Help/manual/presets/schema.json @@ -87,6 +87,10 @@ "type": "string", "description": "An optional string representing the generator to use for the preset. If generator is not specified, the normal generator discovery procedure is used. Note that for Visual Studio generators, unlike in the command line -G argument, you cannot include the platform name in the generator name. Use the architecture field instead." }, + "toolchainFile": { + "type": "string", + "description": "An optional string representing the path to the toolchain file. This field supports macro expansion. If a relative path is specified, it is calculated relative to the build directory, and if not found, relative to the source directory." + }, "installDir": { "type": "string", "description": "An optional string representing the path to the output binary directory. This field supports macro expansion. If a relative path is specified, it is calculated relative to the source directory. If binaryDir is not specified, it must be inherited from the inherits preset (unless this preset is hidden)." @@ -360,6 +364,7 @@ "generator": {}, "architecture": {}, "toolset": {}, + "toolchainFile": {}, "binaryDir": {}, "installDir": {}, "cmakeExecutable": {}, |