Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs for cmakeExecutable #3548

Merged
merged 1 commit into from
Jan 30, 2024
Merged

Add docs for cmakeExecutable #3548

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions reference/tools/cmake/cmaketoolchain.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down