Commit Graph

6696 Commits

Author SHA1 Message Date
Brad King
d25b7ba192 Merge topic 'doco'
6f354a6d57 Help: ctest(1): emphasize the --test-dir option
f0e60ea867 Help: cmake (1): put modern configure signature first

Acked-by: Kitware Robot <kwrobot@kitware.com>
Acked-by: Alex <leha-bot@yandex.ru>
Merge-request: !8222
2023-02-21 08:50:07 -05:00
Brad King
ad8ada1bee Merge topic 'KateNinjaImprovements'
2b713b0f95 Kate: mention Ninja Multiconfig in the docs
f6f8f89e6c Kate: support for the targets of multi config ninja
0429a37e48 Kate: enable the ninja multiconfig generator for kate

Acked-by: Kitware Robot <kwrobot@kitware.com>
Acked-by: buildbot <buildbot@kitware.com>
Merge-request: !8226
2023-02-21 08:47:00 -05:00
Alexander Neundorf
2b713b0f95 Kate: mention Ninja Multiconfig in the docs 2023-02-20 09:08:56 -05:00
Brad King
d18806e673 Merge topic 'ninja-custom-command-depends'
ea2a05f402 Add variable CMAKE_ADD_CUSTOM_COMMAND_DEPENDS_EXPLICIT_ONLY

Acked-by: Kitware Robot <kwrobot@kitware.com>
Acked-by: buildbot <buildbot@kitware.com>
Merge-request: !8220
2023-02-20 08:34:34 -05:00
scivision
6f354a6d57 Help: ctest(1): emphasize the --test-dir option
it seems few people know of this option
and needlessly add extra shell commands to change directory.
2023-02-18 20:22:23 -05:00
scivision
f0e60ea867 Help: cmake (1): put modern configure signature first
recommend compact, most robust signature first. So many people are
still using the multi-step pre-3.13 way of initializing a build.
Rather than simply

  cmake -Bbuild

which is one step instead of 3 just to configure a new project.
2023-02-18 20:13:40 -05:00
Abdelmaged Khalifa
ea2a05f402 Add variable CMAKE_ADD_CUSTOM_COMMAND_DEPENDS_EXPLICIT_ONLY
Add CMake variable `CMAKE_ADD_CUSTOM_COMMAND_DEPENDS_EXPLICIT_ONLY` to enable
option `DEPENDS_EXPLICIT_ONLY` on all uses of `add_custom_command`.

Fixes: #17097
2023-02-17 17:12:12 +02:00
Brad King
f7be10b26a Merge topic 'ci-linkcheck'
0787148785 gitlab-ci: Report sphinx logs as artifacts of its lint job
14506f49a2 Utilities/Sphinx: Configure linkcheck allowed permanent redirects
3c5b34af9d Help: Replace links with their permanent redirects
1004be159f FindCUDAToolkit: Replace broken links to NVIDIA documentation

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !8210
2023-02-17 08:54:51 -05:00
Brad King
3c5b34af9d Help: Replace links with their permanent redirects 2023-02-17 08:45:01 -05:00
Brad King
51c7917072 Merge topic 'deprecate-extra-generators'
ef5a4d964b Deprecate "extra" generators in favor of cmake-file-api(7)

Acked-by: Kitware Robot <kwrobot@kitware.com>
Acked-by: buildbot <buildbot@kitware.com>
Merge-request: !8211
2023-02-16 11:44:05 -05:00
Brad King
335110627d Merge topic 'testdoc'
6e71c31afd Help:add_test: emphasize important points

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !8212
2023-02-16 11:43:25 -05:00
scivision
6e71c31afd Help:add_test: emphasize important points
* enable_testing must be called to enable testing
* can only set properties on tests created in same directory
* WILL_FAIL still fails on segfault and similar
* compact wording
2023-02-15 16:23:35 -05:00
scivision
bf5512ef51 Help:cmake -E time: note overhead included 2023-02-15 10:53:14 -05:00
Brad King
ef5a4d964b Deprecate "extra" generators in favor of cmake-file-api(7)
The "extra" generators were created in CMake's early years to provide
support for users of specific IDEs by directly generating their project
files alongside make or ninja files.  Nowadays the file-api provides a
more generic, maintainable, well-tested, and robust way for IDEs to view
CMake project build trees.  Deprecate the legacy "extra" generators to
encourage the corresponding IDEs to use the file-api.

