Commit Graph

5558 Commits

Author SHA1 Message Date
Brad King
55c4f54e48 Merge topic 'doc-if-basic-expressions' into release-3.22
294581a443 Help: Be more explicit about the behavior of if(<string>)
3a9695557d Help: Explicitly state that if(ENV{some_var}) is always false

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !6768
2021-12-01 09:37:40 -05:00
Craig Scott
294581a443 Help: Be more explicit about the behavior of if(<string>) 2021-12-01 18:59:23 +11:00
Craig Scott
3a9695557d Help: Explicitly state that if(ENV{some_var}) is always false 2021-12-01 18:30:26 +11:00
Felix Lelchuk
3caeee0c86 Help: Clarify CMAKE_INSTALL_MODE documentation
Fixes: #22869
Co-Authored-By: Craig Scott <craig.scott@crascit.com>
2021-11-24 08:30:38 +11:00
Craig Scott
699d4a98e2 Help: Use definition list for allowed values of CMAKE_INSTALL_MODE
Clean up the wording as well for improved consistency
and clarity.
2021-11-24 08:20:04 +11:00
Ben Boeckel
7d5828e293 gitlab-ci: shorten job prefixes
This helps to maximize the amount of information visible in the GitLab
web interface.

Also document their meaning in the developer documentation and in the CI
configuration file directly.

See: https://gitlab.com/gitlab-org/gitlab/-/issues/8496
2021-11-23 10:11:25 -05:00
Brad King
69b70968bd Help: Suggest CMAKE_POLICY_DEFAULT_CMP0126 in CMP0126 docs 2021-11-22 14:57:22 -05:00
Brad King
5b1c24255f Help: Suggest CMAKE_POLICY_DEFAULT_CMP0077 in CMP0077 docs
Issue: #20490
2021-11-22 14:56:17 -05:00
Brad King
c44636a89b Help: Document more use cases for CMAKE_POLICY_DEFAULT_CMPNNNN 2021-11-22 14:55:36 -05:00
Craig Scott
71a2c9d31b Help: ENVIRONMENT_MODIFICATION path_list_... separator is based on host
Fixes: #22937
2021-11-21 17:50:29 +11:00
Craig Scott
250acbb099 Help: Improve cross-referencing of test LABELS and related features 2021-11-13 20:45:05 +11:00
Craig Scott
a77bdefa3e Help: Add missing version details for Additional Test Measurements 2021-11-13 20:44:05 +11:00
Raul Tambre
e47dfce75d CMP0128: Enable/disable extensions if standard same as default
This was intended to be part of the initial MR (!6177), but accidentally went
missing when debugging nightly failures on less common systems. Noticed during
!6711 review as the comment about this behaviour didn't match the code.

Documentation for CMP0128 is updated to remove a false case and note the two
cases related to this.

Fixes #22224.
2021-11-11 21:55:04 +02:00
Craig Scott
0b8d692697 Merge topic 'doc-CMP0128' into release-3.22
8371056fbb Help: Correct inaccuracies in wording for CMP0128

Acked-by: Kitware Robot <kwrobot@kitware.com>
Reviewed-by: Raul Tambre <raul@tambre.ee>
Merge-request: !6711
2021-11-10 05:47:33 -05:00
Yonggang Luo
6dc6412477 Help: Use stronger wording in rule about preset inheritance 2021-11-08 17:00:08 -05:00
Craig Scott
8371056fbb Help: Correct inaccuracies in wording for CMP0128 2021-11-09 07:37:09 +11:00
Brad King
2b9b64269f Merge topic 'vs-framework-version' into release-3.22
d51246c662 VS: Default TargetFrameworkVersion to v4.7.2 for VS 2022
f97f8537f3 VS: Model a default target framework
e40cedddc0 cmVisualStudio10TargetGenerator: Refactor target framework selection
78782cc7dc cmGlobalVisualStudio8Generator: Refactor SetGeneratorPlatform

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !6699
2021-11-08 12:38:47 -05:00
Craig Scott
84667a6f3c Help: Clarify valid versus supported values for CUDA_STANDARD
CMake 3.18 added the first support for any compiler for 17 and 20,
but those were recognized as valid values in earlier CMake versions
even though there was no compiler that supported them. Make this
distinction clear to avoid creating the impression that these standards
could be usefully used before CMake 3.18.

