summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorKyle Edwards <kyle.edwards@kitware.com>2023-06-05 20:42:12 (GMT)
committerKyle Edwards <kyle.edwards@kitware.com>2023-06-06 14:45:22 (GMT)
commit36ec89639ad84e194446795e36b69ab19e57e731 (patch)
tree106e619e527997387b09122fc5d513f6107af4c9 /Help
parent3760ac9845e3c0d163eb1b4d83ab5b2f367507aa (diff)
downloadCMake-36ec89639ad84e194446795e36b69ab19e57e731.zip
CMake-36ec89639ad84e194446795e36b69ab19e57e731.tar.gz
CMake-36ec89639ad84e194446795e36b69ab19e57e731.tar.bz2
VERIFY_INTERFACE_HEADER_SETS: Skip header files that have SKIP_LINTING
Fixes: #24972
Diffstat (limited to 'Help')
-rw-r--r--Help/prop_sf/SKIP_LINTING.rst5
-rw-r--r--Help/prop_tgt/VERIFY_INTERFACE_HEADER_SETS.rst3
2 files changed, 6 insertions, 2 deletions
diff --git a/Help/prop_sf/SKIP_LINTING.rst b/Help/prop_sf/SKIP_LINTING.rst
index 19592a8..0e0a616 100644
--- a/Help/prop_sf/SKIP_LINTING.rst
+++ b/Help/prop_sf/SKIP_LINTING.rst
@@ -7,8 +7,9 @@ This property allows you to exclude a specific source file
from the linting process. The linting process involves running
tools such as :prop_tgt:`<LANG>_CPPLINT`, :prop_tgt:`<LANG>_CLANG_TIDY`,
:prop_tgt:`<LANG>_CPPCHECK`, and :prop_tgt:`<LANG>_INCLUDE_WHAT_YOU_USE`
-on the source files. By setting ``SKIP_LINTING`` on a source file,
-the mentioned linting tools will not be executed for that
+on the source files, as well as compiling header files as part of
+:prop_tgt:`VERIFY_INTERFACE_HEADER_SETS`. By setting ``SKIP_LINTING`` on a
+source file, the mentioned linting tools will not be executed for that
particular file.
Example
diff --git a/Help/prop_tgt/VERIFY_INTERFACE_HEADER_SETS.rst b/Help/prop_tgt/VERIFY_INTERFACE_HEADER_SETS.rst
index dd415c8..bdd7792 100644
--- a/Help/prop_tgt/VERIFY_INTERFACE_HEADER_SETS.rst
+++ b/Help/prop_tgt/VERIFY_INTERFACE_HEADER_SETS.rst
@@ -26,6 +26,9 @@ Otherwise, if C++ is enabled globally, the header is compiled as C++.
Otherwise, if C is enabled globally, the header is compiled as C. Otherwise,
the header file is not compiled.
+If the header's :prop_sf:`SKIP_LINTING` property is set to true, the file is
+not compiled.
+
If any verification targets are created, a top-level target called
``all_verify_interface_header_sets`` is created which depends on all
verification targets.