Fixes: #19090
2023-02-15 10:48:26 -05:00
Brad King
e2ed34abf8 Merge topic 'ninja-custom-command-depends'
082ccd7530 add_custom_command: Add DEPENDS_EXPLICIT_ONLY option for Ninja

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !8198
2023-02-15 08:57:32 -05:00
scivision
615ba911c4 Help: cmake(1): sleep can have floating point value 2023-02-14 13:38:59 -05:00
scivision
68a46505a3 Help: math: note that floating point inputs are invalid 2023-02-14 13:33:31 -05:00
Abdelmaged Khalifa
082ccd7530 add_custom_command: Add DEPENDS_EXPLICIT_ONLY option for Ninja
Add option `DEPENDS_EXPLICIT_ONLY` to `add_custom_command` to indicate
that implicit dependencies coming from users of the output are not
needed, and only consider dependencies explicitly specified in the
custom command.

Fixes: #17097
2023-02-14 08:56:59 -05:00
Brad King
93edb4d0c0 Merge topic 'deprecate-pre-3.5'
3a4791548d Deprecate compatibility with CMake versions older than 3.5
1edf138506 Tests/RunCMake: Update cmake_minimum_required versions
65a1c379ee Tests/CTestTest*: Update cmake_minimum_required versions
589e6fdcd1 Tests: Update cmake_minimum_required versions in a few tests
3092b14ed0 Tests: Teach RunCMake to optionally ignore policy version deprecation warnings

Acked-by: Kitware Robot <kwrobot@kitware.com>
Acked-by: buildbot <buildbot@kitware.com>
Acked-by: scivision <michael@scivision.dev>
Merge-request: !8192
2023-02-13 09:08:23 -05:00
Brad King
3a4791548d Deprecate compatibility with CMake versions older than 3.5
Issue a deprecation warning on calls to `cmake_minimum_required` or
`cmake_policy` that set policies based on versions older than 3.5.
Note that the effective policy version includes `...<max>` treatment.
Update the check from commit 5845c218d7 (Deprecate compatibility with
CMake versions older than 2.8.12, 2020-06-12, v3.19.0-rc1~629^2).
2023-02-11 06:25:11 -05:00
Brad King
78299083d2 Merge topic 'cmake-gui-browse-manual-page'
b5383bc767 cmake-gui: Add optional filename argument to --browse-manual

