Commit Graph

6659 Commits

Author SHA1 Message Date
Brad King
7b0c4b060b Merge topic 'doc-cleanup-3.26-rc4' into release-3.26
b39b3e3bdb Help: Fix typos and grammar in 3.26 release notes
9f1360ae19 Help: Improve wording of FOLDER-related properties and policies

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !8264
2023-02-28 08:07:58 -05:00
Craig Scott
b39b3e3bdb
Help: Fix typos and grammar in 3.26 release notes 2023-02-28 21:24:56 +11:00
Craig Scott
9f1360ae19
Help: Improve wording of FOLDER-related properties and policies 2023-02-25 17:15:17 +11:00
Brad King
cf7f6b7165 Help: Document that CMAKE_MODULE_PATH must use forward slashes
Issue: #24240, #24540
2023-02-24 14:36:29 -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
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
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
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
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
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
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
scivision
d3ece40602 Help: cmake (1): remove -E server as not available
... since CMake 3.20
2023-02-06 09:57:57 -05:00
scivision
1e95f765d5 Help: Clarify interaction of execute_process *_FILE and *_VARIABLE options
These parameters are so important that it's worthwhile to be more
explicit about their interaction.

Fixes: #24392
2023-02-06 09:47:52 -05:00
Brad King
e5fee37101 Help: Drop development topic notes to prepare release
Release versions do not have the development topic section of
the CMake Release Notes index page.
2023-02-01 14:42:26 -05:00
Brad King
385435cf78 Help: Organize and revise 3.26 release notes
Add section headers similar to the 3.25 release notes and move each
individual bullet into an appropriate section.  Revise a few bullets.

Add a bullet for `FindImageMagick` that was accidentally left out
when its changes were made.
2023-02-01 14:02:17 -05:00
Brad King
4c63f031c1 Help: Consolidate 3.26 release notes
Run the `Utilities/Release/consolidate-relnotes.bash` script to move
notes from `Help/release/dev/*` into `Help/release/3.26.rst`.
2023-02-01 13:58:23 -05:00
Brad King
bc1ba6d56b Help: Document experimental feature gate affecting CXX_SCAN_FOR_MODULES
Also drop the release note for `CXX_SCAN_FOR_MODULES`, as the rest of
the C++ modules support has not yet been mentioned in release notes
(since it is still experimental).
2023-02-01 13:58:23 -05:00
Brad King
5252c88569 try_compile: Record propagated CMake variables in configure log
These provide more detailed information about how the test project was
configured.

Issue: #23200
2023-02-01 09:32:42 -05:00
Brad King
b2ceca6553 Merge topic 'doc-ipo'
d7c60ab6b0 Help: mark the directory properties INTERPROCEDURAL_OPTIMIZATION as deprecated
6ed026592e Help: improve docs for INTERPROCEDURAL_OPTIMIZATION target property

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !8141
2023-02-01 09:10:38 -05:00
Alexander Neundorf
d7c60ab6b0 Help: mark the directory properties INTERPROCEDURAL_OPTIMIZATION as deprecated
These properties actually never existed, so move the documentation
to "Deprecated" and refer to the target properties.
2023-01-31 09:46:02 -05:00
Alexander Neundorf
6ed026592e Help: improve docs for INTERPROCEDURAL_OPTIMIZATION target property
The documentation now mentions the per-config target property.

Fixes: #24285
2023-01-31 09:45:48 -05:00
Brad King
29fb1367b6 Merge topic 'doc-CMAKE_CUDA_RESOLVE_DEVICE_SYMBOLS'
8c57f7b45e Help: Clarify CMAKE_CUDA_RESOLVE_DEVICE_SYMBOLS behavior

Acked-by: Kitware Robot <kwrobot@kitware.com>
Acked-by: Ben Boeckel <ben.boeckel@kitware.com>
Merge-request: !8136
2023-01-31 09:35:31 -05:00
Robert Maynard
8c57f7b45e Help: Clarify CMAKE_CUDA_RESOLVE_DEVICE_SYMBOLS behavior
Fixes: #24373
2023-01-30 14:45:14 -05:00
Brad King
abddcd370f Help: Clarify add_custom_command OUTPUT relative path behavior
Issue: #24372
2023-01-30 13:50:01 -05:00
Robert Maynard
c89d467bf2 Help: configure_file doc example use target_include_directories
Fixes #24351
2023-01-25 12:30:15 -05:00
Brad King
1d6d10cbf6 Merge topic 'isdir_empty'
a1dc38a567 Help: Document behavior of if(EXISTS,IS_DIRECTORY) for empty paths

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !8109
2023-01-25 11:15:46 -05:00
Brad King
058f7189e1 Merge topic 'doc-rpath-features'
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
2023-01-25 11:14:42 -05:00
scivision
a1dc38a567 Help: Document behavior of if(EXISTS,IS_DIRECTORY) for empty paths
Document and add explicit tests for empty string input:
`if(EXISTS "")` and `if(IS_DIRECTORY "")` are always false.
This avoids need for users to do extra checks due to
CMake non-short-circuit logic as below:

    if("${p}")
      if(EXISTS "${p}")
