diff options
author | Craig Scott <craig.scott@crascit.com> | 2023-05-19 02:28:34 (GMT) |
---|---|---|
committer | Craig Scott <craig.scott@crascit.com> | 2023-05-19 02:29:06 (GMT) |
commit | 652a78531100d8b47ce3737f12e938b0dc9321ec (patch) | |
tree | c203eb130a5d12eed51382a95b12886dde270f2f /Help/prop_tgt | |
parent | 5056a224dc4c74912f0ca2c1af1bf69bab88a5be (diff) | |
download | CMake-652a78531100d8b47ce3737f12e938b0dc9321ec.zip CMake-652a78531100d8b47ce3737f12e938b0dc9321ec.tar.gz CMake-652a78531100d8b47ce3737f12e938b0dc9321ec.tar.bz2 |
Help: Wording, formatting and ordering fixes for SKIP_LINTING docs
Amends b480315e0c2 (TargetGenerator: Add SKIP_LINTING source property,
2023-05-12).
Diffstat (limited to 'Help/prop_tgt')
-rw-r--r-- | Help/prop_tgt/LANG_CLANG_TIDY.rst | 12 | ||||
-rw-r--r-- | Help/prop_tgt/LANG_CPPCHECK.rst | 12 | ||||
-rw-r--r-- | Help/prop_tgt/LANG_CPPLINT.rst | 12 | ||||
-rw-r--r-- | Help/prop_tgt/LANG_INCLUDE_WHAT_YOU_USE.rst | 12 |
4 files changed, 28 insertions, 20 deletions
diff --git a/Help/prop_tgt/LANG_CLANG_TIDY.rst b/Help/prop_tgt/LANG_CLANG_TIDY.rst index 0e46643..9ecdc57 100644 --- a/Help/prop_tgt/LANG_CLANG_TIDY.rst +++ b/Help/prop_tgt/LANG_CLANG_TIDY.rst @@ -31,9 +31,11 @@ when a target is created. 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 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. + 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. diff --git a/Help/prop_tgt/LANG_CPPCHECK.rst b/Help/prop_tgt/LANG_CPPCHECK.rst index 3ab2b58..0628061 100644 --- a/Help/prop_tgt/LANG_CPPCHECK.rst +++ b/Help/prop_tgt/LANG_CPPCHECK.rst @@ -21,9 +21,11 @@ created. 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 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. + them from the linting tools defined by :prop_tgt:`<LANG>_CPPLINT`, + :prop_tgt:`<LANG>_CLANG_TIDY`, ``<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. diff --git a/Help/prop_tgt/LANG_CPPLINT.rst b/Help/prop_tgt/LANG_CPPLINT.rst index cb230d3..02610da 100644 --- a/Help/prop_tgt/LANG_CPPLINT.rst +++ b/Help/prop_tgt/LANG_CPPLINT.rst @@ -19,9 +19,11 @@ created. 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 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. + them from the linting tools defined by ``<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 to true on a source file, those 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 8fbe84a..2f51c8f 100644 --- a/Help/prop_tgt/LANG_INCLUDE_WHAT_YOU_USE.rst +++ b/Help/prop_tgt/LANG_INCLUDE_WHAT_YOU_USE.rst @@ -19,9 +19,11 @@ when a target is created. 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 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. + them from the linting tools defined by :prop_tgt:`<LANG>_CPPLINT`, + :prop_tgt:`<LANG>_CLANG_TIDY`, :prop_tgt:`<LANG>_CPPCHECK`, and + ``<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. |