summaryrefslogtreecommitdiffstats
path: root/Help/manual/cmake-presets.7.rst
Commit message (Collapse)AuthorAgeFilesLines
* presets: Expand more macros in the `include` directiveCristian Le2024-02-211-1/+6
| | | | Signed-off-by: Cristian Le <cristian.le@mpsd.mpg.de>
* Help: Document cmake-presets version 8Johel Ernesto Guerrero Peña2023-10-191-0/+3
| | | | | This was accidentally missed in commit f1a7179520 (presets: Add $schema property to JSON schema, 2023-09-07, v3.28.0-rc1~106^2).
* presets: Add $schema property to JSON schemaChenMoFeiJin2023-09-121-0/+9
| | | | | | | Many modern code editors have support for JSON Schema. When you specify the `$schema` property in a JSON file, the editor can provide features like auto-completion, error checking, etc., which can improve your efficiency when writing and modifying the `CMakePresets.json` file.
* presets: add support for macro expansion to includesZoran Angelov2023-04-261-0/+3
| | | | Only `$penv{}` can be expanded when processing includes.
* Help: Add missing vendor field to the workflow presets docsCraig Scott2023-04-151-0/+6
| | | | | | | The JSON schema already allows a vendor field for workflow presets, but it was missed in the documentation. There is no change in behavior or support, this just fixes an oversight in the docs when the workflow presets were originally added.
* presets: Add trace options to configure presetsArtin Alavi2023-03-301-0/+49
| | | | | | Add JSON schema version 7 to support them. Fixes: #22543
* Help: State default preset strategy for architecture and toolsetCraig Scott2022-10-221-0/+3
|
* Help: Use array consistently in presets manualCraig Scott2022-10-221-7/+7
| | | | | | | | When referring to data in a JSON array, use "array" consistently rather than "list". This avoids ambiguity over whether we mean a string containing a CMake list, or a JSON array. Fixes: #24074
* Help: Fix trivial typos related to presetsCraig Scott2022-10-221-1/+1
|
* CTest: Add support for outputJUnitFile in presetsKyle Edwards2022-10-181-0/+6
| | | | Fixes: #22400
* Help: Disambiguate cmake(1) program modes in Sphinx option referencesBrad King2022-10-051-7/+9
| | | | | | Define the entry point to each mode as an option for the `cmake` program, but reference the options for that mode as part of stand-in `cmake-<mode>` programs.
* cmake: Add --workflow modeKyle Edwards2022-09-271-8/+48
| | | | Fixes: #23118
* Help: List packagePresets field in cmake-presets.7Kyle Edwards2022-09-221-0/+4
|
* Help: Add links between cmake-{toolchains,presets}(7)Hinell2022-09-091-2/+8
| | | | Also improve formatting and add `versionadded` markup.
* CPack: Add support for presetsKyle Edwards2022-08-311-3/+137
| | | | Fixes: #23117
* Help: Turn items of presets manual page into description listAlex Turbov2022-08-141-154/+0
| | | | It was an ordinal paragraphs (`<p>`) intermixed with blockquote elements.
* Help: Format `-Werror`/`-Wno-error` in the way it can be referencedAlex Turbov2022-08-141-6/+8
| | | Replace mentions of these options in the presets manual page.
* Help: Use `:option:` role to reference `ctest` optionsAlex Turbov2022-08-141-1/+1
|
* Help: Replace a bunch of more ``--option`` to `:option:` roleAlex Turbov2022-08-041-95/+124
|
* Help: Replace mentions of ``-G`` option with :option:`-G` roleAlex Turbov2022-08-041-3/+3
|
* Help: Document CMake version adding each preset version in cmake-presets(7)Brad King2022-06-011-1/+16
| | | | Fixes: #23485
* cmake-presets: add ${pathListSep} macroErin Melucci2022-05-121-0/+11
| | | | Fixes: #23282
* Merge topic 'ctest_truncate'Brad King2022-03-091-1/+7
|\ | | | | | | | | | | | | | | | | 140704d443 ctest: add option for output truncation 359e5b17d8 presets: bump version to v5 4634de335b cmCTestTestHandler: refactor CleanTestOutput method Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6993
| * ctest: add option for output truncationFrank Winklmeier2022-03-081-0/+6
| | | | | | | | | | | | | | | | | | | | Add `--test-output-truncation` to `ctest`. This option can be used to customize which part of the test output is being truncated. Currently supported values are `tail`, `middle` and `head`. Also add equivalent `CTEST_CUSTOM_TEST_OUTPUT_TRUNCATION` variable. Fixes: #23206
| * presets: bump version to v5Frank Winklmeier2022-03-081-1/+1
| | | | | | | | Prepare for new test preset fields.
* | CMakePresets.json: Add ${fileDir} macroKyle Edwards2022-03-071-0/+5
| | | | | | | | Fixes: #23214
* | Help: Improve wording and structure related to preset includesCraig Scott2022-03-021-42/+64
| | | | | | | | | | | | | | | | | | | | | | 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
* | Help: Clarify how package resolve mode is intended to be usedCarsten Rudolph2022-02-151-3/+4
| | | | | | | | Fixes: #23223
* | cmake --build: prioritize --resolve-package-references over presetCarsten Rudolph2022-02-151-11/+10
|/ | | | Fixes: #23224
* Merge topic 'vs-package-restore'Brad King2022-01-241-0/+36
|\ | | | | | | | | | | | | | | | | | | 9aa7831f05 Presets: add resolve packages setting to build presets. b2f8f0bb87 cmGlobalVisualStudio10Generator: Auto restore NuGet packages. 193b8fca52 cmBuildOptions: Split build arguments into separate object. 6a10103493 Help: Update preset schema description for version 3 entries. Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6761
| * Presets: add resolve packages setting to build presets.Carsten Rudolph2022-01-221-0/+36
| |
* | CMakePresets: Allow files included from CMakePresets.json to be anywhereKyle Edwards2022-01-191-4/+3
|/ | | | | | There are some valid use cases for allowing these files to be outside the project directory. Relax the restriction, and include a strong warning in the documentation.
* CMakePresets: Add include fieldKyle Edwards2022-01-071-3/+25
| | | | Fixes: #21331
* Help: Fix unlinked mention of CMAKE_TOOLCHAIN_FILECraig Scott2021-07-311-2/+3
|
* Help: presets: add note for ExternalProject users with env varsMichael Hirsch2021-06-081-0/+13
| | | | | | | Although this behavior is implied in the existing help text, I think this use case is common and could be puzzling to those who do not thoroughly read the existing help text. I think that warrants a "Note:" on this page.
* Help: links to CMake regex syntaxMichael Hirsch2021-06-021-1/+2
|
* cmake-presets: Introduce `toolchainFile` preset optionRobert Maynard2021-04-281-0/+8
| | | | | In v3 of the presets, the `--toolchain` command line argument now has a preset mapping.
* cmake-presets: Make generator and binaryDir fields optionalfriendlyanon2021-04-061-2/+5
| | | | | | | | 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
* CMakePresets.json: Add matches conditionKyle Edwards2021-03-311-0/+16
|
* CMakePresets.json: Add the ability to conditionally disable presetsKyle Edwards2021-03-221-0/+96
|
* CMakePresets.json: Add ${hostSystemName} macroKyle Edwards2021-03-151-0/+6
|
* Help: Fix version numbers in CMakePresets.json documentationKyle Edwards2021-03-151-5/+6
|
* cmake: configure preset add support for --install-prefix mappingRobert Maynard2021-03-091-0/+6
|
* Revert "Help: Document JSON comment support in cmake-presets(7)"Kyle Edwards2021-02-241-4/+1
| | | | | | Revert commit 8f1e607ed9 (Help: Document JSON comment support in cmake-presets(7), 2021-02-18). The support for comments was a mistake when the feature was implemented in 3.19, and is being removed.
* Help: Clarify preset name conflict rules in cmake-presets(7)Michael Hirsch2021-02-181-8/+9
|
* Merge topic 'preset-json-comments' into release-3.20Brad King2021-02-181-1/+4
|\ | | | | | | | | | | | | 8f1e607ed9 Help: Document JSON comment support in cmake-presets(7) Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !5830
| * Help: Document JSON comment support in cmake-presets(7)Michael Hirsch2021-02-181-1/+4
| |
* | Help: Clarify role of binaryDir inheritance in cmake-presets(7)Brad King2021-02-181-4/+6
| | | | | | | | Suggested-by: Michael Hirsch
* | Help: Link to tool-specific preset arguments from cmake-presets(7)Brad King2021-02-181-6/+7
| | | | | | | | Fixes: #21835
* | Help: Mention version 2 in cmake-presets(7)Brad King2021-02-181-2/+5
|/ | | | | | Version 2 is required for build and test presets. Fixes: #21829
generated by cgit v0.12 at 2025-02-19 12:38:30 (GMT)