mirrors/cmake
2
0
Fork 0
mirror of https://gitlab.kitware.com/cmake/cmake.git synced 2026-09-25 04:09:36 +03:00
Code Activity

FILE_SET: add SKIP_LINTING property support

Browse Source
This commit is contained in:
Marc Chevrier
2026-05-04 10:16:06 +02:00
parent 4cf5bc2a85
commit f18ba89862
14 changed files with 196 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Help/manual/cmake-properties.7.rst
+1
View File
@@ -552,6 +552,7 @@ Properties on File Sets
/prop_fs/INTERFACE_INCLUDE_DIRECTORIES
/prop_fs/INTERFACE_SOURCES
/prop_fs/SCOPE
/prop_fs/SKIP_LINTING
/prop_fs/SOURCES
/prop_fs/TYPE
Help/prop_fs/SKIP_LINTING.rst
+54
View File
@@ -0,0 +1,54 @@
SKIP_LINTING
------------
.. versionadded:: 4.4
This property allows you to exclude a source files of the specific file set
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`, :prop_tgt:`<LANG>_ICSTAT`,
:prop_tgt:`<LANG>_PVS_STUDIO` and :prop_tgt:`<LANG>_INCLUDE_WHAT_YOU_USE` on
the source files, as well as compiling header files as part of
:prop_tgt:`VERIFY_INTERFACE_HEADER_SETS`. By setting ``SKIP_LINTING`` on a
file set, the mentioned linting tools will not be executed for the files of
that particular file set. If the :prop_fs:`SKIP_LINTING` file set property
is set, it takes precedence over this source-file and target-wide properties.
This is a convenience alternative to setting the :prop_sf:`SKIP_LINTING`
source file property individually on each source.
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 ``things.cpp`` and
``generatedBindings.cpp`` files from the linting process. To achieve this, you
can use a file set and utilize the ``SKIP_LINTING`` property with the
:command:`set_property(FILE_SET) <set_property>` command as shown below:
.. code-block:: cmake
add_executable(MyApp main.cpp)
target_sources(MyApp PRIVATE FILE_SET skip_lint TYPE SOURCES
FILES things.cpp generatedBindings.cpp)
set_property(FILE_SET skip_lint TARGET MyApp PROPERTY SKIP_LINTING ON)
In the provided code snippet, the ``SKIP_LINTING`` property is set to true
for the ``skip_lint`` file set. As a result, when the linting
tools specified by :prop_tgt:`<LANG>_CPPLINT`, :prop_tgt:`<LANG>_CLANG_TIDY`,
:prop_tgt:`<LANG>_CPPCHECK`, :prop_tgt:`<LANG>_ICSTAT` or
:prop_tgt:`<LANG>_INCLUDE_WHAT_YOU_USE` are executed, they will skip analyzing
the ``things.cpp`` and ``generatedBindings.cpp`` files.
By using the ``SKIP_LINTING`` file set 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.
See Also
^^^^^^^^
* :prop_sf:`SKIP_LINTING` source file property
* :prop_tgt:`SKIP_LINTING` target property
Help/prop_sf/SKIP_LINTING.rst
+4
View File
@@ -43,7 +43,11 @@ 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.
A convenient alternative, when multiple sources should be excluded from the
linting process, is to use the file set's :prop_fs:`SKIP_LINTING` property.
See Also
^^^^^^^^
* :prop_fs:`SKIP_LINTING` file set property
* :prop_tgt:`SKIP_LINTING` target property
Help/prop_tgt/SKIP_LINTING.rst
+6 -3
View File
@@ -10,16 +10,19 @@ 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.
is set on a specific source or if the :prop_fs:`SKIP_LINTING` file set property
is set, 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 source’s :prop_sf:`SKIP_LINTING` is enabled,
that source will be excluded from linting.
:prop_tgt:`SKIP_LINTING` or file set's :prop_fs:`SKIP_LINTING` including this
source or a source’s :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_fs:`SKIP_LINTING` file set property
* :prop_sf:`SKIP_LINTING` source file property
Help/release/dev/FILE_SET-SKIP_LINTING.rst
+5
View File
@@ -0,0 +1,5 @@
FILE_SET-SKIP_LINTING
---------------------
* File sets gained the support of the :prop_fs:`SKIP_LINTING` file set
property.
Source/cmFastbuildNormalTargetGenerator.cxx
+9 -3
View File
@@ -1141,10 +1141,16 @@ void cmFastbuildNormalTargetGenerator::CollapseAllExecsIntoOneScriptfile(
std::string cmFastbuildNormalTargetGenerator::ComputeCodeCheckOptions(
cmSourceFile const& srcFile)
{
cmGeneratorFileSet const* fileSet =
this->GeneratorTarget->GetFileSetForSource(Config, &srcFile);
cmValue const fsSkipCodeCheckVal =
fileSet ? fileSet->GetProperty("SKIP_LINTING") : nullptr;
cmValue const srcSkipCodeCheckVal = srcFile.GetProperty("SKIP_LINTING");
bool const skipCodeCheck = srcSkipCodeCheckVal.IsSet()
? srcSkipCodeCheckVal.IsOn()
: this->GetGeneratorTarget()->GetPropertyAsBool("SKIP_LINTING");
bool const skipCodeCheck = fsSkipCodeCheckVal.IsSet()
? fsSkipCodeCheckVal.IsOn()
: (srcSkipCodeCheckVal.IsSet()
? srcSkipCodeCheckVal.IsOn()
: this->GetGeneratorTarget()->GetPropertyAsBool("SKIP_LINTING"));
if (skipCodeCheck) {
return {};
Source/cmGeneratorTarget_HeaderSetVerification.cxx
+4 -1
View File
@@ -89,8 +89,11 @@ bool cmGeneratorTarget::AddHeaderSetVerification()
std::set<cmGeneratorFileSet const*> fileSets;
for (auto const& fileSet : fileSetEntries) {
if (all || verifySet.count(fileSet->GetName())) {
fileSets.insert(fileSet);
verifySet.erase(fileSet->GetName());
if (fileSet->GetProperty("SKIP_LINTING").IsOn()) {
continue;
}
fileSets.insert(fileSet);
}
}
Source/cmMakefileTargetGenerator.cxx
+7 -3
View File
@@ -1107,10 +1107,14 @@ void cmMakefileTargetGenerator::WriteObjectRuleFiles(
compilerLauncher = GetCompilerLauncher(lang, config);
}
cmValue const fsSkipCodeCheckVal =
fileSet ? fileSet->GetProperty("SKIP_LINTING") : nullptr;
cmValue const srcSkipCodeCheckVal = source.GetProperty("SKIP_LINTING");
bool const skipCodeCheck = srcSkipCodeCheckVal.IsSet()
? srcSkipCodeCheckVal.IsOn()
: this->GetGeneratorTarget()->GetPropertyAsBool("SKIP_LINTING");
bool const skipCodeCheck = fsSkipCodeCheckVal.IsSet()
? fsSkipCodeCheckVal.IsOn()
: (srcSkipCodeCheckVal.IsSet()
? srcSkipCodeCheckVal.IsOn()
: this->GetGeneratorTarget()->GetPropertyAsBool("SKIP_LINTING"));
if (!skipCodeCheck) {
std::string const codeCheck = this->GenerateCodeCheckRules(
Source/cmNinjaTargetGenerator.cxx
+10 -3
View File
@@ -1585,10 +1585,17 @@ void cmNinjaTargetGenerator::WriteObjectBuildStatement(
auto compilerLauncher = this->GetCompilerLauncher(language, config);
cmGeneratorFileSet const* fileSet =
this->GeneratorTarget->GetFileSetForSource(config, source);
cmValue const fsSkipCodeCheckVal =
fileSet ? fileSet->GetProperty("SKIP_LINTING") : nullptr;
cmValue const srcSkipCodeCheckVal = source->GetProperty("SKIP_LINTING");
bool const skipCodeCheck = srcSkipCodeCheckVal.IsSet()
? srcSkipCodeCheckVal.IsOn()
: this->GetGeneratorTarget()->GetPropertyAsBool("SKIP_LINTING");
bool const skipCodeCheck = fsSkipCodeCheckVal.IsSet()
? fsSkipCodeCheckVal.IsOn()
: (srcSkipCodeCheckVal.IsSet()
? srcSkipCodeCheckVal.IsOn()
: this->GetGeneratorTarget()->GetPropertyAsBool("SKIP_LINTING"));
if (!skipCodeCheck) {
auto const cmakeCmd =
Tests/RunCMake/MultiLint/RunCMakeTest.cmake
+73 -35
View File
@@ -28,9 +28,9 @@ if(NOT RunCMake_GENERATOR STREQUAL "Watcom WMake")
run_multilint(genex)
endif()
function(run_skip_linting test_name prop_sf prop_tgt)
set(RunCMake_TEST_VARIANT_DESCRIPTION " (prop_sf=${prop_sf}, prop_tgt=${prop_tgt})")
list(APPEND RunCMake_TEST_OPTIONS "-Dprop_sf=${prop_sf}" "-Dprop_tgt=${prop_tgt}")
function(run_skip_linting test_name prop_fs prop_sf prop_tgt)
set(RunCMake_TEST_VARIANT_DESCRIPTION " (prop_fs=${prop_fs}, prop_sf=${prop_sf}, prop_tgt=${prop_tgt})")
list(APPEND RunCMake_TEST_OPTIONS "-Dprop_fs=${prop_fs}" "-Dprop_sf=${prop_sf}" "-Dprop_tgt=${prop_tgt}")
set(RunCMake_TEST_BINARY_DIR "${RunCMake_BINARY_DIR}/${test_name}-build")
set(RunCMake_TEST_NO_CLEAN 1)
@@ -40,52 +40,90 @@ function(run_skip_linting test_name prop_sf prop_tgt)
run_cmake_command(${test_name}-Build ${CMAKE_COMMAND} --build .)
endfunction()
# There are a few `SKIP_LINTING` source/target propertiy combinations
# There are a few `SKIP_LINTING` file set/source/target propertiy combinations
# that affect the final result:
#
# prop_sf prop_tgt result
# ---------------------------
# - - OFF
# OFF - OFF
# ON - ON
# - OFF OFF
# OFF OFF OFF
# ON OFF ON
# - ON ON
# OFF ON OFF
# ON ON ON
# prop_fs prop_sf prop_tgt result
# ------------------------------------
# - - - OFF
# OFF - - OFF
# ON - - ON
# - OFF - OFF
# OFF OFF - OFF
# ON OFF - ON
# - ON - ON
# OFF ON - OFF
# ON ON - ON
# - - OFF OFF
# OFF - OFF OFF
# ON - OFF ON
# - - ON ON
# OFF - ON OFF
# ON - ON ON
# - OFF OFF OFF
# OFF OFF OFF OFF
# ON OFF OFF ON
# - OFF ON OFF
# OFF OFF ON OFF
# ON OFF ON ON
# - ON OFF ON
# OFF ON OFF OFF
# ON ON OFF ON
# - ON ON ON
# OFF ON ON OFF
# ON ON ON ON
#
# where `-` means unset property.
#
# Here's the same table for convenience sorted by `result`:
#
# prop_sf prop_tgt result
# ---------------------------
# - - OFF
# OFF - OFF
# - OFF OFF
# OFF OFF OFF
# OFF ON OFF
# ON - ON
# ON OFF ON
# - ON ON
# ON ON ON
# prop_fs prop_sf prop_tgt result
# ------------------------------------
# - - - OFF
# OFF - - OFF
# - OFF - OFF
# OFF OFF - OFF
# OFF ON - OFF
# - - OFF OFF
# OFF - OFF OFF
# OFF - ON OFF
# - OFF OFF OFF
# OFF OFF OFF OFF
# - OFF ON OFF
# OFF OFF ON OFF
# OFF ON OFF OFF
# OFF ON ON OFF
# ON - - ON
# ON OFF - ON
# - ON - ON
# ON ON - ON
# ON - OFF ON
# - - ON ON
# ON - ON ON
# ON OFF OFF ON
# ON OFF ON ON
# - ON OFF ON
# ON ON OFF ON
# - ON ON ON
# ON ON ON ON
foreach(lang IN ITEMS C CXX)
# Testing `SKIP_LINTING=OFF` (first half of the table above)
set(prop_sf_OFF_variants "-" OFF "-" OFF OFF)
set(prop_tgt_OFF_variants "-" "-" OFF OFF ON)
foreach(prop_fs prop_tgt IN ZIP_LISTS prop_sf_OFF_variants prop_tgt_OFF_variants)
run_skip_linting(${lang}_skip_linting_OFF "${prop_fs}" "${prop_tgt}")
set(prop_fs_OFF_variants "-" OFF "-" OFF OFF "-" OFF OFF "-" OFF "-" OFF OFF OFF)
set(prop_sf_OFF_variants "-" "-" OFF OFF ON "-" "-" "-" OFF OFF OFF OFF ON ON)
set(prop_tgt_OFF_variants "-" "-" "-" "-" "-" OFF OFF ON OFF OFF ON ON OFF ON)
foreach(prop_fs prop_sf prop_tgt IN ZIP_LISTS prop_fs_OFF_variants prop_sf_OFF_variants prop_tgt_OFF_variants)
run_skip_linting(${lang}_skip_linting_OFF "${prop_fs}" "${prop_sf}" "${prop_tgt}")
endforeach()
# Testing `SKIP_LINTING=ON` (second half of the table above)
set(prop_sf_ON_variants ON ON "-" ON)
set(prop_tgt_ON_variants "-" OFF ON ON)
foreach(prop_fs prop_tgt IN ZIP_LISTS prop_sf_ON_variants prop_tgt_ON_variants)
run_skip_linting(${lang}_skip_linting_ON "${prop_fs}" "${prop_tgt}")
set(prop_fs_ON_variants ON ON "-" ON ON "-" ON ON ON "-" ON "-" ON)
set(prop_sf_ON_variants "-" OFF ON ON "-" "-" "-" OFF OFF ON ON ON ON)
set(prop_tgt_ON_variants "-" "-" "-" "-" OFF ON ON OFF ON OFF OFF ON ON)
foreach(prop_fs prop_sf prop_tgt IN ZIP_LISTS prop_fs_ON_variants prop_sf_ON_variants prop_tgt_ON_variants)
run_skip_linting(${lang}_skip_linting_ON "${prop_fs}" "${prop_sf}" "${prop_tgt}")
if(NOT RunCMake_GENERATOR STREQUAL "Watcom WMake")
run_skip_linting(${lang}-launch_skip_linting_ON "${prop_fs}" "${prop_tgt}")
run_skip_linting(${lang}-launch_skip_linting_ON "${prop_fs}" "${prop_sf}" "${prop_tgt}")
endif()
endforeach()
endforeach()
Tests/RunCMake/MultiLint/setup_skip_linter_test.cmake
+6 -1
View File
@@ -12,7 +12,12 @@ function(setup_skip_linter_test lang)
set(CMAKE_${lang}_CPPCHECK "${maybe_genex_pre}${PSEUDO_CPPCHECK}${maybe_genex_post}" -error)
string(TOLOWER "${lang}" ext)
add_executable(main main.${ext})
add_executable(main)
target_sources(main PRIVATE FILE_SET SOURCES FILES main.${ext})
if(NOT prop_fs STREQUAL "-")
set_property(FILE_SET SOURCES TARGET main PROPERTY SKIP_LINTING ${prop_fs})
endif()
if(NOT prop_sf STREQUAL "-")
set_source_files_properties(main.${ext} PROPERTIES SKIP_LINTING ${prop_sf})
Tests/RunCMake/VerifyHeaderSets/VerifyInterfaceHeaderSets.cmake
+7
View File
@@ -83,3 +83,10 @@ add_library(skip_linting STATIC lib.c)
target_sources(skip_linting INTERFACE FILE_SET HEADERS FILES lang_test.h skip_linting.h)
set_property(SOURCE skip_linting.h PROPERTY LANGUAGE C)
set_property(SOURCE skip_linting.h PROPERTY SKIP_LINTING TRUE)
add_library(skip_linting2 STATIC lib.c)
target_sources(skip_linting2 INTERFACE FILE_SET HEADERS FILES lang_test.h)
target_sources(skip_linting2 INTERFACE FILE_SET skip_headers TYPE HEADERS FILES skip_linting2.h)
set_property(FILE_SET skip_headers TARGET skip_linting2 PROPERTY SKIP_LINTING TRUE)
set_property(SOURCE skip_linting2.h PROPERTY LANGUAGE C)
Tests/RunCMake/VerifyHeaderSets/VerifyPrivateHeaderSets.cmake
+7
View File
@@ -86,3 +86,10 @@ add_library(skip_linting STATIC lib.c)
target_sources(skip_linting PRIVATE FILE_SET HEADERS FILES lang_test.h skip_linting.h)
set_property(SOURCE skip_linting.h PROPERTY LANGUAGE C)
set_property(SOURCE skip_linting.h PROPERTY SKIP_LINTING TRUE)
add_library(skip_linting2 STATIC lib.c)
target_sources(skip_linting2 PRIVATE FILE_SET HEADERS FILES lang_test.h)
target_sources(skip_linting2 PRIVATE FILE_SET skip_headers TYPE HEADERS FILES skip_linting2.h)
set_property(FILE_SET skip_headers TARGET skip_linting2 PROPERTY SKIP_LINTING TRUE)
set_property(SOURCE skip_linting2.h PROPERTY LANGUAGE C)
Tests/RunCMake/VerifyHeaderSets/skip_linting2.h
+3
View File
@@ -0,0 +1,3 @@
#error "This file should not be included"
extern void skip_linting2_h(void);