While 98 is recognized as a valid value, it also just gets treated as 03
internally. Document this behavior as well.

Fixes: #22711
2021-11-08 08:17:04 +11:00
Brad King
f97f8537f3 VS: Model a default target framework
Add fields to the VS generator to select a target framework.
Migrate the existing default for VS 12 .NET CF for Windows CE.

Report the values in `CMAKE_VS_*` variables and use them for
the CSharp compiler id project too.

Issue: #22849
2021-11-06 06:08:54 -04:00
Brad King
85771bbf00 Merge topic 'doc-TARGET_RUNTIME_DLLS' into release-3.22
001870d451 Help: Clarify TARGET_RUNTIME_DLLS behavior on imported targets

Acked-by: Kitware Robot <kwrobot@kitware.com>
Acked-by: Robert Maynard <robertjmaynard@gmail.com>
Merge-request: !6700
2021-11-04 09:07:47 -04:00
Brad King
001870d451 Help: Clarify TARGET_RUNTIME_DLLS behavior on imported targets
This generator expression does not report the locations of `.dll`
files on imported targets with the `UNKNWON` type, since their
`IMPORTED_LOCATION` refers to the import library and not the DLL.

Fixes: #22845
2021-11-03 16:17:17 -04:00
Raul Tambre
e9976c8827 Help: Better explain CMAKE_<LANG>_EXTENSIONS_DEFAULT
Explain that this represents the compiler's default and mustn't be modified
by the user. Clarify when it's used as the default.

Additionally:
* Add a reference to it in cmake-compile-features in text explaining the
  feature.
* Add explanations for the default initialization by
  `CMAKE_<LANG>_EXTENSIONS_DEFAULT` to all `<LANG>_EXTENSIONS` pages and
  references to CMP0128.
* Slightly reduce the wordiness of the default initialization explanations by
  removing an unnecessary "it is".

Fixes #22828.
2021-11-02 17:58:21 +02:00
Alex Turbov
a7a499a459 Help: Add versionadded for CPACK_RPM_REQUIRES_EXCLUDE_FROM variable 2021-11-01 09:20:20 -04:00
Brad King
3eefb78512 Help: Use lower-case names of sphinx directives 2021-11-01 09:20:20 -04:00
Brad King
0ad79f7ba8 Help: Fix versionadded for VS 15 2017 instance selection
Support for `CMAKE_GENERATOR_INSTANCE` was added in CMake 3.11, but the
possibility was mentioned in a comment in older versions, so the wrong
versionadded value was used in commit c43e845d09 (Help: Add `..
versionadded` directives to generator docs, 2020-11-11,
v3.20.0-rc1~476^2).
2021-10-29 09:47:01 -04:00
Marc Aldorasi
fa47e9c8f9 Help: Document that configure_file can create directories 2021-10-28 12:48:25 -04:00
Brad King
7b19f55003 Merge topic 'builtin-help-versionadded' into release-3.22
054754359a cmRST: support `versionadded` and `versionchanged` directives

Acked-by: Kitware Robot <kwrobot@kitware.com>
Acked-by: buildbot <buildbot@kitware.com>
Merge-request: !6667
2021-10-28 09:09:23 -04:00
Brad King
31d49d613a Merge topic 'doc-ENVIRONMENT_MODIFICATION' into release-3.22
f6177f05da Help: Clarify ENVIRONMENT_MODIFICATION case sensitivity

Acked-by: Kitware Robot <kwrobot@kitware.com>
Reviewed-by: Ben Boeckel <ben.boeckel@kitware.com>
Merge-request: !6661
2021-10-27 09:18:56 -04:00
Ben Boeckel
054754359a cmRST: support versionadded and versionchanged directives
This makes `versionadded` and `versionchanged` directives show up in
`cmake --help-*` output instead of disappearing (and potentially making
empty sections).

