Browse Source

Help: Add example to CMAKE_<LANG>_CLANG_TIDY

Fixes: #16869
Brad King 7 years ago
parent
commit
ae09bc774b
1 changed files with 9 additions and 2 deletions
  1. 9 2
      Help/variable/CMAKE_LANG_CLANG_TIDY.rst

+ 9 - 2
Help/variable/CMAKE_LANG_CLANG_TIDY.rst

@@ -1,6 +1,13 @@
 CMAKE_<LANG>_CLANG_TIDY
 -----------------------
 
-Default value for :prop_tgt:`<LANG>_CLANG_TIDY` target property.
+Default value for :prop_tgt:`<LANG>_CLANG_TIDY` target property
+when ``<LANG>`` is ``C`` or ``CXX``.
+
 This variable is used to initialize the property on each target as it is
-created.  This is done only when ``<LANG>`` is ``C`` or ``CXX``.
+created.  For example:
+
+.. code-block:: cmake
+
+  set(CMAKE_CXX_CLANG_TIDY clang-tidy checks=-*,readability-*)
+  add_executable(foo foo.cxx)