Acked-by: Kitware Robot <kwrobot@kitware.com>
Acked-by: buildbot <buildbot@kitware.com>
Merge-request: !8190
2023-02-10 10:03:30 -05:00
Brad King
1d4619953e Merge topic 'doc-configure-log'
2311b0a7f7 Help: Clarify that the documented configure log location is not stable

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !8191
2023-02-09 14:19:42 -05:00
Brad King
2311b0a7f7 Help: Clarify that the documented configure log location is not stable
Issue: #23200
2023-02-09 13:39:49 -05:00
Brad King
bfd01ea357 Merge topic 'clarify-clang-tidy-export-fixes-doc'
f9d9258d5c Help: Avoid making guarantees about <LANG>_CLANG_TIDY_EXPORT_FIXES_DIR

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !8189
2023-02-09 13:23:02 -05:00
Kyle Edwards
f9d9258d5c Help: Avoid making guarantees about <LANG>_CLANG_TIDY_EXPORT_FIXES_DIR
Rather than stating specifically which files may be written or deleted,
simply state that CMake owns the directory and that a dedicated
directory should be used for exporting the fixes.
2023-02-09 11:41:48 -05:00
Kyle Edwards
b5383bc767 cmake-gui: Add optional filename argument to --browse-manual 2023-02-09 11:33:06 -05:00
Brad King
536f35c4f1 Merge topic 'vs9-deprecate'
d7f440c5db Deprecate Visual Studio 9 2008 generator

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !8181
2023-02-09 10:14:10 -05:00
Brad King
df31400648 Merge topic 'doc-find_package-root-case'
20e727a408 Help: Clarify that <PackageName>_ROOT variable names are case-preserved

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !8182
2023-02-09 10:01:52 -05:00
Brad King
0a95c3579b Merge topic 'doc-find_package-root-case' into release-3.26
20e727a408 Help: Clarify that <PackageName>_ROOT variable names are case-preserved

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !8182
2023-02-09 10:01:51 -05:00
Kyle Edwards
07c51e61d4 Merge topic 'target-runtime-dlls-doc'
e0335f5830 Help: Update $<TARGET_RUNTIME_DLLS> docs to use cmake -E copy -t

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !8185
2023-02-09 08:45:39 -05:00
Kyle Edwards
e0335f5830 Help: Update $<TARGET_RUNTIME_DLLS> docs to use cmake -E copy -t
The -t argument was added to support using $<TARGET_RUNTIME_DLLS>
in the case that no DLLs are needed. Update the documentation
accordingly.
2023-02-08 15:10:45 -05:00
Brad King
20e727a408 Help: Clarify that <PackageName>_ROOT variable names are case-preserved
The name comes from the case-preserved first argument to
`find_package`.
2023-02-08 14:06:38 -05:00
Brad King
d7f440c5db Deprecate Visual Studio 9 2008 generator
Update documentation to mark the generator deprecated.  Add a warning at
the end of generation plus an option to turn off the warning.
2023-02-08 11:49:27 -05:00
Brad King
61f271f6ed Merge topic 'feature/sphinx-linkcheck'
6789af36bf Help: Fix broken links found by `linkcheck`
8f4bd3bf7e ci: Check for broken links when build HTML manual

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !8177
2023-02-08 11:44:57 -05:00
Brad King
6736743f09 Merge topic 'doc-FetchContent-catch2'
6d48f48d5d FetchContent: Bump documented example Catch2 to v3.0.1

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !8172
2023-02-08 11:36:26 -05:00
Brad King
c36b18a4b6 Merge topic 'doc-FetchContent-catch2' into release-3.26
6d48f48d5d FetchContent: Bump documented example Catch2 to v3.0.1

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !8172
2023-02-08 11:36:25 -05:00
Brad King
d8f574f35d Merge topic 'doc-cpack-generator-fields'
4cc4be1414 Help: CPack FreeBSD Generator page use field lists
083a57550b Help: CPack DragNDrop Generator page use field lists
2c46fe7c96 Help: CPack Archive Generator page use field lists
5defbf7430 Help: CPack RPM Generator page use field lists
27d45be75d Help: CPack NuGet Generator page use field lists
fbb5ac4735 Help: CPack DEB Generator page use field lists

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !8134
2023-02-08 11:29:52 -05:00
Alex Turbov
6789af36bf Help: Fix broken links found by linkcheck 2023-02-07 23:37:10 +04:00
Eisuke Kawashima
6d48f48d5d FetchContent: Bump documented example Catch2 to v3.0.1
The previous Catch2 v2.13.4 does not compile on some platforms [1].

[1] https://github.com/catchorg/Catch2/issues/2326
2023-02-07 10:54:25 -05:00
Brad King
9492ca9a3f Merge topic 'KateImprovements'
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
2023-02-07 09:48:23 -05:00
Alex Turbov
4cc4be1414 Help: CPack FreeBSD Generator page use field lists 2023-02-07 09:34:58 -05:00
Alex Turbov
083a57550b Help: CPack DragNDrop Generator page use field lists 2023-02-07 09:34:58 -05:00
Alex Turbov
2c46fe7c96 Help: CPack Archive Generator page use field lists 2023-02-07 09:34:58 -05:00
Alex Turbov
5defbf7430 Help: CPack RPM Generator page use field lists 2023-02-07 09:34:58 -05:00
Alex Turbov
27d45be75d Help: CPack NuGet Generator page use field lists 2023-02-07 09:34:58 -05:00
Alex Turbov
fbb5ac4735 Help: CPack DEB Generator page use field lists 2023-02-07 09:34:58 -05:00
Brad King
33a30da3da Merge topic 'docexe' into release-3.26
1e95f765d5 Help: Clarify interaction of execute_process *_FILE and *_VARIABLE options

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !8165
2023-02-07 08:58:48 -05:00
Brad King
5049d86a57 Merge topic 'docexe'
1e95f765d5 Help: Clarify interaction of execute_process *_FILE and *_VARIABLE options

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !8165
2023-02-07 08:58:48 -05:00
Brad King
6cb6a2fabe Merge topic 'docfix'
d3ece40602 Help: cmake (1): remove -E server as not available
b19036d8b3 Help: CheckSource{Compiles,Runs}: fix typo and clarify

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !8164
2023-02-07 08:57:46 -05:00
Alexander Neundorf
96389b4cd3 Kate: add support for hg and fossil
Both VCS are supported by kate nowadays.
2023-02-06 10:22:10 -05:00