summaryrefslogtreecommitdiffstats
path: root/Help/command
Commit message (Collapse)AuthorAgeFilesLines
* EXPORT_PACKAGE_DEPENDENCIES: Add experimental feature gateBrad King2024-03-122-2/+10
| | | | | | | Some design concerns have been raised after trying the 3.29 release candidates. Avoid committing to a stable public interface for now. Issue: #25767
* ctest: Allow passing -j without value to choose a contextual defaultBrad King2024-03-101-4/+9
| | | | | | | | | | | | | Under job server integration, added by commit 80fe56c481 (ctest: Add support for running under a make job server on POSIX systems, 2023-11-15, v3.29.0-rc1~324^2), use a very high default so that parallelism is effectively limited only by available job server tokens. Otherwise, choose a default limit based on the number of processors. Also allow passing `0` to specify unbounded parallelism. Fixes: #25739
* Help/add_custom_command: fix verb grammoBen Boeckel2024-02-281-1/+1
|
* Merge topic 'Help-file-ARCHIVE_EXTRACT-mention-working-dir' into release-3.29Brad King2024-02-271-0/+7
|\ | | | | | | | | | | | | 189d28d77d Help/file: mention the working directory for `ARCHIVE_EXTRACT` Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !9291
| * Help/file: mention the working directory for `ARCHIVE_EXTRACT`Ben Boeckel2024-02-271-0/+7
| | | | | | | | See: https://discourse.cmake.org/t/10135
* | Help: Document create_test_sourcelist source path conventionBrad King2024-02-221-0/+5
| | | | | | | | | | Document the change in commit a29ca55b1f (create_test_sourcelist: use the full path to the driver, 2023-12-09, v3.29.0-rc1~264^2).
* | Help: Modernize create_test_sourcelist documentationBrad King2024-02-221-26/+54
|/
* Help: Explicitly discourage absolute install destinationsRobert Maynard2024-02-161-13/+16
| | | | | Document some of the problems caused by absolute install destinations. Encourage use of relative paths.
* Help: Fix example for return commandJohannes Schultz2024-02-151-1/+1
| | | | | `cmake_minimum_required` is the correct command, not `cmake_version_required`.
* Merge topic 'doc-autogen' into release-3.29Brad King2024-02-081-1/+1
|\ | | | | | | | | | | | | | | ccaf529c4e Autogen: Update Documentation 16cc011fa5 cmQtAutoGenGlobalInitializer: Improve Const-correctness Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !9223
| * Autogen: Update DocumentationOrkun Tokdemir2024-02-081-1/+1
| | | | | | | | | | | | | | * Add Qt 6 to documentation * Add explanation about `<ORIGIN>_autogen_timestamp_deps` Fixes: #25201
* | Help: Reword if(EXISTS) suggestion to prefer if(IS_READABLE)Brad King2024-02-061-4/+3
| |
* | Help: Fix cmake_language(EXIT) signature anchorBrad King2024-02-061-5/+0
|/
* Merge topic 'add_custom_command-target-alias'Brad King2024-02-011-0/+3
|\ | | | | | | | | | | | | 3b07ec631d add_custom_command: Allow adding build event via ALIAS target Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !9201
| * add_custom_command: Allow adding build event via ALIAS targetChen Linxuan2024-02-011-0/+3
| | | | | | | | Signed-off-by: Chen Linxuan <me@black-desk.cn>
* | Merge topic 'test-define-prop'Brad King2024-01-301-0/+36
|\ \ | |/ |/| | | | | | | | | | | | | 6c3311d53b Help: Document property redefinition semantics 7aacae4e0e Tests: Add unit tests for property redefinition Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: buildbot <buildbot@kitware.com> Merge-request: !9136
| * Help: Document property redefinition semanticsFeRD (Frank Dana)2024-01-291-0/+36
| | | | | | | | | | | | | | | | | | Add a section to the `define_property()` documentation which details the behavior when attempting to redefine an existing property. (The command is silently ignored.) Provide an example using `get_property()` to examine a property definition created with `define_property()`.
* | Merge topic 'doc-configure_file'Brad King2024-01-271-63/+77
|\ \ | | | | | | | | | | | | | | | | | | | | | 682a513bbb Help: Organize configure_file documentation into sections Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: Craig Scott <craig.scott@crascit.com> Merge-request: !9191
| * | Help: Organize configure_file documentation into sectionsBrad King2024-01-261-63/+77
| | |
* | | ctest_test: add options INCLUDE_FROM_FILE and EXCLUDE_FROM_FILEAlex Neundorf2024-01-251-0/+12
|/ / | | | | | | | | | | | | These options can be used to specify files which can be used to restrict the set of tests that will be executed. Fixes: #25455
* | cmake_language: Add EXIT subcommandleha-bot2024-01-161-0/+23
| | | | | | | | | | | | | | | | | | | | | | | | Add tests to cover these cases: * run as regular CMake module, in NORMAL_MODE (expected to fail); * run as CMake script in SCRIPT_MODE (expected to exit with given code); * run as CMake script that `include()`-s another script with EXIT subcommand; * run as CMake script which EVAL-uates EXIT subcommand via `cmake_language(EVAL CODE "<cmake code>")`. Fixes: #23162
* | file: `STRINGS` + `REGEX` store match resultsCristian Le2024-01-091-0/+5
|/ | | | Signed-off-by: Cristian Le <cristian.le@mpsd.mpg.de>
* Merge topic 'doc-get-properties-inherited'Brad King2024-01-057-34/+32
|\ | | | | | | | | | | | | | | | | | | 8086badba4 Help: Fix wrong return values for unset inherited properties 1ca5ec67b0 Help: Add missing DIRECTORY keyword to set_tests_properties() signature 34379f005b Help: Use <variable> consistently in property getter commands 29ccc9a4cd Help: Use <xxx> for non-keyword arguments in property command signatures Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !9131
| * Help: Fix wrong return values for unset inherited propertiesCraig Scott2024-01-053-22/+16
| | | | | | | | | | | | | | | | | | | | Since ff6234509e (Help: Clarify behavior of INHERITED properties, 2018-03-21), the docs for some get_..._property() commands incorrectly describe the behavior for inherited properties. When a property is not set, even in a parent scope, the returned result from the get_..._property() command is the same whether the property is inherited or not. The docs incorrectly stated that an empty string would be returned for inherited properties in such cases.
| * Help: Add missing DIRECTORY keyword to set_tests_properties() signatureCraig Scott2024-01-051-0/+1
| |
| * Help: Use <variable> consistently in property getter commandsCraig Scott2024-01-053-14/+14
| | | | | | | | | | | | | | | | Property-related commands used a mix of <VAR>, <var>, or <variable> to specify the variable to store the result in. The <VAR> form is particularly confusing, since being uppercase it looks more like a keyword. Use <variable> consistently across all the commands so that the behavior is clear.
| * Help: Use <xxx> for non-keyword arguments in property command signaturesCraig Scott2024-01-055-12/+15
| |
| * Merge topic 'HELP-string_LENGTH-link-error' into release-3.28Brad King2024-01-041-1/+1
| |\ | | | | | | | | | | | | | | | | | | 9702a01dc9 Help: string(LENGTH): Fix synopsis link to command description Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !9113
| * \ Merge topic 'doc-xcframeworks-stubs-apple' into release-3.28Brad King2023-12-131-3/+3
| |\ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | e831eef933 Help: Note case where IMPORTED_IMPLIB isn't needed for (xc)frameworks 01735badee Help: XCFrameworks and stubs are supported on all Apple, not just macOS 6ac50df591 Help: Add missing versionadded directives for IMPORTED_IMPLIB Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !9058
* | \ \ Merge topic 'HELP-string_LENGTH-link-error'Brad King2024-01-041-1/+1
|\ \ \ \ | | |_|/ | |/| | | | | | | | | | | | | | | | | | 9702a01dc9 Help: string(LENGTH): Fix synopsis link to command description Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !9113
| * | | Help: string(LENGTH): Fix synopsis link to command descriptionMarc Chevrier2024-01-031-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | Make the link target explicit to avoid ambiguity with `JSON LENGTH`. Fixes: #25546
* | | | Merge topic 'add_test-CROSSCOMPILING_EMULATOR-exclusive'Brad King2023-12-201-0/+6
|\ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | ca5a300d7f add_test: Honor CROSSCOMPILING_EMULATOR only when cross-compiling Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: buildbot <buildbot@kitware.com> Merge-request: !8947
| * | | | add_test: Honor CROSSCOMPILING_EMULATOR only when cross-compilingRalf Habacker2023-12-191-0/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add policy CMP0158 to provide compatibility for existing projects. Fixes: #23672
* | | | | Help: Fix typo in dependency provider method keywordCraig Scott2023-12-151-1/+1
|/ / / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The cmake.vim file is generated by scanning for keyword-like strings in the docs. Update the corresponding wrong entry there too directly for now, which will fix the wrong entry until the next full regeneration of the file. Fixes: #25503
* | | | Merge topic 'cmake-test-launcher'Brad King2023-12-151-3/+25
|\ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 88863d83d6 fileapi: Add test launcher to codemodel-v2 1ec0372ed4 add_test: Optionally use a launcher for tests running in-project targets 478a5f4e04 fileapi: Make launcher attribute 'arguments' optional b44e38a397 cmFileAPICodemodel: Add missing std::move() Acked-by: Kitware Robot <kwrobot@kitware.com> Tested-by: buildbot <buildbot@kitware.com> Merge-request: !8963
| * | | | add_test: Optionally use a launcher for tests running in-project targetsRalf Habacker2023-12-131-3/+25
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add a `CMAKE_TEST_LAUNCHER` variable and corresponding `TEST_LAUNCHER` target property. Issue: #23672
* | | | | Merge topic 'doc-xcframeworks-stubs-apple'Brad King2023-12-131-3/+3
|\ \ \ \ \ | | |_|_|/ | |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | e831eef933 Help: Note case where IMPORTED_IMPLIB isn't needed for (xc)frameworks 01735badee Help: XCFrameworks and stubs are supported on all Apple, not just macOS 6ac50df591 Help: Add missing versionadded directives for IMPORTED_IMPLIB Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !9058
| * | | | Help: XCFrameworks and stubs are supported on all Apple, not just macOSCraig Scott2023-12-091-3/+3
| | | | |
* | | | | Merge topic 'Help-create_test_sourcelist'Brad King2023-12-121-22/+21
|\ \ \ \ \ | | |_|_|/ | |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 464bc12bb7 Help/create_test_sourcelist: format arguments in the signature docs 131f9c9efa Help/create_test_sourcelist: add formatting markup 8540520902 Help/create_test_sourcelist: reflow prose Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !9059
| * | | | Help/create_test_sourcelist: format arguments in the signature docsBen Boeckel2023-12-101-4/+4
| | | | |
| * | | | Help/create_test_sourcelist: add formatting markupBen Boeckel2023-12-091-7/+7
| | | | |
| * | | | Help/create_test_sourcelist: reflow proseBen Boeckel2023-12-091-18/+17
| |/ / /
* | | | Help: Use signature directive for the 'add_library' commandBrad King2023-12-062-142/+169
| | | | | | | | | | | | | | | | | | | | | | | | This allows individual signatures to be cross-referenced from elsewhere. It also associates with each signature its main documentation via indentation.
* | | | Help: Use signature directive for the 'add_executable' commandBrad King2023-12-061-34/+43
| | | | | | | | | | | | | | | | | | | | | | | | This allows individual signatures to be cross-referenced from elsewhere. It also associates with each signature its main documentation via indentation.
* | | | Help: Fix signature of add_library(<name> INTERFACE EXCLUDE_FROM_ALL)namniav2023-12-041-1/+1
| |/ / |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This signature was added by commit 4391913133 (Add INTERFACE libraries to generated buildsystem if they have SOURCES, 2020-07-20, v3.19.0-rc1~346^2~1) with incorrect documentation. Previously the documented signature as: add_library(<name> INTERFACE [<source>...] [EXCLUDE_FROM_ALL]) which is incorrect. CMake would recognize `EXCLUDE_FROM_ALL` as a source file and report an error that it doesn't exists. The correct signature is: add_library(<name> INTERFACE [EXCLUDE_FROM_ALL] [<source>...]) which places `EXCLUDE_FROM_ALL` in the same position used by the documentation of other signatures. Fixes: #25463
* | | Merge branch 'backport-ci-fedora-39' into ci-fedora-39Brad King2023-11-172-2/+2
|\ \ \ | |/ /
| * | codespell: Fix typosBrad King2023-11-172-2/+2
| | |
* | | Merge topic 'install-export-xcframework'Brad King2023-11-161-0/+13
|\ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 37bc3400cd CMakePackageConfigHelpers: Add generate_apple_platform_selection_file() 256bb0cc40 install(EXPORT): Add ability to point to .xcframework file a90968e044 cmExportBuildFileGenerator: Add structs for target exports Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: Jason Juang <jasjuang@gmail.com> Merge-request: !8969
| * | | install(EXPORT): Add ability to point to .xcframework fileKyle Edwards2023-11-151-0/+13
| | | | | | | | | | | | | | | | Issue: #25262
* | | | Help: Clarify file() command multi-value argument placeholdersBrad King2023-11-151-34/+34
|/ / / | | | | | | | | | Use `<placeholder>...` syntax to imply "zero or more", as we do elsewhere.