Files
CMake/Help/prop_tgt/SKIP_LINTING.rst
T
Alex Turbov f100769d72 Add SKIP_LINTING target property and CMAKE_SKIP_LINTING variable
These offer target-wide settings to disable lints.

Closes: #27191
2025-09-09 09:56:35 -04:00

26 lines
977 B
ReStructuredText
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
SKIP_LINTING
------------
.. versionadded:: 4.2
Exclude all sources of a target from running configured linting tools.
When this boolean property is enabled on a target, C/C++ linting tools enabled
for that target (e.g. :prop_tgt:`<LANG>_CPPLINT`, :prop_tgt:`<LANG>_CLANG_TIDY`,
:prop_tgt:`<LANG>_CPPCHECK`, :prop_tgt:`<LANG>_ICSTAT` and
:prop_tgt:`<LANG>_INCLUDE_WHAT_YOU_USE`) will not be invoked for source files
compiled by the target. If the :prop_sf:`SKIP_LINTING` source-file property
is set on a specific source, it takes precedence over this target-wide property.
This is a convenience alternative to setting the :prop_sf:`SKIP_LINTING`
source file property individually on each source. If either the target's
:prop_tgt:`SKIP_LINTING` or a sources :prop_sf:`SKIP_LINTING` is enabled,
that source will be excluded from linting.
The property has no effect on targets that do not have sources.
See Also
^^^^^^^^
* :prop_sf:`SKIP_LINTING` source file property