Commit Graph

8318 Commits

Author SHA1 Message Date
Brad King
e3f728e4dc Merge topic 'patch-CMakeDependentOption'
67055f5b3a CMakeDependentOption: Update documentation

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !10563
2025-04-01 11:10:04 -04:00
Brad King
908814cda0 Merge topic 'iar-help-compiler-arch-id'
775e532afb IAR: Update documentation for CMAKE_<LANG>_COMPILER_ARCHITECTURE_ID

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !10548
2025-03-31 09:45:15 -04:00
Peter Kokot
67055f5b3a CMakeDependentOption: Update documentation
This updates the module documentation to be more synced with other
modules. Also, this module on the first glance doesn't do what most
people might think. Because when condition evaluates to false, internal
cache remains with the same value, and a local variable is created with
the value provided in the last argument.

- Command arguments described separately and their placeholders renamed
  to more intuitive names.
- More examples added, starting with a very basic syntax usage to more
  complex ones, each described in more details.
- Each example has include() added to be more clear that this is a
  module command.
2025-03-31 02:42:49 +02:00
Craig Scott
eab202ac9d Merge topic 'doc-4.0-release-cleanup'
5dff5e2f7f Help: Fix typo in 4.0 release notes for CPack archive generator
713968c280 Help: Improve wording of docs related to MSVC runtime checks
316aaa6cdd Help: Fix inaccurate wording for CMAKE_XCODE_SCHEME_... variables

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !10545
2025-03-30 06:00:08 -04:00
Craig Scott
cf9f4177a2 Merge topic 'doc-cpack-configs'
d289d720cb Help: Use consistent plural form for CPack configurations

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !10546
2025-03-30 05:55:58 -04:00
Brad King
e0b64aad53 Merge topic 'remove-FindCABLE'
2b8b17106c FindCABLE: Add policy to remove this module
3c2ed4bbc6 FindGCCXML: Move documentation to list of deprecated modules

Acked-by: Kitware Robot <kwrobot@kitware.com>
Acked-by: buildbot <buildbot@kitware.com>
Merge-request: !10540
2025-03-28 09:16:34 -04:00
Brad King
883ba45df8 Merge topic 'patch-CMakeFindPackageMode'
e9b86f5618 CMakeFindPackageMode: Move documentation to --find-package option

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !10537
2025-03-28 09:12:32 -04:00
Felipe Torrezan
775e532afb IAR: Update documentation for CMAKE_<LANG>_COMPILER_ARCHITECTURE_ID 2025-03-28 10:47:37 +01:00
Craig Scott
d289d720cb Help: Use consistent plural form for CPack configurations 2025-03-28 15:46:12 +11:00
Craig Scott
5dff5e2f7f Help: Fix typo in 4.0 release notes for CPack archive generator 2025-03-28 14:23:47 +11:00
Craig Scott
713968c280 Help: Improve wording of docs related to MSVC runtime checks 2025-03-28 14:23:47 +11:00
Craig Scott
316aaa6cdd Help: Fix inaccurate wording for CMAKE_XCODE_SCHEME_... variables 2025-03-28 14:23:46 +11:00
Peter Kokot
e9b86f5618 CMakeFindPackageMode: Move documentation to --find-package option
- This moves the CMakeFindPackageMode internal module documentation to
  the --find-package option as this module itself cannot be used by the
  project.
- Additionally, some links added.
- The `QUIET` variable renamed in documentation to `SILENT` to be
  effective according to the current code.
2025-03-27 15:29:36 +01:00
Brad King
2b8b17106c FindCABLE: Add policy to remove this module
CABLE has not been maintained in a long time.
2025-03-27 09:48:49 -04:00
Brad King
3c2ed4bbc6 FindGCCXML: Move documentation to list of deprecated modules
This was left out of commit 2123244746 (FindGCCXML: Add policy to remove
this module, 2025-02-17).
2025-03-27 09:48:49 -04:00
Brad King
f403e570eb Merge topic 'compiler-architecture-id'
7f0f382c55 Provide CMAKE_<LANG>_COMPILER_ARCHITECTURE_ID on more compilers
019f0f8b32 ARCHITECTURE_ID: Save persistently even if empty
8e46672b29 Fortran: Detect pointer size on sparc architectures
eddf66eaef CMakeDetermineASMCompiler: De-duplicate list of compiler info variables
c0224f5aa1 CMakeDetermineCompilerABI: Make ABI info string more robust
67ab580804 Windows/Clang: Fix indentation in platform information module
1c9f8eeb4f Help: Document CMAKE_<LANG>_COMPILER_ARCHITECTURE_ID

