summaryrefslogtreecommitdiffstats
path: root/Help/manual
Commit message (Collapse)AuthorAgeFilesLines
* Merge topic 'target-runtime-dlls-doc'Kyle Edwards2023-02-091-3/+3
|\ | | | | | | | | | | | | e0335f5830 Help: Update $<TARGET_RUNTIME_DLLS> docs to use cmake -E copy -t Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !8185
| * Help: Update $<TARGET_RUNTIME_DLLS> docs to use cmake -E copy -tKyle Edwards2023-02-081-3/+3
| | | | | | | | | | | | The -t argument was added to support using $<TARGET_RUNTIME_DLLS> in the case that no DLLs are needed. Update the documentation accordingly.
* | Merge topic 'KateImprovements'Brad King2023-02-071-0/+2
|\ \ | |/ |/| | | | | | | | | | | | | | | | | | | e7f7bff4f5 Kate: improve the way the VCS-specific files are searched 96389b4cd3 Kate: add support for hg and fossil 4c32623f5f Help: fix typo in docs for set_property() 9a7612d2d0 Kate: make it possible to force a mode for the "files" entry 8a7aa2642b Help: add documentation for Kate-related variable Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: buildbot <buildbot@kitware.com> Merge-request: !8154
| * Kate: make it possible to force a mode for the "files" entryAlexander Neundorf2023-02-061-0/+1
| | | | | | | | | | | | | | By default, kate will try to autodetect whether the project is a svn or git checkout or not. In case this does not give a satisfying result, the user can now set CMAKE_KATE_FILES_MODE to the mode he wants.
| * Help: add documentation for Kate-related variableAlexander Neundorf2023-02-031-0/+1
| |
* | Help: cmake (1): remove -E server as not availablescivision2023-02-061-4/+0
|/ | | | ... since CMake 3.20
* try_compile: Record propagated CMake variables in configure logBrad King2023-02-011-0/+8
| | | | | | | These provide more detailed information about how the test project was configured. Issue: #23200
* Help: mark the directory properties INTERPROCEDURAL_OPTIMIZATION as deprecatedAlexander Neundorf2023-01-311-2/+2
| | | | | These properties actually never existed, so move the documentation to "Deprecated" and refer to the target properties.
* Merge topic 'doc-rpath-features'Brad King2023-01-251-0/+3
|\ | | | | | | | | | | | | | | | | | | | | | | 434be1256e Help: improve docs for INSTALL_NAME_DIR f784c21567 Help: mention CMAKE_SKIP_RPATH in the RPATH docs 66ad61ba79 Help: improve documentation for BUILD_RPATH 25e7791dc1 Help: improve docs for INSTALL_RPATH 099292f123 Help: improve docs for rpath-related variables Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: buildbot <buildbot@kitware.com> Merge-request: !8073
| * Help: improve docs for INSTALL_NAME_DIRAlexander Neundorf2023-01-201-0/+3
| | | | | | | | | | | | | | INSTALL_NAME_DIR now mentions BUILD_WITH_INSTALL_NAME_DIR. The INSTALL_NAME_DIR, INSTALL_RPATH and $<TARGET_RUNTIME_DLLS:tgt> documentation now mention the other two platforms respectively, to make it easier for developers who are not familiar with all three platforms,
* | message: Add CONFIGURE_LOG mode to record a message in the configure logBrad King2023-01-181-0/+32
| | | | | | | | | | | | | | Provide a replacement for `file(APPEND .../CMake{Output,Error}.log)` that records messages in the configure log. Issue: #23200
* | Help: Document configure log behavior in try_compile and try_runBrad King2023-01-181-0/+4
| |
* | Merge topic 'configure-log'Brad King2023-01-171-2/+22
|\ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 48292c8624 try_compile: Record stack of in-progess checks in configure log d4bf7d80c6 try_compile: Add a NO_LOG option to skip recording in the configure log 9d9e8450a8 try_compile: Add optional LOG_DESCRIPTION to record in configure log 65ed5c2ca8 try_compile: Report underlying error when COPY_FILE fails 0418efb7ad Tests: Add explicit ConfigureLog case to RunCMake.try_compile 189557bd74 cmake: Make entire in-progress check stack available internally 96ce3581ab Help: Clarify backtrace order in cmake-configure-log(7) Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: buildbot <buildbot@kitware.com> Merge-request: !8072
| * | try_compile: Record stack of in-progess checks in configure logBrad King2023-01-161-0/+13
| | | | | | | | | | | | | | | | | | | | | | | | Many `try_compile` and `try_run` calls occur inside check modules between `message(CHECK_START)` and `message(CHECK_{PASS,FAIL})` pairs. Add a field to configure log entries to report this context. Issue: #23200
| * | try_compile: Add optional LOG_DESCRIPTION to record in configure logBrad King2023-01-161-0/+6
| | | | | | | | | | | | Issue: #23200
| * | Help: Clarify backtrace order in cmake-configure-log(7)Brad King2023-01-131-2/+3
| | |
* | | Merge topic 'ctest-no-tests-action-env-var'Brad King2023-01-172-0/+6
|\ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | 0661de58d8 ctest(1): Add CTEST_NO_TESTS_ACTION env var Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: buildbot <buildbot@kitware.com> Merge-request: !8044
| * | | ctest(1): Add CTEST_NO_TESTS_ACTION env varfriendlyanon2023-01-132-0/+6
| | |/ | |/| | | | | | | | | | This environment variable provides a default value for the --no-tests=<action> command line argument.
* | | Merge topic 'doc-header-only'Brad King2023-01-171-1/+1
|\ \ \ | |_|/ |/| | | | | | | | | | | | | | 93696d0f2e Help: Restore cmake-buildsystem(7) header-only library example Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !8071
| * | Help: Restore cmake-buildsystem(7) header-only library exampleBrad King2023-01-131-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Since commit 4391913133 (Add INTERFACE libraries to generated buildsystem if they have SOURCES, 2020-07-20, v3.19.0-rc1~346^2~1) the "Eigen" example in the `cmake-buildsystem(7)` manual is supposed to show a header-only library in which the headers are attached as sources to be edited in IDEs. This was accidentally broken by commit 4b25a0d512 (Help/manual: Update header-only library example, 2022-04-22, v3.24.0-rc1~220^2) when updating the example to use a `FILE_SET`. Fixes: #24319
* | | Merge topic 'fea/add-copy_directory_if_different'Brad King2023-01-131-0/+10
|\ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | c1170b5602 cmake: Add -E copy_directory_if_different Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: buildbot <buildbot@kitware.com> Merge-request: !8059
| * | | cmake: Add -E copy_directory_if_differentRobert Maynard2023-01-121-0/+10
| | |/ | |/| | | | | | | Fixes #21584
* | | FindUnixCommands: Deprecate in favor of cmake -EFeRD (Frank Dana)2023-01-121-1/+1
| | | | | | | | | | | | | | | | | | `${CMAKE_COMMAND} -E` subcommands are cross-platform replacements. Fixes: #24263
* | | Help: Move FindITK/FindVTK to deprecated listFeRD (Frank Dana)2022-12-221-2/+2
|/ / | | | | | | | | | | Both modules have actually been removed entirely, they exist in the Help directory only as "This module used to exist" placeholders.
* | Merge topic 'doc-SYSTEM'Craig Scott2022-12-191-8/+8
|\ \ | | | | | | | | | | | | | | | | | | dfab263825 Help: Clarify and update SYSTEM-related docs Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !8027
| * | Help: Clarify and update SYSTEM-related docsCraig Scott2022-12-171-8/+8
| | |
* | | FileAPI: Add "configureLog" object kindBrad King2022-12-172-0/+49
| | | | | | | | | | | | | | | | | | | | | Provide clients with a way to get a known set of configure log event versions. Issue: #23200
* | | ConfigureLog: Version individual events instead of the whole logBrad King2022-12-161-21/+42
| | | | | | | | | | | | | | | | | | | | | | | | In order to support multiple log versions without buffering the entire log, move versioning to the level of individual events. Multiple versions of an event may then be logged consecutively. Issue: #23200
* | | ConfigureLog: Log try_compile and try_run checksMatthew Woehlke2022-12-161-3/+134
| | | | | | | | | | | | | | | | | | Add configure log events for `try_compile` and `try_run` results. Issue: #23200
* | | ConfigureLog: Add infrastructure for structured configure event loggingMatthew Woehlke2022-12-161-0/+102
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add infrastructure for a "configure log". Use YAML for a balance of machine- and human-readability to records details of configure-time events in a structured format. Teach the RunCMake test framework to support matching the configure log. Issue: #23200
* | | VS: Add a variable to report the Visual Studio version build numberBrad King2022-12-071-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | VS 2017 and above come with a Visual Studio Installer tool that tracks four-component Visual Studio version numbers. We already detect the VS version number because it is needed to make some generation decisions. Provide the number to projects in a `CMAKE_VS_VERSION_BUILD_NUMBER` variable so they can use it similarly. Fixes: #24230
* | | clang-tidy: add <LANG>_CLANG_TIDY_EXPORT_FIXES_DIR propertyKyle Edwards2022-12-062-0/+2
| | | | | | | | | | | | Fixes: #21362
* | | Merge topic 'help-remove-self-reference-links'Brad King2022-11-212-2/+2
|\ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | eb77695e25 Help: clean up some minor typos c36910476a Help: remove links from pages to themselves 391c53a851 Help/prop_tgt/LINK_OPTIONS: fix `:genex:` reference de4909ea16 Help: fix some minor markup errors c42c77b020 Help/CMAKE_GLOBAL_AUTORCC_TARGET_NAME: fix link reference Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !7940
| * | | Help: clean up some minor typosBen Boeckel2022-11-182-2/+2
| | | |
* | | | Merge topic 'lang-std-flag-order'Brad King2022-11-211-0/+22
|\ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | a1c20b08b4 cmLocalGenerator: Inline AddCompilerRequirementFlag in only call site 914571a042 Place language standard flags just after CMAKE_<LANG>_FLAGS ad16ae5c70 VS: Recognize -std: flag in CMAKE_C_FLAGS in target with C++ sources Acked-by: Kitware Robot <kwrobot@kitware.com> Tested-by: buildbot <buildbot@kitware.com> Merge-request: !7931
| * | | | Place language standard flags just after CMAKE_<LANG>_FLAGSBrad King2022-11-181-0/+22
| |/ / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Previously we added the language standard flag near the end of all options, even after those added by `add_compile_options` and friends. However, on some compilers such as MSVC, the `-std` flag may reset defaults for flags that precede it on the command line. Move the language standard flag to before all other flags that CMake adds for other abstractions, and before those added by `add_compile_options`. `CMAKE_<LANG>_FLAGS` should still precede the language flags though, because they are meant to be treated as language-wide modifications to the compiler defaults, similar to `$CC $CFLAGS`. Fixes: #23860 Fixes: #24170
* | | | Merge topic 'cxx-scanning-properties'Brad King2022-11-212-0/+3
|\ \ \ \ | |/ / / |/| | | | | | | | | | | | | | | | | | | | | | | a02d792c6e cxxmodules: add properties to control scanning 008c09d6db cmNinjaTargetGenerator: factor out determining the fileset of a source Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !7935
| * | | cxxmodules: add properties to control scanningBen Boeckel2022-11-182-0/+3
| | | | | | | | | | | | | | | | | | | | | | | | The `CXX_SCAN_FOR_MODULES` property may be used to control scanning for targets and for source files rather than assuming "C++20 always needs to be scanned".
* | | | Merge topic 'build-local-interface-genex'Brad King2022-11-181-0/+7
|\ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 38cbf5e15b Genex: Add $<BUILD_LOCAL_INTERFACE:...> genex 37b5c78688 cmGeneratorExpression: Refactor stripExportInterface() to use enum class Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: buildbot <buildbot@kitware.com> Merge-request: !7919
| * | | | Genex: Add $<BUILD_LOCAL_INTERFACE:...> genexKyle Edwards2022-11-171-0/+7
| |/ / / | | | | | | | | | | | | Fixes: #23209
* | | | Genex: Fix TARGET_PROPERTY lookup scope in transitive usage requirementsBrad King2022-11-171-0/+7
|/ / / | | | | | | | | | | | | | | | | | | | | | | | | | | | When `$<TARGET_PROPERTY:tgt,prop>` is used in an `INTERFACE_*` target property for usage requirements, it may be evaluated in the context of a dependent target in another directory. Look up the `tgt` name in the directory of the target whose property holds the expression so that imported targets isolated to that directory are visible. Fixes: #24163
* | | cmake -E copy: Add support for -t argumentKyle Edwards2022-11-151-5/+9
| | | | | | | | | | | | Fixes: #23543
* | | Merge topic 'doc-improvements'Brad King2022-11-1010-53/+51
|\ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | d4d1f85297 Help: Move a note about arguments and genexes into include file 968224484f Help: Drop unused `PROPERTY_GENEX` replace from `prop_tgt/INTERFACE_*` files 65457e4fae Help: Add _See Also_ sections to related CMake commands c86ec79d07 Help: Use direct refs to genexes instead of ``$<GENEX-NAME>`` 8c6274326d Help: Use CMake highlighting for command synopsis c356a94512 Help: Use monospaced font for a genex name in a section title f98c8707f4 Help: Use `code-block:: cmake` instead of `::` for sub-commands descriptions 2ba351ca4f Help: ``CMake`` → CMake ... Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !7873
| * | | Help: Use direct refs to genexes instead of ``$<GENEX-NAME>``Alex Turbov2022-11-091-4/+4
| | | |
| * | | Help: Use `caption` option of `code-block` for JSON trace format snippetsAlex Turbov2022-11-071-4/+2
| | | |
| * | | Help: Use role `:program:`Alex Turbov2022-11-068-34/+34
| | | | | | | | | | | | | | | | | | | | When mention execitable names use Sphinx semantic role `:program` instead of ``executable`` or **executable**.
| * | | Help: Add some more `:option:` role to `cmake-language(7)` manualAlex Turbov2022-11-051-8/+8
| | | |
| * | | Help: Add `ATTENTION` for comments in the `cmake-language(7)` manualAlex Turbov2022-11-051-3/+3
| | | | | | | | | | | | | | | | | | | | Some editors (OK, mine, I use `kate`) highlight some capitalized "keywords" (like `TODO`, `NOTE`, &etc) in comments.
* | | | Merge topic 'file-set-file-api'Brad King2022-11-091-1/+29
|\ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | b3e9fb67bb file-api: support exporting file set information Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: buildbot <buildbot@kitware.com> Merge-request: !7867
| * | | | file-api: support exporting file set informationBen Boeckel2022-11-081-1/+29
| |/ / / | | | | | | | | | | | | | | | | | | | | | | | | This includes listing the filesets themselves as well as which file set (if any) each source file is associated with. Fixes: #24128