Commit Graph

6271 Commits

Author SHA1 Message Date
Craig Scott
c615095cf7 Merge topic 'doc-ctest_test-output-control'
68e1385a5c Merge branch 'backport-3.24-doc-ctest_test-output-control' into doc-ctest_test-output-control
fadc93286a Help: Add crossrefs to ctest output control options
de892f3d4e Help: Add crossrefs to ctest output control options
3453e6bd48 Merge branch 'backport-3.24-doc-ctest_test-output-control' into doc-ctest_test-output-control
8981e88b18 Help: Add missing closing quote on C++ example

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !7595
2022-08-20 19:02:39 -04:00
Brad King
6c7f3c839b Merge topic 'feature/cmake-man-page-short-option-first'
536a25fedc Help: Convenient declaration for `-j, --parallel` option

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !7588
2022-08-19 07:21:03 -04:00
Brad King
d0a9602aca Merge topic 'doc-var-refs'
159acea394 Help: Clarify that variable references may use cache entries

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !7589
2022-08-19 07:18:34 -04:00
Craig Scott
de892f3d4e Help: Add crossrefs to ctest output control options 2022-08-19 14:45:36 +10:00
Craig Scott
3453e6bd48 Merge branch 'backport-3.24-doc-ctest_test-output-control' into doc-ctest_test-output-control 2022-08-19 14:30:50 +10:00
Craig Scott
8981e88b18 Help: Add missing closing quote on C++ example 2022-08-19 14:03:18 +10:00
Brad King
159acea394 Help: Clarify that variable references may use cache entries
Clarify in `cmake-language(7)` that a variable lookup may use a cache
entry if the variable is not set.  Fix misleading text in added by
commit 8ba2a8d4a4 (Help: short/long variable reference in if command,
2018-11-01, v3.14.0-rc1~408^2~2).

Fixes: #23863
2022-08-18 09:04:08 -04:00
Brad King
36d35d4eb1 Merge topic 'cmake-E-env-modify'
c9d70a7cc3 cmake -E env: Add --modify flag

Acked-by: Kitware Robot <kwrobot@kitware.com>
Acked-by: buildbot <buildbot@kitware.com>
Merge-request: !7571
2022-08-18 08:04:06 -04:00
Alex Turbov
536a25fedc Help: Convenient declaration for -j, --parallel option 2022-08-18 14:18:49 +04:00
Brad King
0677ca5cfc Merge branch 'release-3.24' 2022-08-17 14:18:29 -04:00
Brad King
c3793b4157 CMake 3.24.1 2022-08-17 12:54:57 -04:00
Alex Reinking
c9d70a7cc3 cmake -E env: Add --modify flag
When `cmake -E env` is given the `--modify` flag, try to parse the
following argument as an `ENVIRONMENT_MODIFICATION` operation and apply
it to the environment.

This generalizes `--unset=`:

1.  When implementing `ENVIRONMENT_MODIFICATION` features for other CMake
    commands, the `MYVAR=OP:VALUE` strings do not need to be translated
    to OP-specific flags.
2.  This provides a natural and consistent extension point to introduce
    new operations without introducing very many flags.
3.  Users need to learn only one syntax to access the same functionality.

There is one difference between the behavior here as compared to CTest's
interpretation of the `ENVIRONMENT_MODIFICATION` test property.
The `MYVAR=reset:` command when run in `cmake -E env` will reset `MYVAR`
to whatever its value was when `cmake -E env` launched, rather than try
to checkpoint after plain `MYVAR=VALUE` options.  This makes `MYVAR=VALUE`
and `--modify MYVAR=set:VALUE` semantically equivalent.
2022-08-17 12:54:39 -04:00
Brad King
8ad94b1977 Merge topic 'FindVulkan-tolerate-FATAL_ERROR'
9063674517 Help: Add 3.24 release note about FindVulkan component enforcement
bc01362368 FindVulkan: Restore tolerance of unknown FATAL_ERROR component

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !7583
2022-08-17 10:16:10 -04:00
Brad King
9063674517 Help: Add 3.24 release note about FindVulkan component enforcement
Since commit 6e4d20921d (FindVulkan: Add component for `shaderc_combined`,
2022-05-18, v3.24.0-rc1~111^2~5), the module rejects unknown components.
Add a release note about this behavior change.

