Commit Graph

6473 Commits

Author SHA1 Message Date
Alex Turbov
65457e4fae Help: Add _See Also_ sections to related CMake commands 2022-11-09 23:52:30 +04:00
Alex Turbov
c86ec79d07 Help: Use direct refs to genexes instead of `$<GENEX-NAME>` 2022-11-09 23:52:30 +04:00
Alex Turbov
8c6274326d Help: Use CMake highlighting for command synopsis
Most of CMake commands use it. Fix a few of them to do the same.
2022-11-09 23:52:30 +04:00
Alex Turbov
c356a94512 Help: Use monospaced font for a genex name in a section title 2022-11-09 23:52:29 +04:00
Alex Turbov
f98c8707f4 Help: Use code-block:: cmake instead of :: for sub-commands descriptions
Most of CMake commands use syntax highlighting when describe
sub-commands syntax. Fix a few of them to be like others...
2022-11-07 22:55:07 +04:00
Alex Turbov
2ba351ca4f Help: `CMake` → CMake 2022-11-07 22:55:06 +04:00
Alex Turbov
cc8837606c Help: Unindent _See Also_ related commands list
To make it similar to other commands.
2022-11-07 22:55:06 +04:00
Alex Turbov
c9eb090902 Help: Use caption option of code-block for JSON trace format snippets 2022-11-07 22:55:06 +04:00
Alex Turbov
029210730a Help: Use role :program:
When mention execitable names use Sphinx semantic role `:program`
instead of ``executable`` or **executable**.
2022-11-06 04:28:21 +04:00
Alex Turbov
295062ef4b Help: Add some more :option: role to cmake-language(7) manual 2022-11-06 03:43:30 +04:00
Alex Turbov
8a3e732b9b Help: Add ATTENTION for comments in the cmake-language(7) manual
Some editors (OK, mine, I use `kate`) highlight some capitalized
"keywords" (like `TODO`, `NOTE`, &etc)  in comments.
2022-11-06 03:41:07 +04:00
Brad King
7d63cc5443 Merge branch 'release-3.24' 2022-11-01 12:58:44 -04:00
Brad King
c974557598 CMake 3.24.3 2022-11-01 10:55:49 -04:00
Brad King
6aee07edb5 Merge branch 'release-3.23' 2022-11-01 10:41:00 -04:00
Brad King
d697bbd03d Merge branch 'release-3.23' into release-3.24 2022-11-01 10:40:34 -04:00
Brad King
91ccfa3302 CMake 3.23.5 2022-11-01 09:36:33 -04:00
Brad King
a9d5a0bf4b Merge topic 'compile-commands-output-field'
887a8874c3 EXPORT_COMPILE_COMMANDS: add `output` field

Acked-by: Kitware Robot <kwrobot@kitware.com>
Tested-by: buildbot <buildbot@kitware.com>
Merge-request: !7844
2022-11-01 09:02:15 -04:00
Ben Boeckel
887a8874c3 EXPORT_COMPILE_COMMANDS: add output field
Also write for all configurations from multi-config generators.

This field was added in the Clang 5 documentation and not present in the
Clang 4 documentation (sometime between Dec 2016 and Mar 2017 according
to `web.archive.org`).
2022-10-28 13:54:43 -04:00
ζeh Matt
eef13a4b33 VS: Add COMMON_LANGUAGE_RUNTIME support for "netcore"
Generate `CLRSupport` for Visual Studio projects.

Fixes: #22054
2022-10-28 11:55:58 -04:00
Brad King
0815329dbc Help: Format COMMON_LANGUAGE_RUNTIME values as a definition list 2022-10-28 11:55:14 -04:00
Brad King
94983f1d96 Merge topic 'timestamp-timezone'
9da542d5c1 string(TIMESTAMP): Add %z and %Z for adding time zone string

Acked-by: Kitware Robot <kwrobot@kitware.com>
Acked-by: buildbot <buildbot@kitware.com>
Merge-request: !7788
2022-10-28 10:04:47 -04:00
Brad King
6b27854d26 Merge topic 'tutorial_step7_update'
f9ef15f3dc Tutorial: Update step 7 style

Acked-by: Kitware Robot <kwrobot@kitware.com>
Acked-by: buildbot <buildbot@kitware.com>
Merge-request: !7787
2022-10-28 10:03:10 -04:00
Brad King
907bfc661b Merge topic 'tutorial_step5_cleanup'
43f87741f4 Tutorial: Fix Step 5 solution after update to Step 6

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !7838
2022-10-28 10:02:20 -04:00
Craig Scott
e9a2a812a3 Merge topic 'doc-config-postfix'
3fc2dcd801 Help: Minor formatting and cross-ref cleanup for <CONFIG>_POSTFIX

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !7841
2022-10-28 07:25:58 -04:00
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