From 7f97b815ab15c5f9edc480b2ee1abcd1ed0306f8 Mon Sep 17 00:00:00 2001 From: czoido Date: Tue, 30 Jan 2024 11:05:42 +0100 Subject: [PATCH] add docs for cmakeExecutable --- reference/tools/cmake/cmaketoolchain.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/reference/tools/cmake/cmaketoolchain.rst b/reference/tools/cmake/cmaketoolchain.rst index 09b3c6db799a..36cf55b774fc 100644 --- a/reference/tools/cmake/cmaketoolchain.rst +++ b/reference/tools/cmake/cmaketoolchain.rst @@ -90,6 +90,12 @@ translated from the current ``settings``: - Preset names are controlled by the `layout()` `self.folders.build_folder_vars` definition, which can contain a list of settings and options like `["settings.compiler", "settings.arch", "options.shared"]`. + - If CMake is found as a direct `tool_requires` dependency, or if + `tools.cmake:cmake_program` is set, the configure preset will include a + `cmakeExecutable` field. This field represents the path to the CMake executable + to be used for this preset. As stated in the CMake documentation, this field is + reserved for use by IDEs and is not utilized by CMake itself. + - `buildPresets` storing the following information: - The `configurePreset` associated with this build preset.