Commit Graph

8902 Commits

Author SHA1 Message Date
Craig Scott 3bf895dc41 Merge topic 'doc-expand-appimage-generator' into release-4.2
b8c9c65682 Help: Correct and expand AppImage CPack generator docs

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !11545
2026-01-07 06:45:57 -05:00
Craig Scott b8c9c65682 Help: Correct and expand AppImage CPack generator docs
The help text for most variables were just copy-and-pasted from the
minimal output from running `appimagetool --help`. That text lacked
considerable important detail.

The default values for most of the variables were also specified
incorrectly. They listed themselves as the default, which is wrong.
In most cases, the variables are unset by default. For those that
actually have fallback values, update them to specify that.

The CPACK_APPIMAGE_DESKTOP_FILE variable is not mandatory.
The code does provide fallback behavior when it isn't set. What is
mandatory though is that there is a .desktop file, either specified
explicitly, or found within the installed files. There is also a close
relationship with CPACK_PACKAGE_ICON that deserves explicitly
drawing attention to.
2026-01-07 08:46:59 +11:00
Craig Scott a7fc57ed1c Help: Restore correct sort order for property and variable manuals 2025-12-21 20:51:52 +11:00
Craig Scott e73307957e Help: Fix minor grammar problems 2025-12-21 20:51:52 +11:00
Brad King cfa16434c0 Merge topic 'doc-4.1-vs-flags' into release-4.2
ea357236f4 Help: Add 4.1 release note about VS link flag suppression

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !11525
2025-12-18 10:35:12 -05:00
Brad King ea357236f4 Help: Add 4.1 release note about VS link flag suppression
Document link flags suppressed by commit 99d09ec45a (VS: Suppress
MSBuild default link flags not specified by project or user, 2025-06-17,
v4.1.0-rc1~6^2).  Leave out `-subsystem` because that's being reverted
by another commit.

Issue: #27004
Issue: #27464
2025-12-17 16:58:30 -05:00
Tyler Yankee 58fc663688 Tutorial: Provide MSVC example to build Vendor library
Allow Windows users who aren't familiar with MSVC-equivalent commands to
GCC and/or don't have the GNU toolchain installed (via MinGW, etc.) to
practice this example.
2025-12-11 09:09:35 -05:00
Tyler Yankee 1ad84c5301 Tutorial: Fix path to file in exercise solution 2025-12-09 15:23:34 -05:00
Brad King 485f11a780 CMake 4.2.1 2025-12-08 13:33:58 -05:00
Brad King f0549d0083 Merge branch 'release-4.1' into release-4.2 2025-12-08 12:01:39 -05:00
Brad King 892fad3d23 CMake 4.1.4 2025-12-08 11:30:41 -05:00
Brad King faa88b28a5 Help: Add 4.2 release note about VS flag suppression
Document flags suppressed by commit 7202539fd4 (VS: Suppress MSBuild
default flags not specified by project or user, 2025-09-10,
v4.2.0-rc1~188^2~1).
2025-12-08 10:28:56 -05:00
Brad King 19527eb5c6 Merge branch 'doc-4.1-vs-flags' into doc-4.2-vs-flags 2025-12-08 10:28:50 -05:00
Brad King e2646b9926 Help: Add 4.1 release note about VS flag suppression
Document flags suppressed by commit 7db3dbddb2 (VS: Suppress MSBuild
default flags not specified by project or user, 2025-06-02,
v4.1.0-rc1~69^2).
2025-12-08 10:28:32 -05:00
Brad King b1a2371c26 Help: Replace QtCreator link with its permanent redirect 2025-12-05 08:55:18 -05:00
Brad King d4539f6f85 Merge topic 'renesas_compiler_toolchain_doc' into release-4.2
6139bb7903 Help: Document Renesas compiler toolchain

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !11446
2025-11-26 10:47:28 -05:00
Brad King 5ec87b2ba7 Emscripten: Provide CMAKE_<LANG>_COMPILER_ARCHITECTURE_ID
Extend commit 96d9b94a98 (Emscripten: Add platform modules, 2025-05-16,
v4.2.0-rc1~607^2~3) to account for commit 7f0f382c55 (Provide
CMAKE_<LANG>_COMPILER_ARCHITECTURE_ID on more compilers, 2025-03-24,
v4.1.0-rc1~499^2).