Acked-by: Kitware Robot <kwrobot@kitware.com>
Acked-by: buildbot <buildbot@kitware.com>
Merge-request: !10516
2025-03-27 09:21:48 -04:00
Brad King
54b548df7b Merge topic 'macos-bundle-content-dir'
6b3ec3fefb Ninja/Makefile: Add support for copying directories into Apple bundles

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !10508
2025-03-27 09:19:52 -04:00
Brad King
ffad375ab1 Merge topic 'fix-CMAKE_PKG_CONFIG_PC_PATH-doc-typo-error'
a57eec57e5 Help: Fix typo in CMAKE_PKG_CONFIG_PC_PATH docs

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !10530
2025-03-27 09:07:41 -04:00
Brad King
777d3eaf55 Help: Normalize cmake-modules(7) section heading underline style
Convert section heading underlines to our normal style hierarchy,
`****** > ====== > ------`, as recommended in Sphinx documentation.
2025-03-26 15:14:11 -04:00
Junpeng Qiu
6b3ec3fefb Ninja/Makefile: Add support for copying directories into Apple bundles
When the `MACOSX_PACKAGE_LOCATION` property is set on a directory, Xcode
copies the entire directory into the bundle.  Implement this on Ninja
and Makefile generators too.

Fixes: #26808
Co-authored-by: Brad King <brad.king@kitware.com>
2025-03-26 14:51:26 -04:00
權少
a57eec57e5 Help: Fix typo in CMAKE_PKG_CONFIG_PC_PATH docs 2025-03-26 09:11:35 -04:00
Brad King
4604d48c63 Merge topic 'patch-TEST_INCLUDE_FILE-docs'
1666b715eb TEST_INCLUDE_{FILE,FILES}: Update documentation

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !10515
2025-03-25 10:45:02 -04:00
Brad King
08a84180b5 Merge topic 'patch-CMAKE_CFG_INTDIR'
a180240af3 Help: Move CMAKE_CFG_INTDIR to deprecated section

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !10513
2025-03-25 10:41:21 -04:00
Brad King
f37d0f33b2 Merge topic 'patch-CTEST_CVS_CHECKOUT'
77d23eaa8f CTEST_CVS_CHECKOUT: Add deprecated directive to docs

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !10512
2025-03-25 10:36:29 -04:00
Brad King
c4c2cdda7e Merge topic 'patch-QCC'
39d6672e82 Help: Document QCC and SCO CMAKE_<LANG>_COMPILER_ID

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !10506
2025-03-25 10:24:24 -04:00
Brad King
0f7a8e457f Merge topic 'patch-FindQt4'
e60bdd1014 FindQt4: Update documentation

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !10497
2025-03-25 09:43:17 -04:00
Brad King
468ed369b4 Merge topic 'patch-FindGDAL'
9eb91c8bd3 FindGDAL: Move to list of deprecated modules

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !10499
2025-03-25 09:40:01 -04:00
Brad King
7f0f382c55 Provide CMAKE_<LANG>_COMPILER_ARCHITECTURE_ID on more compilers
Provide it whenever we can detect a target architecture from the
compiler during compiler inspection.  In order to avoid changing
existing IDs, do this only for compilers where we don't already
detect a target architecture during compiler identification.

Fixes: #17702
2025-03-25 09:30:36 -04:00
Brad King
1c9f8eeb4f Help: Document CMAKE_<LANG>_COMPILER_ARCHITECTURE_ID
Issue: #17702
2025-03-24 12:22:22 -04:00
Peter Kokot
9eb91c8bd3 FindGDAL: Move to list of deprecated modules
The module was deprecated by commit 7e2aee4458 (FindGDAL: Document as
deprecated in favor of upstream CMake package, 2024-11-26,
v4.0.0-rc1~409^2).  Move the module to the list of deprecated modules.

Issue: #26471
2025-03-24 11:01:09 -04:00
Peter Kokot
1666b715eb TEST_INCLUDE_{FILE,FILES}: Update documentation
The TEST_INCLUDE_FILE directory property got deprecated in CMake 3.10
and TEST_INCLUDE_FILES should be used instead. This extends descriptions
a bit to better understand this property.
2025-03-24 14:47:55 +01:00
Peter Kokot
77d23eaa8f CTEST_CVS_CHECKOUT: Add deprecated directive to docs
This variable got introduced in CMake 2.4 and was documented as
deprecated in CMake 3.1.
2025-03-24 01:06:29 +01:00
Peter Kokot
a180240af3 Help: Move CMAKE_CFG_INTDIR to deprecated section 2025-03-24 00:54:18 +01:00
Peter Kokot
39d6672e82 Help: Document QCC and SCO CMAKE_<LANG>_COMPILER_ID
- QNX C/C++ compiler is identified in `CMAKE_<LANG>_COMPILER_ID` as
  value "QCC". The qcc/q++ are frontend compiler commands that invoke
  the GNU compiler (gcc/g++) as a backend compiler, but it's treated as
  a separate compiler with its own ID for better determination.

- The C/C++ compiler on UnixWare/OpenServer is identified in
  `CMAKE_<LANG>_COMPILER_ID` as value "SCO", (compiler that defines the
  `__SCO_VERSION__` preprocessor macro).