Fixes: #22808
2021-10-27 09:15:00 -04:00
Brad King
8b64fc7dbb Help: Drop 3.22 release note for VS 2022
The 3.21.4 release will have full support, so it is not new to
the 3.22 series anymore.
2021-10-27 08:51:08 -04:00
Brad King
050ed59412 Merge branch 'backport-3.21-vs2022' into vs2022 2021-10-27 08:51:00 -04:00
Brad King
f3ddc52676 VS: Update Visual Studio 17 2022 generator for the Release Candidates
Assume this is close enough to the final release to treat as
non-experimental support.
2021-10-27 08:49:47 -04:00
Michael Hirsch
f6177f05da Help: Clarify ENVIRONMENT_MODIFICATION case sensitivity 2021-10-26 09:37:14 -04:00
Arcturus Arcturus
1560265e7d Help: Fix file(INSTALL) docs w.r.t. CMAKE_INSTALL_MESSAGE
In commit c9568de52c (install: Add CMAKE_INSTALL_MESSAGE variable
(#13761), 2014-06-24, v3.1.0-rc1~370^2~1) we incorrectly documented
that `CMAKE_INSTALL_MESSAGE` controls the status message for
`file(INSTALL)`.  Revert that.

Fixes: #17162
2021-10-20 12:48:04 -04:00
Brad King
f117c7d11e Help: Update 3.22 release notes for the VS 2022 Release Candidate 2021-10-19 09:37:05 -04:00
Brad King
d5a7448fa4 Merge branch 'backport-3.21-vs2022' into vs2022 2021-10-19 09:36:19 -04:00
Brad King
3d9d75b0be VS: Update Visual Studio 17 2022 generator for the Release Candidate 2021-10-19 09:27:37 -04:00
Michael Hirsch
ec94706791 Help: gen expr: note that CONFIG is comma-separated 2021-10-19 09:05:48 -04:00
Brad King
6fde60a4c8 Help: Add 3.22 release note about the update for VS 2022 Preview 5 2021-10-14 13:45:03 -04:00
Brad King
6dfe28f33c Merge branch 'backport-3.21-vs2022' into vs2022 2021-10-14 13:40:20 -04:00
Brad King
a8414190da VS: Update Visual Studio 17 2022 generator for Preview 5 2021-10-14 13:39:45 -04:00
Brad King
127cb6481c Merge topic 'doc_clarify_list_pop' into release-3.22
67f8d20a8e Help: clarify list(POP_* <in_out> <in_out>) behavior

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !6620
2021-10-14 07:44:43 -04:00
Robert Maynard
67f8d20a8e Help: clarify list(POP_* <in_out> <in_out>) behavior 2021-10-14 08:53:17 +11:00
Deniz Bahadir
f2262fab51 Help: Add documentation for CMAKE_<LANG>_COMPILER_FRONTEND_VARIANT
Signed-off-by: Deniz Bahadir <deniz@code.bahadir.email>
2021-10-13 10:37:09 -04:00
Deniz Bahadir
ffb54e2350 Help: Add more documentation for CMAKE_<LANG>_SIMULATE_ID
Signed-off-by: Deniz Bahadir <deniz@code.bahadir.email>
2021-10-13 10:37:08 -04:00
Brad King
e5a97f83b3 Help: Drop development topic notes to prepare release
Release versions do not have the development topic section of
the CMake Release Notes index page.
2021-10-08 10:00:22 -04:00
Brad King
8c27ccd945 Merge topic 'doc-3.22-relnotes'
9f0b52b8e6 Help: Update Sphinx versionadded directives for 3.22 release
c632a7105c Help: Organize and revise 3.22 release notes
48e503ec78 Help: Consolidate 3.22 release notes

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !6606
2021-10-08 09:58:19 -04:00
Brad King
daab8b891c Merge topic 'tutorial_update_step_4'
5a86ce5428 Tutorial: Step 4 improvements

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !6564
2021-10-08 09:50:04 -04:00
Joseph Snyder
5a86ce5428 Tutorial: Step 4 improvements
Small changes to the text and CMake code for the fourth step of the
tutorial:

* Remove parameter from endfunction call
* Standardize on "binary directory" for test location
* Add additional information about a Release build.

Issue: #22663
2021-10-07 11:53:51 -04:00
Brad King
9f0b52b8e6 Help: Update Sphinx versionadded directives for 3.22 release
Run the script:

    Utilities/Sphinx/update_versions.py --since v3.21.0 --overwrite

Manually select updates that really belong to the 3.22 release, as
against adding documentation for previously-existing entities.
2021-10-07 11:25:51 -04:00