mirror of
https://github.com/Kitware/CMake.git
synced 2026-01-06 05:40:54 -06:00
2a9cc3e8e8
The CMAKE_VERIFY_INTERFACE_HEADER_SETS variable is intended to be under the control of the user. It doesn't discriminate between header sets defined in the main project and those defined by dependencies brought into the build directly via FetchContent. Developers will usually only be interested in verifying the main project's header sets, not those from dependencies. Make the variable effectively only enable header set verification of the main project by turning it off during FetchContent_MakeAvailable() calls. The user still has variables like CMAKE_PROJECT_INCLUDE and CMAKE_PROJECT_<projectName>_INCLUDE available to them if they want to enable verification of all or specific dependencies respectively. Fixes: #23808
40 lines
1.7 KiB
ReStructuredText
40 lines
1.7 KiB
ReStructuredText
CMAKE_VERIFY_INTERFACE_HEADER_SETS
|
|
----------------------------------
|
|
|
|
.. versionadded:: 3.24
|
|
|
|
This variable is used to initialize the
|
|
:prop_tgt:`VERIFY_INTERFACE_HEADER_SETS` property of targets when they are
|
|
created. Setting it to true enables header set verification.
|
|
|
|
Projects should not normally set this variable, it is intended as a developer
|
|
control to be set on the :manual:`cmake(1)` command line or other
|
|
equivalent methods. The developer must have the ability to enable or
|
|
disable header set verification according to the capabilities of their own
|
|
machine and compiler.
|
|
|
|
Verification of a dependency's header sets is not typically of interest
|
|
to developers. Therefore, :command:`FetchContent_MakeAvailable` explicitly
|
|
sets ``CMAKE_VERIFY_INTERFACE_HEADER_SETS`` to false for the duration of its
|
|
call, but restores its original value before returning. If a project brings
|
|
a dependency directly into the main build (e.g. calling
|
|
:command:`add_subdirectory` on a vendored project from a git submodule), it
|
|
should also do likewise. For example:
|
|
|
|
.. code:: cmake
|
|
|
|
# Save original setting so we can restore it later
|
|
set(want_header_set_verification ${CMAKE_VERIFY_INTERFACE_HEADER_SETS})
|
|
|
|
# Include the vendored dependency with header set verification disabled
|
|
set(CMAKE_VERIFY_INTERFACE_HEADER_SETS OFF)
|
|
add_subdirectory(...) # Vendored sources, e.g. from git submodules
|
|
|
|
# Add the project's own sources. Restore the developer's original choice
|
|
# for whether to enable header set verification.
|
|
set(CMAKE_VERIFY_INTERFACE_HEADER_SETS ${want_header_set_verification})
|
|
add_subdirectory(src)
|
|
|
|
By default, this variable is not set, which will result in header set
|
|
verification being disabled.
|