summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2018-04-24 15:06:52 (GMT)
committerKitware Robot <kwrobot@kitware.com>2018-04-24 15:08:03 (GMT)
commitd4b97e8d721e5a5374a400bcdd5df1eb4e1cf7d2 (patch)
tree0bd842220e0a8684efaf300f4210179b74d3fee5 /Help
parent195400cab7256d655d313c5155880dad5545becc (diff)
parentae09bc774be73def29e9878e28db9fa4cff53204 (diff)
downloadCMake-d4b97e8d721e5a5374a400bcdd5df1eb4e1cf7d2.zip
CMake-d4b97e8d721e5a5374a400bcdd5df1eb4e1cf7d2.tar.gz
CMake-d4b97e8d721e5a5374a400bcdd5df1eb4e1cf7d2.tar.bz2
Merge topic 'doc-tidy-example'
ae09bc774b Help: Add example to CMAKE_<LANG>_CLANG_TIDY Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !2002
Diffstat (limited to 'Help')
-rw-r--r--Help/variable/CMAKE_LANG_CLANG_TIDY.rst11
1 files changed, 9 insertions, 2 deletions
diff --git a/Help/variable/CMAKE_LANG_CLANG_TIDY.rst b/Help/variable/CMAKE_LANG_CLANG_TIDY.rst
index 492c12c..d1fccbb 100644
--- a/Help/variable/CMAKE_LANG_CLANG_TIDY.rst
+++ b/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)