Fixes: #27425
2025-11-25 15:46:16 -05:00
Hirofumi Nakamura 6139bb7903 Help: Document Renesas compiler toolchain
Extend commit 514135f563 (Renesas: Add support for Renesas compilers,
2025-04-14, v4.1.0-rc1~89^2) with more documentation.

Closes: #27395
2025-11-25 13:55:10 -05:00
Brad King 588fec2a05 Help: Add 4.2 release note for CPack AppImage generator
This was missed in commit 1a6dbcc9ea (CPack: Add AppImage generator,
2025-07-30, v4.2.0-rc1~229^2).

Issue: #27104
2025-11-21 10:07:15 -05:00
Brad King 20dd0973b6 Help: Fix CPack AppImage Generator heading capitalization 2025-11-21 10:07:13 -05:00
Ben Boeckel 7d871d7857 Help/CMAKE_AUTOGEN_INTERMEDIATE_DIR_STRATEGY: document supported generators
Fixes: #27388
2025-11-18 16:28:11 -05:00
Brad King be291692bf Merge branch 'release-4.1' into release-4.2 2025-11-18 10:37:32 -05:00
Brad King 5961f5f3bc CMake 4.1.3 2025-11-18 09:55:48 -05:00
Brad King acfc50620b Merge branch 'release-4.1' into release-4.2 2025-11-18 09:44:46 -05:00
Brad King 89b555f1b5 Merge branch 'release-4.0' into release-4.1 2025-11-18 09:43:32 -05:00
Brad King 5517be2bf1 CMake 4.0.5 2025-11-18 09:16:12 -05:00
Brad King 972abd527e Merge topic 'doc-string-xref' into release-4.2
510d81c7bc Help: Avoid reST named references in string(JSON) synopsis
6c0f37546f Help: Improve string(JSON) synopsis document source readability

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !11426
2025-11-18 09:05:16 -05:00
Brad King 407a80260b Merge topic 'doc-string-xref' into release-4.1
510d81c7bc Help: Avoid reST named references in string(JSON) synopsis
6c0f37546f Help: Improve string(JSON) synopsis document source readability

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !11426
2025-11-18 09:03:41 -05:00
Brad King e54eda8159 Merge topic 'doc-string-xref' into release-4.0
510d81c7bc Help: Avoid reST named references in string(JSON) synopsis
6c0f37546f Help: Improve string(JSON) synopsis document source readability

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !11426
2025-11-18 09:03:15 -05:00
Brad King 510d81c7bc Help: Avoid reST named references in string(JSON) synopsis
Also revert commit 9702a01dc9 (Help: string(LENGTH): Fix synopsis link
to command description, 2023-12-30, v3.28.2~23^2).  It was only needed
to avoid re-using a named reference that we've now removed.

Issue: #25546
2025-11-17 16:31:37 -05:00
Brad King 6c0f37546f Help: Improve string(JSON) synopsis document source readability
Avoid spaces in signature target names.
2025-11-17 16:31:37 -05:00
Brad King 952e000d38 Merge branch 'release-4.1' into release-4.2 2025-11-17 16:27:01 -05:00
Brad King 1d303f6beb Merge branch 'release-4.0' into release-4.1 2025-11-17 16:26:50 -05:00
Brad King b4528858f8 Merge branch 'release-3.31' into release-4.0 2025-11-17 16:26:39 -05:00
Brad King ca626022f5 CMake 3.31.10 2025-11-17 14:28:31 -05:00
Craig Scott 730cad9cb6 Help: Fix typos and formatting for 4.2 release 2025-11-14 16:29:51 +11:00
Brad King 53a7f5b702 Help: Update 4.2 release note for Visual Studio 18.0 release
The `Visual Studio 18 2026` generator is no longer experimental.
2025-11-12 18:48:50 -05:00
Vito Gamberini fb58de1a56 Tutorial: Add Step 0 to prepare the working environment
Adds a "Step 0" to the tutorial which discusses minutia about where to
get CMake, how to run it, and most importantly deals at length with
various generator issues which aren't covered elsewhere.
2025-10-29 09:49:23 -04:00
Brad King b22a77e337 Merge topic 'doc-cmake.org-tutorial-archive' into release-4.2
5473a45fd8 Tutorial: Restore source archive when published on cmake.org

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !11370
2025-10-29 09:31:10 -04:00
Brad King 5473a45fd8 Tutorial: Restore source archive when published on cmake.org
Restore commit 4cb616fed6 (Tutorial: Provide a source archive when
published on cmake.org, 2022-04-27, v3.23.2~22^2).  Its effects were
accidentally reverted by commit 9784834b4c (Help: Use `*.rst` extension
for included files, 2025-04-07, v4.1.0-rc1~354^2).

