summaryrefslogtreecommitdiffstats
path: root/Help/command
Commit message (Collapse)AuthorAgeFilesLines
* Help: block() command: enhance the `PROPAGATE` exampleMarc Chevrier2025-04-281-1/+3
| | | | Fixes: #26902
* Help: Document handling of CPS transitive componentsMatthew Woehlke2025-03-071-0/+34
| | | | | Add documentation explaining how CMake handles component requests of a CPS transitive dependency.
* Help: Fix find_package documentation about CPS and COMPONENTSMatthew Woehlke2025-02-281-24/+21
| | | | | | The recent addition of component handling for CPS neglected to update the documentation of how find_package handles component requests when importing from CPS. Make those changes now.
* Help: add_dependencies requires at least two argumentsBrad King2025-02-201-1/+2
| | | | Update the documentation to match the implementation.
* Help/cmake_minimum_required: clarify policy_max `versionadded` noteBen Boeckel2025-02-181-1/+1
| | | | | | | While the prose clarifies this below, a quick glance at the docs can make one believe that `...3.10` has no sensible use. However, it is still useful to tell CMake 3.12 and up that at least 3.10 behavior is accepted.
* Add CMAKE_POLICY_VERSION_MINIMUM to help configure outdated projectsBrad King2025-02-131-1/+3
| | | | | | | Provide packagers and end users with a way to try configuring projects that have not been updated to set their policy version to a supported level. Closes: #26698
* Help: De-duplicate policy version documentationBrad King2025-02-133-22/+20
|
* Help: Drop cmake_minimum_required pre-2.4 behaviorBrad King2025-02-131-20/+9
| | | | | The long outdated pre-2.4 compatibility behavior is no longer relevant since CMake 4.0 dropped support for pre-3.5 compatibility.
* Merge topic 'find-cps-version' into release-4.0Brad King2025-02-131-24/+95
|\ | | | | | | | | | | | | | | | | | | 3e6466eb16 find_package: Honor version requests when finding CPS packages 7a0e698384 find_package: Fix CPS version parsing 35a7ed125b find_package: Fix reporting of rejected CPS files' version Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: buildbot <buildbot@kitware.com> Merge-request: !10297
| * find_package: Honor version requests when finding CPS packagesMatthew Woehlke2025-02-121-24/+95
| | | | | | | | | | Teach find_package to check a CPS package's version (when provided) against a version request given to the find_package invocation.
* | Merge topic 'instrumentation-build-snippet' into release-4.0Brad King2025-02-121-0/+5
|\ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | c8e319d08c instrumentation: Add experimental notes to docs f777af7734 instrumentation: Update docs for available snippets 2299b2fcab instrumentation: Add build snippet Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: buildbot <buildbot@kitware.com> Merge-request: !10328
| * | instrumentation: Add experimental notes to docsMartin Duffy2025-02-111-0/+5
| | |
* | | Merge topic 'help-find-library' into release-4.0Brad King2025-02-121-2/+4
|\ \ \ | | | | | | | | | | | | | | | | | | | | | | | | 4b7ed0ec79 Help: Clarify find_library() behavior for suffixed libraries Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !10322
| * | | Help: Clarify find_library() behavior for suffixed librariesNikita Nemkin2025-02-111-2/+4
| |/ / | | | | | | | | | | | | | | | | | | The name is used as-is only if it contains a recognized suffix. Clarify this behavior and add links to the relevant variables. Fixes: #18401
* | | Merge topic 'doc-target_link_libraries' into release-4.0Brad King2025-02-121-31/+21
|\ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 1d07da0912 Help: Clarify context of target_link_libraries pre-4.0 behavior documentation b7dc28cb8c Help: Drop target_link_libraries redundant prose on debug/optimized keywords b4bac3018f Help: Drop target_link_libraries mention of CMP0003 and CMP0004 639eee1a0c Help: Call out target_link_libraries legacy signatures earlier Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: Yegor Yefremov <yegorslists@googlemail.com> Merge-request: !10326
| * | | Help: Clarify context of target_link_libraries pre-4.0 behavior documentationBrad King2025-02-111-10/+16
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Update paragraphs that exist only to document pre-4.0 behavior to explicitly state so. Fixes: #26679
| * | | Help: Drop target_link_libraries redundant prose on debug/optimized keywordsBrad King2025-02-111-13/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | This is already documented in the overview, and does not need to be repeated for a specific signature. Issue: #26679
| * | | Help: Drop target_link_libraries mention of CMP0003 and CMP0004Brad King2025-02-111-3/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | These policies have been removed by CMake 4.0 and have not been practically relevant in many years. Issue: #26679
| * | | Help: Call out target_link_libraries legacy signatures earlierBrad King2025-02-111-6/+6
| |/ /
* | | Merge topic 'execute_process-cmd-bat' into release-4.0Brad King2025-02-121-12/+21
|\ \ \ | |/ / |/| | | | | | | | | | | | | | | | | | | | | | | b902fbd0c6 execute_process: Clarify when a Windows command interpreter is used e388ed687a execute_process: Improve invocation of .cmd/.bat with spaces Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: Nikita Nemkin <nikita@nemkin.ru> Acked-by: Alexey Edelev <alexey.edelev@qt.io> Merge-request: !10321
| * | execute_process: Clarify when a Windows command interpreter is usedBrad King2025-02-111-12/+21
| | | | | | | | | | | | | | | We've always executed `.bat` and `.cmd` files through `cmd /c`, but previously it was implicit in undocumented `CreateProcessW` behavior.
| * | execute_process: Improve invocation of .cmd/.bat with spacesBrad King2025-02-111-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Extend the fix from commit 74c9d40876 (execute_process: Fix invocation of .cmd/.bat with spaces, 2025-01-31) to work without relying on conversion to a "short path", which may not exist. Instead, extending the `cmd /c` wrapper to `cmd /c call` seems to support spaces directly. Suggested-by: Alexandru Croitor <alexandru.croitor@qt.io> Fixes: #26655
* | | Merge topic 'instrumentation-doc-fixes' into release-4.0Brad King2025-02-111-3/+4
|\ \ \ | |/ / |/| | | | | | | | | | | | | | | | | 32e9d27c88 instrumentation: Remove undocumented binaryDir field from snippets d88458b5ea instrumentation: Improve documentation for CMake Instrumentation Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !10320
| * | instrumentation: Improve documentation for CMake InstrumentationMartin Duffy2025-02-101-3/+4
| |/
* | Merge topic 'doc-execute_process-CMP0176-version' into release-4.0Brad King2025-02-111-1/+1
|\ \ | |/ |/| | | | | | | | | 5a2c0407b8 Help: Clarify when execute_process ENCODING UTF-8 became the default Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !10316
| * Help: Clarify when execute_process ENCODING UTF-8 became the defaultAJIOB2025-02-101-1/+1
| | | | | | | | | | | | In commit e782811cfe (execute_process: Change default ENCODING to UTF-8, 2024-09-13, v3.31.0-rc1~94^2) we implied this by the version ranges in the older defaults. State it explicitly.
* | Merge topic 'instrumentation-build-hooks'Brad King2025-02-051-3/+5
|\ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | 2680f30caf instrumentation: Allow multiple CALLBACK arguments fc1d55f6a5 instrumentation: Add preBuild and postBuild hooks for ninja f62a4ab2ee instrumentation: Refactor cmInstrumentation constructor and usage c57d1752d4 cmUVProcessChain: Add Detached option for spawning daemons Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !10230
| * | instrumentation: Allow multiple CALLBACK argumentsMartin Duffy2025-02-041-3/+5
| | | | | | | | | | | | | | | Don't require quotes around CALLBACK argument and allow it to be passed multiple times.
* | | Merge topic 'execute_process-cmd-bat'Brad King2025-02-041-2/+10
|\ \ \ | |/ / |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 74c9d40876 execute_process: Fix invocation of .cmd/.bat with spaces 104ca10208 cmWorkerPool: Adopt MaybePrependCmdExe calls to reduce duplication cf7ba6d43d cmWorkerPool: Convert RunCommand signature to move semantics c091fd1420 cmUVProcessChain: Convert AddCommand signature to move semantics c1f6b04176 cmSystemTools: Teach MaybePrependCmdExe to always use backslashes 817b3967f8 cmSystemTools: Teach MaybePrependCmdExe to return GetShortPathNameW failure 611a3000f7 cmSystemTools: Make MaybePrependCmdExe case-insensitive 98fed0f116 cmSystemTools: Adopt MaybePrependCmdExe Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !10270
| * | execute_process: Fix invocation of .cmd/.bat with spacesBrad King2025-02-031-2/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The `CreateProcessW` documentation states "to run a batch file, you must start the command interpreter". Use `cmd /c the.bat` to run batch files. Also, use a "short path" to the `.bat` file if needed to avoid spaces. Previously this worked in some cases only due to undocumented behavior of `CreateProcessW` when given a `.bat` file. Fixes: #26655
* | | Merge topic 'find-cps-components'Brad King2025-02-031-3/+3
|\ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | 894f256a12 find_package: Find CPS components ac20cd43c0 find_package: Fix reporting of transitive dependency errors Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !10262
| * | | find_package: Find CPS componentsMatthew Woehlke2025-02-011-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Implement finding components of CPS packages. Specifically, reject any candidate packages that don't provide all required components, and ignore appendices that don't provide requested (required or optional) components. This applies to both top-level searches and also searching for package dependencies.
* | | | Help: Remove stray spaces and one colonNikita Nemkin2025-01-319-12/+12
| | | |
* | | | Help: Remove accidental blockquotes around listsNikita Nemkin2025-01-316-42/+41
| | | | | | | | | | | | | | | | | | | | | | | | Indenting a list relative to the previous paragraph creates a blockquote. Combined with the natural list indent it results in an overly large left margin.
* | | | Help: Convert some literal blocks into tables and listsNikita Nemkin2025-01-316-51/+36
| |/ / |/| | | | | | | | Also, ensure that header-less tables have a top border in cmake.css.
* | | Merge topic 'msvc-runtime-checks'Brad King2025-01-301-0/+6
|\ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 2b2344b412 MSVC: Add abstraction for runtime checks 49dcd1ce5d Help: Fix MSVC_DEBUG_INFORMATION_FORMAT description of example 2f8e643d9d CMP0141: Fix documentation copied from CMP0091 Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: Alex <leha-bot@yandex.ru> Merge-request: !10214
| * | | MSVC: Add abstraction for runtime checksAJIOB2025-01-291-0/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Replace our hard-coded default for `/RTC1` with a first-class abstraction to select runtime checks from an enumeration of logical names. Add a `MSVC_RUNTIME_CHECKS` target property and corresponding `CMAKE_MSVC_RUNTIME_CHECKS` variable. Removing the old default flag requires a policy because existing projects may rely on string processing to edit them and choose runtime checks under the old behavior. Add policy CMP0184 to provide compatibility. Fixes: #26614
* | | | Help: More syntax highlighting for literal blocksNikita Nemkin2025-01-293-5/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Covers almost all blocks containing actual code, except: * Parsed-literal blocks can't be highlighted, including many command summaries and substitution-heavy docs like find_... commands. This is a Sphinx limitation. * Code with errors, like CMP0049, DEPLOYMENT_ADDITIONAL_FILES, DEPLOYMENT_REMOTE_DIRECTORY, @PACKAGE_INIT@ substitution in the tutorial, bracket arguments/comments in cmake-language.7 and cmake-developer.7. * FindQt4 module, which needs reformatting.
* | | | Merge topic 'patch-lower-case-style'Brad King2025-01-292-3/+3
|\ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 4e6a13f211 Use lower case style for commands Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: buildbot <buildbot@kitware.com> Acked-by: Alex Turbov <i.zaufi@gmail.com> Merge-request: !10245
| * | | | Use lower case style for commandsPeter Kokot2025-01-282-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Where possible this syncs the CS for command names: - check_c_source_compiles() - check_cxx_compiler_flag() - check_cxx_source_compiles() - check_cxx_symbol_exists() - check_include_file_cxx() - check_include_file() - check_include_files() - check_library_exists() - check_source_compiles() - check_struct_has_member() - check_symbol_exists() - check_type_size() - cmake_dependent_option() - cmake_parse_arguments() - feature_summary() - file() - find_package_handle_standard_args() - if(), endif... - install(FILES) - list() - message() - pkg_check_modules() - select_library_configurations() - set_package_info() - test_big_endian()
* | | | | Merge topic 'patch-else'Brad King2025-01-291-0/+3
|\ \ \ \ \ | |/ / / / | | | / / | |_|/ / |/| | | | | | | | | | | | | | | | | | | 9f2efc3270 Remove optional arguments from else() and end*() commands Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: buildbot <buildbot@kitware.com> Acked-by: Alex Turbov <i.zaufi@gmail.com> Merge-request: !10243
| * | | Remove optional arguments from else() and end*() commandsPeter Kokot2025-01-281-0/+3
| | | | | | | | | | | | | | | | | | | | This adds a brief explanation of the optional condition in the `else()` and removes all legacy usages of `else()` and `end*()` commands.
* | | | load_cache: Add note about export()Peter Kokot2025-01-281-0/+9
| | | | | | | | | | | | | | | | | | | | The export() command can be a better option when outside project can be adjusted in such way.
* | | | Merge topic 'patch-load-cache-script-mode'Brad King2025-01-281-0/+5
|\ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 18ae68a97c load_cache: Mention script mode support (-P) Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !10241
| * | | | load_cache: Mention script mode support (-P)Peter Kokot2025-01-271-0/+5
| |/ / / | | | | | | | | | | | | | | | | When using the relevant load_cache(READ_WITH_PREFIX) signature, it also works in script mode (cmake -P ...), unlike the 2nd obsolete signature.
* | | | Merge topic 'fix-typos-found-by-pygrep-hooks'Brad King2025-01-284-12/+12
|\ \ \ \ | |/ / / |/| | | | | | | | | | | | | | | | | | | | | | | bc4c71627a Help: Fix typos found by the `rst-backticks` hook c833629508 Help: Fix typos found by the `rst-directive-colons` hook Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !10237
| * | | Help: Fix typos found by the `rst-backticks` hookAlex Turbov2025-01-264-12/+12
| |/ / | | | | | | | | | | | | | | | | | | The corresponding `pre-commit` configuration is coming in the separate MR. Signed-off-by: Alex Turbov <i.zaufi@gmail.com>
* | | Merge topic 'doc-policy-deprecation-schedule'Brad King2025-01-271-3/+4
|\ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 3e0720a2ae Help: Add cmake_minimum_required(VERSION) example to cmake-policies(7) 085de39879 Help: Document policy transition schedule in cmake-policies(7) 60e302a539 Help: Drop policy scope from cmake-policies(7) 3b926b32e3 Help: Drop CMAKE_MINIMUM_REQUIRED_VERSION from cmake-policies(7) ec9e5feb93 Help: Organize cmake-policies(7) by supported and unsupported policies 6be0fe22be Help: Mention CMAKE_POLICY_DEFAULT_CMP<NNNN> in cmake_minimum_required Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !10222
| * | | Help: Mention CMAKE_POLICY_DEFAULT_CMP<NNNN> in cmake_minimum_requiredBrad King2025-01-231-3/+4
| | | | | | | | | | | | | | | | We already mention it in equivalent text for `cmake_policy`.
* | | | Merge topic 'patch-CMAKE_OBJDUMP'Brad King2025-01-271-2/+2
|\ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | dc7aabf4d0 Help: Document CMAKE_OBJDUMP variable 4bd3519e89 CPack: Avoid mentioning internal CMake module in documentation Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !10224
generated by cgit v0.12 at 2026-01-16 20:43:39 (GMT)