Commit Graph

27 Commits

Author SHA1 Message Date
Craig Scott 6404751176 Help: Improve wording and structure related to preset includes
Encourage placing preset includes near the beginning of a preset
file and ensure the example shows that usage. Move the prose
discussing includes to its own section to improve discoverability
and break up paragraphs to make each main point harder to miss.

Also clarify ${sourceDir} to remove any ambiguity with regard to
its meaning in included files.

Issue: #23214
2022-03-02 11:37:57 +11:00
Carsten Rudolph 9aa7831f05 Presets: add resolve packages setting to build presets. 2022-01-22 06:35:41 -05:00
Carsten Rudolph 6a10103493 Help: Update preset schema description for version 3 entries. 2022-01-21 17:41:44 +01:00
Kyle Edwards 26a5512c0f CMakePresets: Add include field
Fixes: #21331
2022-01-06 19:46:41 -05:00
Yonggang Luo 6dc6412477 Help: Use stronger wording in rule about preset inheritance 2021-11-08 17:00:08 -05:00
Sérgio Martins 2114d717a0 Help: Fix preset example cmakeMinimumRequired
Since commit 8bc5c8961e (CMakePresets.json: Add the ability to
conditionally disable presets, 2021-03-10, v3.21.0-rc1~464^2)
the example requires presets version 3 support, which is not
available until CMake 3.21.  CMake 3.20.0 can't open v3 presets.
Make cmakeMinimumRequired compatible with the example's version.
2021-07-12 08:54:04 -04:00
Brad King 09f2f5df89 Merge topic 'extend_toolchain_flag_to_cmake_preset'
a9b968bb98 cmake-presets: Introduce `toolchainFile` preset option

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !6045
2021-05-04 11:54:49 -04:00
Robert Maynard a9b968bb98 cmake-presets: Introduce toolchainFile preset option
In v3 of the presets, the `--toolchain` command line argument now
has a preset mapping.
2021-04-28 17:22:25 -04:00
Robert Maynard 306db0fdb8 cmake-presets: Remove incorrect documentation for installDir 2021-04-27 11:43:30 -04:00
friendlyanon 06e6981336 cmake-presets: Make generator and binaryDir fields optional
In v3 of the presets, generator and buildDir can be omitted to fall
back to regular cmake behavior when these values are not explicitly
provided by the user.

Fixes: #21987
2021-04-07 01:24:44 +02:00
Kyle Edwards 5ac8b923f5 CMakePresets.json: Add matches condition 2021-03-31 10:24:24 -04:00
Brad King 928f4bda30 Merge topic 'cmake-presets-condition'
8bc5c8961e CMakePresets.json: Add the ability to conditionally disable presets
ce6ea7c927 Refactor: Move some common code into separate file
ebbd475e54 Refactor: Move cmCMakePresetsFile::ReadJSON into a separate file

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !5919
2021-03-23 10:33:59 -04:00
Kyle Edwards 8bc5c8961e CMakePresets.json: Add the ability to conditionally disable presets 2021-03-22 15:04:54 -04:00
Adriaan de Groot fae7910268 Help: Fix typos in presets schema field descriptions 2021-03-18 10:09:44 -04:00
Brad King fa1b729b9d Merge branch 'backport-preset-schema-typos' into preset-schema-typos 2021-03-18 10:09:19 -04:00
Adriaan de Groot bda6446e6f Help: Fix typos in presets schema field descriptions 2021-03-18 10:07:09 -04:00
Robert Maynard b227a9565e cmake: configure preset add support for --install-prefix mapping 2021-03-09 13:53:16 -05:00
Michael Hirsch 87b170d9f9 Help: Add build and test preset to examples in cmake-presets(7)
Co-Author: Brad King <brad.king@kitware.com>
2021-02-18 14:53:28 -05:00
Sam Freed 166dc3c46b Help: Add buildPresets and testPresets to JSON schema 2021-01-27 10:20:12 -08:00
Kyle Edwards 64afabdbcb CMakePresets.json: Split cmakeGeneratorConfig field
Make this field separate for both architecture and toolset. Allow
architecture and toolset to be either strings or objects with value
and strategy fields.

Fixes: #21317
2020-10-22 11:24:39 -04:00
Kyle Edwards 920d180047 CMakePresets.json: Allow boolean for cache variable value
Fixes: #21327
2020-10-21 10:37:08 -04:00
Ben McMorran 0307f7c980 Help: Add JSON schema for CMakePresets.json 2020-10-20 12:07:09 -04:00
Kyle Edwards 45766789a0 Help: Add inheritance to CMakePresets.json example 2020-10-19 10:29:19 -04:00
Kyle Edwards efab856008 Help: Show environment field 2020-10-19 10:25:57 -04:00
Kyle Edwards 2208db114c Help: Show multiple ways of doing cacheVariables
This demonstrates both the simple string and the complex object,
and ensures that they get automated testing.
2020-10-19 10:25:57 -04:00
Kyle Edwards d30f85193f Help: Move vendor field into example
This ensures that the vendor field gets automated testing from the
example.
2020-10-19 10:25:57 -04:00
Kyle Edwards 94c955e508 Tests: Test the CMakePresets.json example in the documentation 2020-10-09 15:35:54 -04:00