Issue: #23849
2022-08-17 09:52:14 -04:00
Brad King
47a2eb8fac Merge topic 'tutorial_step1_update'
953d729622 Tutorial: Collapse step 1 solutions
c59e164155 Tutorial: Add Step 1 background info and update style

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !7497
2022-08-16 12:59:40 -04:00
Brad King
7b1ab24d79 Merge topic 'doc-compiler-id-table'
a8430527f3 Help: `CMAKE_<LANG>_COMPILER_ID` turn code block into table

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !7567
2022-08-16 12:58:42 -04:00
Brad King
14aca54c0a Merge topic 'doc-cmake-cli-options'
0224576995 Help: Replace `cmake -P` option mentions w/ Sphinx role
1b94770f27 Help: Insert link to `cmake --toolchain` option
2c54cd871a Help: Turn items of presets manual page into description list
e2198fd9dc Help: Format `-Werror`/`-Wno-error` in the way it can be referenced
a6070b480f Help: Use placeholder instead of listing choices in option lines
8ba20cb56f Help: Simplify `cmake --log-level` option definition
146e4e6bad Help: Split `ctest` options into groups like `cmake` man page has
4c1008d739 Help: Use `:option:` role to reference `ctest` options
...

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !7554
2022-08-16 12:46:26 -04:00
Craig Scott
69d584378f Merge topic 'doc-warning-as-error'
2c6e379c89 Merge branch 'backport-3.24-doc-warning-as-error' into doc-warning-as-error
bba3ec96b0 Help: A missing cross-reference to --compile-no-warning-as-error
2c1a746343 Merge branch 'backport-3.24-doc-warning-as-error' into doc-warning-as-error
680fe820c6 Help: A missing cross-reference to --compile-no-warning-as-error
7ad89f8fb1 Help: List compiler IDs supported by COMPILE_WARNING_AS_ERROR

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !7561
2022-08-16 06:57:32 -04:00
Craig Scott
e6038c0199 Merge topic 'doc-warning-as-error' into release-3.24
680fe820c6 Help: A missing cross-reference to --compile-no-warning-as-error
7ad89f8fb1 Help: List compiler IDs supported by COMPILE_WARNING_AS_ERROR

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !7561
2022-08-16 06:57:31 -04:00
Alex Turbov
a8430527f3 Help: CMAKE_<LANG>_COMPILER_ID turn code block into table 2022-08-15 20:37:25 +04:00
Markus Ferrell
953d729622 Tutorial: Collapse step 1 solutions 2022-08-15 12:06:46 -04:00
Markus Ferrell
c59e164155 Tutorial: Add Step 1 background info and update style 2022-08-15 12:06:34 -04:00
Brad King
4befac3b32 Merge topic 'nvtx3'
cd200c6c2d FindCUDAToolkit: nvtx3 target

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !7568
2022-08-15 11:26:23 -04:00
Craig Scott
bba3ec96b0 Help: A missing cross-reference to --compile-no-warning-as-error 2022-08-15 11:08:38 -04:00
Brad King
2c1a746343 Merge branch 'backport-3.24-doc-warning-as-error' into doc-warning-as-error 2022-08-15 11:06:59 -04:00
Craig Scott
680fe820c6 Help: A missing cross-reference to --compile-no-warning-as-error 2022-08-15 11:06:51 -04:00
Craig Scott
7ad89f8fb1 Help: List compiler IDs supported by COMPILE_WARNING_AS_ERROR 2022-08-15 11:06:31 -04:00
Brad King
c5f6d93d5e Merge topic 'warning-as-error-ti-compiler'
1cd65dfa0e TI compiler: Add support for COMPILE_WARNING_AS_ERROR target property

