Commit Graph

6599 Commits

Author SHA1 Message Date
Craig Scott
3fc2dcd801 Help: Minor formatting and cross-ref cleanup for <CONFIG>_POSTFIX 2022-10-28 09:26:28 +11:00
Markus Ferrell
43f87741f4 Tutorial: Fix Step 5 solution after update to Step 6
Since commit 6e58a01f4e (Tutorial: Update step 6 style, 2022-10-06) the
`literalinclude` included an extra comment from step 6 instructions.
Fix the include bounds to remove the extra text.
2022-10-27 11:30:46 -04:00
Vasiliy Koyrev
9da542d5c1 string(TIMESTAMP): Add %z and %Z for adding time zone string
Fixes: #24056
2022-10-27 11:13:46 -04:00
Markus Ferrell
f9ef15f3dc Tutorial: Update step 7 style 2022-10-27 10:08:56 -04:00
Brad King
2954a810ce Merge topic 'tutorial_step6_update'
6e58a01f4e Tutorial: Update step 6 style

Acked-by: Kitware Robot <kwrobot@kitware.com>
Acked-by: buildbot <buildbot@kitware.com>
Merge-request: !7756
2022-10-27 09:45:48 -04:00
Brad King
ab88011579 Merge topic 'cmake-presets-workflow-arguments'
7ecbe324b0 cmake --workflow: add --fresh option
7d9aa0f00c cmake::Workflow: Refactor to use enum class argument
322193afcd cmake --workflow: print usage and exit on unrecognized argument
70aef29427 cmake --workflow: print usage message

Acked-by: Kitware Robot <kwrobot@kitware.com>
Acked-by: buildbot <buildbot@kitware.com>
Merge-request: !7825
2022-10-27 09:43:39 -04:00
Brad King
33d610a076 Merge topic 'cmake-presets-workflow-arguments' into release-3.25
7ecbe324b0 cmake --workflow: add --fresh option
7d9aa0f00c cmake::Workflow: Refactor to use enum class argument
322193afcd cmake --workflow: print usage and exit on unrecognized argument
70aef29427 cmake --workflow: print usage message

Acked-by: Kitware Robot <kwrobot@kitware.com>
Acked-by: buildbot <buildbot@kitware.com>
Merge-request: !7825
2022-10-27 09:43:38 -04:00
Brad King
a7adece911 Merge topic 'tutorial_my_math_consistency'
277fbb3035 Tutorial: Restore USE_MYMATH in place of MY_MATH

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !7829
2022-10-27 09:40:31 -04:00
Kyle Edwards
7ecbe324b0 cmake --workflow: add --fresh option
Fixes: #24073
2022-10-26 12:01:25 -04:00
Markus Ferrell
277fbb3035 Tutorial: Restore USE_MYMATH in place of MY_MATH
In commit 80f5d28813 (Tutorial: Update step 2 style, 2022-07-25,
v3.25.0-rc1~226^2) we replaced some uses of `USE_MYMATH` with `MY_MATH`.
Restore the former name for consistency with the rest of the tutorial.
2022-10-25 16:31:38 -04:00
Markus Ferrell
6e58a01f4e Tutorial: Update step 6 style 2022-10-25 11:54:05 -04:00
Brad King
19f49a7514 Merge topic 'doc-presets' into release-3.25
8a413eb8d0 Help: State default preset strategy for architecture and toolset
8de977fa70 Help: Use array consistently in presets manual
e11773e8cf Help: Fix trivial typos related to presets

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !7817
2022-10-25 10:37:23 -04:00
Brad King
979a9eb89f Merge topic 'doc-presets'
8a413eb8d0 Help: State default preset strategy for architecture and toolset
8de977fa70 Help: Use array consistently in presets manual
e11773e8cf Help: Fix trivial typos related to presets

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !7817
2022-10-25 10:37:23 -04:00
Brad King
5bbca910e5 Merge topic 'doc-ctest'
36d76ed07c Help: cmake(1), ctest(1), versionadded for key flags

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !7815
2022-10-24 12:31:16 -04:00
Craig Scott
8a413eb8d0 Help: State default preset strategy for architecture and toolset 2022-10-22 16:21:34 +11:00
Craig Scott
8de977fa70 Help: Use array consistently in presets manual
When referring to data in a JSON array, use "array" consistently
rather than "list". This avoids ambiguity over whether we mean
a string containing a CMake list, or a JSON array.