Reported-by: Vito Gamberini <vito.gamberini@kitware.com>
2025-10-29 09:17:14 -04:00
Brad King aef339b26f Merge topic 'instrumentation-exit' into release-4.2
236207b81a instrumentation: Fix snippet `result` field
d3add47973 Tests/Instrumentation: Remove unused files

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !11339
2025-10-28 09:38:49 -04:00
Brad King b5ec664401 Merge topic 'project-license-doc' into release-4.2
ebf0a359ad Help: Improve documentation of project SPDX_LICENSE

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !11348
2025-10-28 09:32:37 -04:00
Tyler Yankee 236207b81a instrumentation: Fix snippet result field
Give the actual exit code of the command from the snippet as intended;
currently, this always gives 0 for sub-commands like compile and link,
as well as `ctest`.

For now, the result in build snippets will be `null`.
2025-10-27 15:42:58 -04:00
Matthew Woehlke ebf0a359ad Help: Improve documentation of project SPDX_LICENSE
Currently, CMake allows specifying a license (`SPDX_LICENSE`) for both
projects and targets, which is largely motivated by CPS export. The
design of CPS is geared toward components (targets) only expressing an
explicit license when that component's license differs from the license
that applies to the package as a whole (or, at least, the license
generally used by the package's software components). Accordingly, the
project license is not used to initialize the `SPDX_LICENSE` target
property at export time. This, however, was not documented previously.

Add a note explaining this to the `SPDX_LICENSE` option of the `project`
command.

Fixes: #27295
2025-10-27 10:38:40 -04:00
Brad King b39e361175 Merge topic 'xcode-macos-deployment-target' into release-4.2
de53a46a91 Help: Add 4.1 release note for restored Xcode default deployment target
85ba6f5d1b Merge branch 'backport-4.0-xcode-macos-deployment-target'
884260ced6 Help: Add 4.0 release note for restored Xcode default deployment target
1a37c83c7e Xcode: Restore default CMAKE_OSX_DEPLOYMENT_TARGET to run on host
e927408047 Apple: Initialize deployment target after SDK

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !11361
2025-10-27 09:26:15 -04:00
Brad King db76228cb4 Merge topic 'doc-3.31.9-typo' into release-4.2
d07cedf9b3 Help: Fix typo in 3.31.9 release note heading

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !11362
2025-10-27 09:23:17 -04:00
Brad King 4e2aeae7ba Merge topic 'xcode-macos-deployment-target' into release-4.1
de53a46a91 Help: Add 4.1 release note for restored Xcode default deployment target
85ba6f5d1b Merge branch 'backport-4.0-xcode-macos-deployment-target'
884260ced6 Help: Add 4.0 release note for restored Xcode default deployment target
1a37c83c7e Xcode: Restore default CMAKE_OSX_DEPLOYMENT_TARGET to run on host
e927408047 Apple: Initialize deployment target after SDK

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !11361
2025-10-27 09:12:00 -04:00
Brad King 847ce737c2 Merge topic 'doc-3.31.9-typo' into release-4.1
d07cedf9b3 Help: Fix typo in 3.31.9 release note heading

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !11362
2025-10-27 09:11:22 -04:00
Brad King 0e2331fc51 Merge topic 'backport-4.0-xcode-macos-deployment-target' into release-4.0
884260ced6 Help: Add 4.0 release note for restored Xcode default deployment target
1a37c83c7e Xcode: Restore default CMAKE_OSX_DEPLOYMENT_TARGET to run on host
e927408047 Apple: Initialize deployment target after SDK

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !11361
2025-10-27 09:09:22 -04:00
Brad King 9f6c47a2a2 Merge topic 'doc-3.31.9-typo' into release-4.0
d07cedf9b3 Help: Fix typo in 3.31.9 release note heading

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !11362
2025-10-27 09:08:08 -04:00