Merge topic 'doc-skip-linting'

652a785311 Help: Wording, formatting and ordering fixes for SKIP_LINTING docs

Acked-by: Kitware Robot <[email protected]>
Merge-request: !8493

Auxiliary/vim/syntax/cmake.vim

@@ -325,11 +325,11 @@ syn keyword cmakeProperty contained
             \ SKIP_AUTORCC
             \ SKIP_AUTOUIC
             \ SKIP_BUILD_RPATH
+            \ SKIP_LINTING
             \ SKIP_PRECOMPILE_HEADERS
             \ SKIP_REGULAR_EXPRESSION
             \ SKIP_RETURN_CODE
             \ SKIP_UNITY_BUILD_INCLUSION
-            \ SKIP_LINTING
             \ SOURCES
             \ SOURCE_DIR
             \ SOVERSION

Help/manual/cmake-properties.7.rst

@@ -557,9 +557,9 @@ Properties on Source Files
    /prop_sf/SKIP_AUTOMOC
    /prop_sf/SKIP_AUTORCC
    /prop_sf/SKIP_AUTOUIC
+   /prop_sf/SKIP_LINTING
    /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

Help/prop_sf/SKIP_LINTING.rst

@@ -7,18 +7,18 @@ 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,
+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
+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`
+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`
+the ``SKIP_LINTING`` property with the :command:`set_source_files_properties`
 command as shown below:
 
 .. code-block:: cmake
@@ -29,13 +29,13 @@ command as shown below:
       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.
+In the provided code snippet, the ``SKIP_LINTING`` property is set to true
+for the ``generatedBindings.cpp`` source file. As a result, when the linting
+tools specified by :prop_tgt:`<LANG>_CPPLINT`, :prop_tgt:`<LANG>_CLANG_TIDY`,
+:prop_tgt:`<LANG>_CPPCHECK`, or :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
+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.

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.

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.

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.

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.