Fixes: #24074
2022-10-22 16:19:19 +11:00
Craig Scott
e11773e8cf Help: Fix trivial typos related to presets 2022-10-22 16:17:13 +11:00
Michael Hirsch
36d76ed07c Help: cmake(1), ctest(1), versionadded for key flags 2022-10-21 10:55:15 -04:00
Brad King
a0523f81d1 Merge topic 'doc-cli-xrefs'
3043c17039 Help: Add more CLI `:option:` references to various pages

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !7811
2022-10-21 10:19:54 -04:00
Brad King
63d28469cd Merge topic 'doc-cli-xrefs' into release-3.25
3043c17039 Help: Add more CLI `:option:` references to various pages

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !7811
2022-10-21 10:19:53 -04:00
Brad King
8a3951a5f4 Merge topic 'doc-find_package-search-path-versionadded'
65dc8aa8b3 Help: Mention CMake version for a recently-added `find_package` search path
93871cb5a9 Help: Reformat find_package search paths as Sphinx tables

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !7810
2022-10-21 10:18:52 -04:00
Alex Turbov
3043c17039 Help: Add more CLI :option: references to various pages 2022-10-20 11:21:40 -04:00
Alex Turbov
65dc8aa8b3 Help: Mention CMake version for a recently-added find_package search path
Add a `versionadded` mark for the search path added by commit e55c154c5b
(cmFindPackageCommand: Add one more search path, 2022-06-27,
v3.25.0-rc1~339^2~1).

Fixes: #24067
2022-10-20 11:17:46 -04:00
Alex Turbov
93871cb5a9 Help: Reformat find_package search paths as Sphinx tables 2022-10-20 11:17:46 -04:00
Brad King
1cbf176b97 Merge topic 'cmake-presets-output-junit'
bea4ed5430 CTest: Add support for outputJUnitFile in presets
9270a02003 CMakePresets.json: Add outputJUnitFile to test presets schema
757786bb73 Tests: Add test for outputLogFile in CMakePresets.json
b68c3596e7 CMakePresets.json: Disallow extra properties in test output schema

Acked-by: Kitware Robot <kwrobot@kitware.com>
Acked-by: scivision <michael@scivision.dev>
Merge-request: !7806
2022-10-19 10:04:30 -04:00
Brad King
6fa189f716 Merge topic 'cmake-presets-output-junit' into release-3.25
bea4ed5430 CTest: Add support for outputJUnitFile in presets
9270a02003 CMakePresets.json: Add outputJUnitFile to test presets schema
757786bb73 Tests: Add test for outputLogFile in CMakePresets.json
b68c3596e7 CMakePresets.json: Disallow extra properties in test output schema

Acked-by: Kitware Robot <kwrobot@kitware.com>
Acked-by: scivision <michael@scivision.dev>
Merge-request: !7806
2022-10-19 10:04:29 -04:00
Kyle Edwards
bea4ed5430 CTest: Add support for outputJUnitFile in presets
Fixes: #22400
2022-10-18 16:52:23 -04:00
Brad King
f668272d10 Merge topic 'doc-flag-init'
e0075799ed Help: Clarify how language-specific flag environment values are used

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !7804
2022-10-18 15:32:27 -04:00
Brad King
20587e5af9 Merge topic 'doc-flag-init' into release-3.25
e0075799ed Help: Clarify how language-specific flag environment values are used

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !7804
2022-10-18 15:32:26 -04:00
Kyle Edwards
b68c3596e7 CMakePresets.json: Disallow extra properties in test output schema
And add test for testOutputTruncation being unsupported.
2022-10-18 14:40:11 -04:00
Brad King
e0075799ed Help: Clarify how language-specific flag environment values are used
Previous the wording could be interpreted to mean that the environment
variables like `CXXFLAGS` are used exclusively to initialize the
corresponding cache entries like `CMAKE_CXX_FLAGS`.  State clearly
that the value will be used in combination with builtin defaults.

Issue: #23956
2022-10-18 14:10:41 -04:00
Brad King
ebcf58ec74 Merge topic 'doc-CMAKE_ANDROID_API'
a739b55bb6 Help: Clarify historical-only role of CMAKE_ANDROID_API variable

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !7800
2022-10-18 13:49:53 -04:00
Brad King
65542be970 Merge topic 'doc-CMAKE_ANDROID_API' into release-3.25
a739b55bb6 Help: Clarify historical-only role of CMAKE_ANDROID_API variable

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !7800
2022-10-18 13:49:52 -04:00
Brad King
a6c854f89b Merge topic 'tutorial-step1-standard-required'
5b7e465be3 Tutorial: Fix variable name typo in step 1

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !7799
2022-10-18 13:48:39 -04:00
Brad King
a739b55bb6 Help: Clarify historical-only role of CMAKE_ANDROID_API variable
Revise documentation added by commit 6b84df8da9 (Help: Document cross
compiling for Android, 2016-06-20, v3.7.0-rc1~229^2~2) to avoid implying
that `CMAKE_ANDROID_API` is interchangeable with `CMAKE_SYSTEM_VERSION`.
The latter is the authoritative value of the Android API level.