2025-03-23 15:32:26 +01:00
Peter Kokot
e60bdd1014 FindQt4: Update documentation
Changes:
- Lowercase style used for Qt4 macros
- Module documentation reformatted similar to other pages
- Module commands listed using the RST `:command:` directive,
  descriptions refactored and arguments described separately
2025-03-21 17:13:18 +01:00
Peter Kokot
acba9cb083 execute_process: Document {OUTPUT,ERROR}_STRIP_TRAILING_WHITESPACE 2025-03-21 03:02:10 +01:00
Brad King
97246b2083 Merge topic 'ctest-schedule-random-seed'
d3455f38de ctest: Add option to specify the --schedule-random seed
3dc8e59bdc ctest: Record --schedule-random seed in test log

Acked-by: Kitware Robot <kwrobot@kitware.com>
Acked-by: buildbot <buildbot@kitware.com>
Acked-by: Nadav Tenenbaum <tnadav@gmail.com>
Acked-by: Hagai Cohen <hagai.co@gmail.com>
Acked-by: Toplica Tanasković <toplicius@gmail.com>
Acked-by: Itay Bookstein <itay.bookstein@nextsilicon.com>
Acked-by: Ilan Tayari <ilan@nextsilicon.com>
Acked-by: Adnan Hodzic <adnan.hodzic@nextsilicon.com>
Merge-request: !10488
2025-03-20 09:11:24 -04:00
Brad King
a28d24ce13 Merge topic 'pkgc-variable-docs'
8817f3b131 PkgC: Document cmake variables

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !10493
2025-03-20 08:54:24 -04:00
Brad King
68475b77d2 Merge topic 'pkgc-variable-docs' into release-4.0
8817f3b131 PkgC: Document cmake variables

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !10493
2025-03-20 08:54:21 -04:00
Brad King
deb44bdf73 Merge topic 'instrumentation-snippet-names'
39f365ec3c instrumentation: Unique snippet file names

Acked-by: Kitware Robot <kwrobot@kitware.com>
Tested-by: buildbot <buildbot@kitware.com>
Merge-request: !10491
2025-03-19 09:05:56 -04:00
Vito Gamberini
8817f3b131 PkgC: Document cmake variables 2025-03-19 07:58:31 -04:00
Daniel Goldberg
d3455f38de ctest: Add option to specify the --schedule-random seed
When `--schedule-random` is used in automated CI jobs, failures may
occur due to test order.  We now log the seed.  Provide a way for
developers to re-run the same order by specifying the seed.

Fixes: #26760
Co-authored-by: Brad King <brad.king@kitware.com>
2025-03-18 14:17:59 -04:00
Martin Duffy
39f365ec3c instrumentation: Unique snippet file names
Updates the hash in snippet file naming to take the ProcessId into account
so that snippets with identical commands don't risk a collision in filename.

Additionally, this adds a `workingDir` to snippet files so that snippets with
identical commands can be more easily differentiated, such as with install
snippets.
2025-03-18 13:23:02 -04:00
Brad King
ff197bc744 Merge topic 'patch-debug-configurations'
99546ef425 Help: Improve DEBUG_CONFIGURATIONS documentation and usage

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !10477
2025-03-18 09:42:51 -04:00
Brad King
aecd6bcb1b Merge topic 'doc-CMAKE_CONFIG_DIR'
bbbbab4661 Help: Add 3.31 release note for CMAKE_CONFIG_DIR

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !10474
2025-03-18 09:21:05 -04:00
Brad King
a64c571a32 Merge topic 'doc-CMAKE_CONFIG_DIR' into release-4.0
bbbbab4661 Help: Add 3.31 release note for CMAKE_CONFIG_DIR

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !10474
2025-03-18 09:21:03 -04:00
Peter Kokot
bbbbab4661 Help: Add 3.31 release note for CMAKE_CONFIG_DIR
This was accidentally left out of commit 1df94443fe (fileapi: Add
support for user-wide queries, 2024-08-16, v3.31.0-rc1~177^2).
2025-03-17 11:57:15 -04:00
Brad King
c005babf89 Merge topic 'pkgc-name-prefix'
f59bab006d PkgC: Add NAME and PREFIX

Acked-by: Kitware Robot <kwrobot@kitware.com>
Tested-by: buildbot <buildbot@kitware.com>
Merge-request: !10473
2025-03-17 11:52:18 -04:00
Peter Kokot
99546ef425 Help: Improve DEBUG_CONFIGURATIONS documentation and usage
This adds a short example demonstrating how to set this property.
Additionally, a paragraph is added to the target_link_libraries() and
its debug/optimized keywords to mention that imported targets with
IMPORTED_CONFIGURATIONS property may provide better alternative for
linking.
2025-03-15 15:47:51 +01:00
Vito Gamberini
f59bab006d PkgC: Add NAME and PREFIX
Fixes: #26067
2025-03-14 15:17:27 -04:00