Acked-by: Kitware Robot <kwrobot@kitware.com>
Acked-by: Josef Angstenberger <code@jtxa.de>
Merge-request: !7560
2022-08-15 10:51:45 -04:00
Alex Turbov
0224576995 Help: Replace cmake -P option mentions w/ Sphinx role 2022-08-14 09:58:42 +04:00
Alex Turbov
1b94770f27 Help: Insert link to cmake --toolchain option 2022-08-14 09:58:42 +04:00
Alex Turbov
2c54cd871a Help: Turn items of presets manual page into description list
It was an ordinal paragraphs (`<p>`) intermixed with blockquote elements.
2022-08-14 09:58:41 +04:00
Alex Turbov
e2198fd9dc Help: Format -Werror/-Wno-error in the way it can be referenced
Replace mentions of these options in the presets manual page.
2022-08-14 09:58:41 +04:00
Alex Turbov
a6070b480f Help: Use placeholder instead of listing choices in option lines
This avoids any ambiguity with whether the choices are literal
values or not. It also makes the option lines more concise.
2022-08-14 09:58:41 +04:00
Alex Turbov
8ba20cb56f Help: Simplify cmake --log-level option definition 2022-08-14 09:58:41 +04:00
Alex Turbov
146e4e6bad Help: Split ctest options into groups like cmake man page has
Co-Authored-By: Craig Scott <craig.scott@crascit.com>
2022-08-14 09:58:41 +04:00
Alex Turbov
4c1008d739 Help: Use :option: role to reference ctest options 2022-08-14 09:58:41 +04:00
Alex Turbov
c401fc5dee Help: Simplify optional repeating option
Similar form has already been used in the `ctest -M <mode> [-T <step>]...`
synopsis and looks quite clean w/o extra characters.
2022-08-14 09:58:41 +04:00
Alex Turbov
28ecfd1690 Help: Short options first, then long, then Windows style 2022-08-14 09:58:41 +04:00
Alex Turbov
57f23fa8fc Help: {<…> | <…>}<…|…>
The form of alternative names for "placeholders" has been used already
(e.g., `<file|dir>` in the `cmake(1)` manual).
2022-08-14 09:58:41 +04:00
Alex Turbov
5a20d4c250 Help: Consistent spaces in option args 2022-08-14 09:58:41 +04:00
Alex Turbov
798834ef63 Help: <f><file> for --help* option descriptions 2022-08-14 09:58:41 +04:00
Craig Scott
db9453bbcf Merge topic 'doc-MSVC_RUNTIME_LIBRARY-init'
c1b07ca9da Help: MSVC_RUNTIME_LIBRARY is initialized from associated variable

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !7566
2022-08-14 01:13:51 -04:00
Raul Tambre
cd200c6c2d FindCUDAToolkit: nvtx3 target
nvtx3 is a header-only replacement for the previous shared library
implementations.

I implemented it as a separate target since while the header names match and
ideally it should be API compatible, forcing its include directory into the old
target would lengthen the include search path and could cause confusion or
possible build differences for projects using multiple build systems. This
keeps it explicit as a developer opt-in.

Implements: #21377
Resolves: #23835
2022-08-13 23:52:42 +03:00
Craig Scott
c1b07ca9da Help: MSVC_RUNTIME_LIBRARY is initialized from associated variable
The CMAKE_MSVC_RUNTIME_LIBRARY variable docs mention that it
initializes the MSVC_RUNTIME_LIBRARY target property, but the
property's docs was missing any mention of the variable.
2022-08-13 09:11:35 +10:00
Craig Scott
1cd65dfa0e TI compiler: Add support for COMPILE_WARNING_AS_ERROR target property 2022-08-12 08:27:19 +10:00
Cristian Adam
62cd3904bf variable: Set LINUX variable on Linux target systems
Fixes: #23840
2022-08-12 07:20:05 +10:00
Brad King
1493ed10a1 Merge topic 'doc-ctest-multi-built-target'
ce58311b31 Help: --build-target can be repeated in ctest --build-and-test mode

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !7555
2022-08-10 09:24:02 -04:00
Brad King
7e580e48a4 Merge topic 'tutorial_genExp_rearrange'
ccba87b05b Tutorial: Move step 10 to step 4

Acked-by: Kitware Robot <kwrobot@kitware.com>
Acked-by: buildbot <buildbot@kitware.com>
Merge-request: !7506
2022-08-10 09:21:32 -04:00
Craig Scott
ce58311b31 Help: --build-target can be repeated in ctest --build-and-test mode 2022-08-10 16:40:00 +10:00
Alex Turbov
7f4b90a3a6 Help: Fix ctest options description
Missed empty line after `.. option::` and the next paragraph.
2022-08-10 00:46:24 +04:00