diff options
author | Orkun Tokdemir <ilhanorkuntokdemir@gmail.com> | 2023-05-12 14:49:03 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2023-05-16 14:47:56 (GMT) |
commit | b480315e0c229454c335290b19cc689930d7849f (patch) | |
tree | fd6c95e7d53d4a9c095947ba7cd718e0ce1ae60f /Help | |
parent | 993dde925f208d98c68edcd451b0d6979e0abdd4 (diff) | |
download | CMake-b480315e0c229454c335290b19cc689930d7849f.zip CMake-b480315e0c229454c335290b19cc689930d7849f.tar.gz CMake-b480315e0c229454c335290b19cc689930d7849f.tar.bz2 |
TargetGenerator: Add SKIP_LINTING source property
The `SKIP_LINTING` source property was added to disable code check for
desired source files. The `SKIP_LINTING`includes `cpplint`, `clang-tidy`, \
`cppcheck` and `include-what-you-use`. If `SKIP_LINTING` is set on a
source file, the tools mentioned above will not be run on that source file.
Diffstat (limited to 'Help')
-rw-r--r-- | Help/manual/cmake-properties.7.rst | 1 | ||||
-rw-r--r-- | Help/prop_sf/SKIP_LINTING.rst | 41 | ||||
-rw-r--r-- | Help/prop_tgt/LANG_CLANG_TIDY.rst | 7 | ||||
-rw-r--r-- | Help/prop_tgt/LANG_CPPCHECK.rst | 7 | ||||
-rw-r--r-- | Help/prop_tgt/LANG_CPPLINT.rst | 7 | ||||
-rw-r--r-- | Help/prop_tgt/LANG_INCLUDE_WHAT_YOU_USE.rst | 7 | ||||
-rw-r--r-- | Help/release/dev/skip-linting.rst | 5 |
7 files changed, 75 insertions, 0 deletions
diff --git a/Help/manual/cmake-properties.7.rst b/Help/manual/cmake-properties.7.rst index 8ee5573..b8026ef 100644 --- a/Help/manual/cmake-properties.7.rst +++ b/Help/manual/cmake-properties.7.rst @@ -559,6 +559,7 @@ Properties on Source Files /prop_sf/SKIP_AUTOUIC /prop_sf/SKIP_PRECOMPILE_HEADERS /prop_sf/SKIP_UNITY_BUILD_INCLUSION + /prop_sf/SKIP_LINTING /prop_sf/Swift_DEPENDENCIES_FILE /prop_sf/Swift_DIAGNOSTICS_FILE /prop_sf/SYMBOLIC diff --git a/Help/prop_sf/SKIP_LINTING.rst b/Help/prop_sf/SKIP_LINTING.rst new file mode 100644 index 0000000..2be47cb --- /dev/null +++ b/Help/prop_sf/SKIP_LINTING.rst @@ -0,0 +1,41 @@ +SKIP_LINTING +------------ + +.. versionadded:: 3.27 + +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 +particular file. + +EXAMPLE +^^^^^^^ + +Consider a `C++` project that includes multiple source files, +such as `main.cpp`, `things.cpp`, and `generatedBindings.cpp`. +In this example, you want to exclude the `generatedBindings.cpp` +file from the linting process. To achieve this, you can utilize +the `SKIP_LINTING` property with the `set_source_files_properties` +command as shown below: + +.. code-block:: cmake + + add_executable(MyApp main.cpp things.cpp generatedBindings.cpp) + + set_source_files_properties(generatedBindings.cpp PROPERTIES + SKIP_LINTING ON + ) + +In the provided code snippet, the `SKIP_LINTING` property is set to `ON` +for the `generatedBindings.cpp` source file. As a result, when the linting +tools, such as :prop_tgt:`<LANG>_CPPLINT`, :prop_tgt:`<LANG>_CLANG_TIDY`, +:prop_tgt:`<LANG>_CPPCHECK`, and :prop_tgt:`<LANG>_INCLUDE_WHAT_YOU_USE`, +are executed, they will skip analyzing the `generatedBindings.cpp` file. + +By using the `SKIP_LINTING` property, you can selectively exclude specific +source files from the linting process. This allows you to focus the +linting tools on the relevant parts of your project, enhancing the efficiency +and effectiveness of the linting workflow. diff --git a/Help/prop_tgt/LANG_CLANG_TIDY.rst b/Help/prop_tgt/LANG_CLANG_TIDY.rst index 1e10933..0e46643 100644 --- a/Help/prop_tgt/LANG_CLANG_TIDY.rst +++ b/Help/prop_tgt/LANG_CLANG_TIDY.rst @@ -30,3 +30,10 @@ when a target is created. This property supports :manual:`generator expressions <cmake-generator-expressions(7)>`. + + :prop_sf:`SKIP_LINTING` can be set on individual source files to exclude + them from the linting process, which includes tools like + :prop_tgt:`<LANG>_CPPLINT`, :prop_tgt:`<LANG>_CLANG_TIDY`, + :prop_tgt:`<LANG>_CPPCHECK`, and :prop_tgt:`<LANG>_INCLUDE_WHAT_YOU_USE`. + When :prop_sf:`SKIP_LINTING` is set on a source file, the mentioned tools + will not be run on that specific file. diff --git a/Help/prop_tgt/LANG_CPPCHECK.rst b/Help/prop_tgt/LANG_CPPCHECK.rst index 0b2dee6..3ab2b58 100644 --- a/Help/prop_tgt/LANG_CPPCHECK.rst +++ b/Help/prop_tgt/LANG_CPPCHECK.rst @@ -20,3 +20,10 @@ created. This property supports :manual:`generator expressions <cmake-generator-expressions(7)>`. + + :prop_sf:`SKIP_LINTING` can be set on individual source files to exclude + them from the linting process, which includes tools like + :prop_tgt:`<LANG>_CPPLINT`, :prop_tgt:`<LANG>_CLANG_TIDY`, + :prop_tgt:`<LANG>_CPPCHECK`, and :prop_tgt:`<LANG>_INCLUDE_WHAT_YOU_USE`. + When :prop_sf:`SKIP_LINTING` is set on a source file, the mentioned tools + will not be run on that specific file. diff --git a/Help/prop_tgt/LANG_CPPLINT.rst b/Help/prop_tgt/LANG_CPPLINT.rst index 38a1669..cb230d3 100644 --- a/Help/prop_tgt/LANG_CPPLINT.rst +++ b/Help/prop_tgt/LANG_CPPLINT.rst @@ -18,3 +18,10 @@ created. This property supports :manual:`generator expressions <cmake-generator-expressions(7)>`. + + :prop_sf:`SKIP_LINTING` can be set on individual source files to exclude + them from the linting process, which includes tools like + :prop_tgt:`<LANG>_CPPLINT`, :prop_tgt:`<LANG>_CLANG_TIDY`, + :prop_tgt:`<LANG>_CPPCHECK`, and :prop_tgt:`<LANG>_INCLUDE_WHAT_YOU_USE`. + When :prop_sf:`SKIP_LINTING` is set on a source file, the mentioned tools + will not be run on that specific file. diff --git a/Help/prop_tgt/LANG_INCLUDE_WHAT_YOU_USE.rst b/Help/prop_tgt/LANG_INCLUDE_WHAT_YOU_USE.rst index 19b97f7..8fbe84a 100644 --- a/Help/prop_tgt/LANG_INCLUDE_WHAT_YOU_USE.rst +++ b/Help/prop_tgt/LANG_INCLUDE_WHAT_YOU_USE.rst @@ -18,3 +18,10 @@ when a target is created. This property supports :manual:`generator expressions <cmake-generator-expressions(7)>`. + + :prop_sf:`SKIP_LINTING` can be set on individual source files to exclude + them from the linting process, which includes tools like + :prop_tgt:`<LANG>_CPPLINT`, :prop_tgt:`<LANG>_CLANG_TIDY`, + :prop_tgt:`<LANG>_CPPCHECK`, and :prop_tgt:`<LANG>_INCLUDE_WHAT_YOU_USE`. + When :prop_sf:`SKIP_LINTING` is set on a source file, the mentioned tools + will not be run on that specific file. diff --git a/Help/release/dev/skip-linting.rst b/Help/release/dev/skip-linting.rst new file mode 100644 index 0000000..199571c --- /dev/null +++ b/Help/release/dev/skip-linting.rst @@ -0,0 +1,5 @@ +skip-linting +------------ + +* The :prop_sf:`SKIP_LINTING` source file property was added to suppress + target-wide code checks on specific sources. |