cmake/Help/prop_tgt/LANG_CLANG_TIDY.rst

42 lines
1.5 KiB
ReStructuredText
Raw Normal View History

2016-07-09 11:21:54 +02:00
<LANG>_CLANG_TIDY
-----------------
2021-09-14 00:13:48 +02:00
.. versionadded:: 3.6
2022-11-16 20:14:03 +01:00
This property is implemented only when ``<LANG>`` is ``C``, ``CXX``, ``OBJC``
or ``OBJCXX``.
2016-07-09 11:21:54 +02:00
2022-11-16 20:14:03 +01:00
Specify a :ref:`semicolon-separated list <CMake Language Lists>` containing
a command line for the ``clang-tidy`` tool. The :ref:`Makefile Generators`
2016-07-09 11:21:54 +02:00
and the :generator:`Ninja` generator will run this tool along with the
compiler and report a warning if the tool reports any problems.
2022-11-16 20:14:03 +01:00
The specified ``clang-tidy`` command line will be invoked with additional
arguments specifying the source file and, after ``--``, the full compiler
command line.
.. versionchanged:: 3.25
If the specified ``clang-tidy`` command line includes the ``-p`` option,
it will be invoked without ``--`` and the full compiler command line.
``clang-tidy`` will look up the source file in the specified compiler
commands database.
2016-07-09 11:21:54 +02:00
This property is initialized by the value of
the :variable:`CMAKE_<LANG>_CLANG_TIDY` variable if it is set
when a target is created.
2023-07-02 19:51:09 +02:00
.. versionadded:: 3.27
This property supports
:manual:`generator expressions <cmake-generator-expressions(7)>`.
.. versionadded:: 3.27
:prop_sf:`SKIP_LINTING` can be set on individual source files to exclude
them from the linting tools defined by :prop_tgt:`<LANG>_CPPLINT`,
``<LANG>_CLANG_TIDY``, :prop_tgt:`<LANG>_CPPCHECK`, and
:prop_tgt:`<LANG>_INCLUDE_WHAT_YOU_USE`. When :prop_sf:`SKIP_LINTING` is
set to true on a source file, those tools will not be run on that specific
file.