Merge topic 'patch-CheckIncludeFile'

b2e7736d81 CheckIncludeFile*: Sync documentation

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !10826
This commit is contained in:
Brad King
2025-05-28 12:55:25 +00:00
committed by Kitware Robot
6 changed files with 140 additions and 48 deletions

View File

@@ -7,18 +7,18 @@ Include file check macros honor ``CMAKE_REQUIRED_LIBRARIES``.
In CMake 3.12 and above, the
* ``check_include_file`` macro in the :module:`CheckIncludeFile` module, the
* ``check_include_file_cxx`` macro in the
* ``check_include_file()`` command in the :module:`CheckIncludeFile` module, the
* ``check_include_file_cxx()`` command in the
:module:`CheckIncludeFileCXX` module, and the
* ``check_include_files`` macro in the :module:`CheckIncludeFiles` module
* ``check_include_files()`` command in the :module:`CheckIncludeFiles` module
now prefer to link the check executable to the libraries listed in the
``CMAKE_REQUIRED_LIBRARIES`` variable. This policy provides compatibility
with projects that have not been updated to expect this behavior.
The ``OLD`` behavior for this policy is to ignore ``CMAKE_REQUIRED_LIBRARIES``
in the include file check macros. The ``NEW`` behavior of this policy is to
honor ``CMAKE_REQUIRED_LIBRARIES`` in the include file check macros.
in the include file check commands. The ``NEW`` behavior of this policy is to
honor ``CMAKE_REQUIRED_LIBRARIES`` in the include file check commands.
.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.12
.. |WARNS_OR_DOES_NOT_WARN| replace:: warns

View File

@@ -276,9 +276,9 @@ Changes made since CMake 3.11.0 include the following.
3.11.1
------
* The :module:`CheckIncludeFile` module ``check_include_file`` macro,
:module:`CheckIncludeFileCXX` module ``check_include_file_cxx`` macro,
and :module:`CheckIncludeFiles` module ``check_include_files`` macro
* The :module:`CheckIncludeFile` module ``check_include_file()`` command,
:module:`CheckIncludeFileCXX` module ``check_include_file_cxx()`` command,
and :module:`CheckIncludeFiles` module ``check_include_files()`` command
were taught to honor the ``CMAKE_REQUIRED_LIBRARIES`` variable in
CMake 3.11.0. This has been reverted due to changing behavior of
checks for existing projects. It may be restored in the future

View File

@@ -282,15 +282,15 @@ Other Changes
:command:`install` documentation so that external packaging software can take
advantage of CPack-style component installs.
* The :module:`CheckIncludeFile` module ``check_include_file`` macro
* The :module:`CheckIncludeFile` module ``check_include_file()`` command
learned to honor the ``CMAKE_REQUIRED_LIBRARIES`` variable.
See policy :policy:`CMP0075`.
* The :module:`CheckIncludeFileCXX` module ``check_include_file_cxx`` macro
* The :module:`CheckIncludeFileCXX` module ``check_include_file_cxx()`` command
learned to honor the ``CMAKE_REQUIRED_LIBRARIES`` variable.
See policy :policy:`CMP0075`.
* The :module:`CheckIncludeFiles` module ``check_include_files`` macro
* The :module:`CheckIncludeFiles` module ``check_include_files()`` command
learned to honor the ``CMAKE_REQUIRED_LIBRARIES`` variable.
See policy :policy:`CMP0075`.