2023-01-24 14:13:52 -05:00
Brad King
7c241bccc3 Merge topic 'wrap-ninja-multi'
d59ab71779 Help: Wrap long examples in Ninja Multi-Config doc

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !8103
2023-01-24 09:20:14 -05:00
Brad King
f9f34eb111 Merge topic 'improve_supported_language_docs'
b787be2714 Help: Update supported languages in project and enable_language

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !8101
2023-01-23 10:41:41 -05:00
FeRD (Frank Dana)
d59ab71779 Help: Wrap long examples in Ninja Multi-Config doc 2023-01-20 16:33:05 -05:00
Robert Maynard
b787be2714 Help: Update supported languages in project and enable_language 2023-01-20 13:55:38 -05:00
Robert Maynard
2a94c762ed FindCUDAToolkit: Add support for CUDA::nvrtc_static 2023-01-20 12:05:43 -05:00
Alexander Neundorf
434be1256e Help: improve docs for INSTALL_NAME_DIR
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,
2023-01-20 11:28:55 -05:00
Alexander Neundorf
f784c21567 Help: mention CMAKE_SKIP_RPATH in the RPATH docs
CMAKE_SKIP_RPATH is now mentioned in the docs for the BUILD_RPATH
and INSTALL_RPATH target properties.
2023-01-20 11:28:53 -05:00
Alexander Neundorf
66ad61ba79 Help: improve documentation for BUILD_RPATH
Now all properties related to BUILD_RPATH are linked from the
documentation for BUILD_RPATH.
SKIP_BUILD_RPATH now also refers to BUILD_RPATH.
2023-01-20 11:28:06 -05:00
Alexander Neundorf
25e7791dc1 Help: improve docs for INSTALL_RPATH
The documentation for INSTALL_RPATH now links to all (or at least most)
properties (and variables) related to the install rpath, which
should make it easier for users to find out how RPATH works.
Also change "True" to "TRUE"
2023-01-19 22:51:52 +01:00
Alexander Neundorf
099292f123 Help: improve docs for rpath-related variables
Now all RPATH-related variables link to the related
RPATH-related variables. Some also link to the
INSTALL_RPATH and BUILD_RPATH target properties.
2023-01-19 22:51:36 +01:00
Brad King
a429e4b9b1 CYGWIN: Drop pre-2.8.4 compatibility mode CMAKE_LEGACY_CYGWIN_WIN32
Prior to CMake 2.8.4 (released in 2011), we defined `WIN32` on CYGWIN.
That was removed, but an undocumented `CMAKE_LEGACY_CYGWIN_WIN32`
compatibility mode was left to help projects transition.  Only projects
that do not require at least 2.8.4 as their minimum CMake version need
the compatibility mode.  We've also long warned about projects that do
not require at least 2.8.12, so it is now reasonable to remove the
legacy compatibility mode.
2023-01-19 14:29:35 -05:00
Brad King
e107fd0713 Merge branch 'release-3.25' 2023-01-19 10:40:17 -05:00
Brad King
e2be23a2b3 CMake 3.25.2 2023-01-19 09:32:19 -05:00
Brad King
c3513e59c4 Merge topic 'minor-tutorial-fixes'
2e3fcf9399 Tutorial: Fix typos in Step 11 exercise and solution
f04c548877 Tutorial: Fix exercise in Step 10 to match solution provided in Step 11
566e12c976 Tutorial: Fix destination of link from Step 6 to Step 5
bef0b9eb64 Tutorial: Fix exercise in Step 5 to match solution provided in Step 6

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !8087
2023-01-19 09:24:56 -05:00
Brad King
53d7d8d4ee Help/dev: Update source code guide to specify clang-format version 15 2023-01-19 09:13:24 -05:00