Issue: #23830
2022-10-17 11:42:46 -04:00
Steven
5b7e465be3 Tutorial: Fix variable name typo in step 1
`CMAKE_CXX_REQUIRED_STANDARD` => `CMAKE_CXX_STANDARD_REQUIRED`
2022-10-17 10:36:15 -04:00
Brad King
c6fa5f7a70 Merge topic 'trace-try_compile'
5ba51621af try_compile: Propagate --trace through try_compile

Acked-by: Kitware Robot <kwrobot@kitware.com>
Tested-by: buildbot <buildbot@kitware.com>
Merge-request: !7757
2022-10-17 10:09:43 -04:00
Brad King
37fc2176dd Merge topic 'UseSWIG-perl5-language'
989b469f1c UseSWIG: Add support of perl5 language

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !7794
2022-10-17 10:08:37 -04:00
Brad King
0bf2e6aa44 Merge topic 'doc-timestamp-f'
7d25ae7350 Help: Add versionadded for string(TIMESTAMP) %f specifier

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !7796
2022-10-17 10:00:58 -04:00
Brad King
4cb8564087 Merge topic 'doc-timestamp-f' into release-3.25
7d25ae7350 Help: Add versionadded for string(TIMESTAMP) %f specifier

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !7796
2022-10-17 10:00:57 -04:00
Brad King
7780588d82 Merge branch 'doc-timestamp-f' into release-3.24
Merge-request: !7796
2022-10-14 11:33:14 -04:00
Brad King
7d25ae7350 Help: Add versionadded for string(TIMESTAMP) %f specifier
This was accidentally left out of commit c050d6a01e (string(TIMESTAMP):
add %f specifier for microseconds, 2022-01-27, v3.23.0-rc1~59^2).
2022-10-14 11:28:38 -04:00
Marc Chevrier
989b469f1c UseSWIG: Add support of perl5 language 2022-10-14 16:46:42 +02:00
Brad King
e4eebacfb6 Merge topic 'doc-typo'
f9fd27a5ee Help: Fix typo that crashes older pygments lexers

Acked-by: Kitware Robot <kwrobot@kitware.com>
Tested-by: Craig Scott <craig.scott@crascit.com>
Merge-request: !7792
2022-10-14 08:48:23 -04:00
Brad King
f9fd27a5ee Help: Fix typo that crashes older pygments lexers
In commit cb14ae2b87 (try_compile: Add SOURCE_FROM_{ARG,VAR},
2022-09-21, v3.25.0-rc1~94^2~2) we accidentally added unbalanced closing
`]` characters in the `try_compile` and `try_run` signatures.

Fixes: #24053
2022-10-13 12:04:00 -04:00
Brad King
2c9efa54f2 Merge topic 'doc-gen'
9e8b8bf4ef Help: Document version when COMPILE_LANGUAGE genex accepts multiple languages
16f37ea7a0 Help: Document comma-separation in some generator expressions

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !7784
2022-10-12 10:21:03 -04:00
Brad King
8cfd8a6486 Merge topic 'doc-gen' into release-3.25
9e8b8bf4ef Help: Document version when COMPILE_LANGUAGE genex accepts multiple languages
16f37ea7a0 Help: Document comma-separation in some generator expressions

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !7784
2022-10-12 10:21:02 -04:00
Brad King
127d732de1 Merge topic 'doc-cmake-E-subcommand-suboptions'
26020fdaae Help: Reference options of sub-commands in some older release notes (>= 3.20)
c3ec1b7411 Help: Replace the ref `cmake --workflow --preset` with `option` role
a0349eb13f Help: Make cmake(1) sub-command options look like other options

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !7782
2022-10-12 10:20:10 -04:00
Michael Hirsch
9e8b8bf4ef Help: Document version when COMPILE_LANGUAGE genex accepts multiple languages 2022-10-12 09:42:36 -04:00
Michael Hirsch
16f37ea7a0 Help: Document comma-separation in some generator expressions 2022-10-12 09:42:19 -04:00