mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-05-03 21:00:01 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge topic 'clarify-clang-tidy-export-fixes-doc'

Browse Source 
f9d9258d5c Help: Avoid making guarantees about <LANG>_CLANG_TIDY_EXPORT_FIXES_DIR

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !8189
This commit is contained in:
Brad King
2023-02-09 18:22:52 +00:00
committed by Kitware Robot
parent 536f35c4f1 f9d9258d5c
commit bfd01ea357
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Help/prop_tgt/LANG_CLANG_TIDY_EXPORT_FIXES_DIR.rst
+6 -6
View File
@@ -17,12 +17,12 @@ absolute directory, it is assumed to be relative to the target's binary
directory. This property should be preferred over adding an ``--export-fixes``
or ``--fix`` argument directly to the :prop_tgt:`<LANG>_CLANG_TIDY` property.
At generate-time, in order to avoid passing stale fixes from old code to
``clang-apply-replacements``, CMake will search the directory for any ``.yaml``
files that won't be generated by ``clang-tidy`` during the build, and delete
them. In addition, just before running ``clang-tidy`` on a file, CMake will
delete that file's corresponding ``.yaml`` file in case ``clang-tidy`` doesn't
produce any fixes.
When this property is set, CMake takes ownership of the specified directory,
and may create, modify, or delete files and directories within the directory
at any time during configure or build time. Users should use a dedicated
directory for exporting clang-tidy fixes to avoid having files deleted or
overwritten by CMake. Users should not create, modify, or delete files in this
directory.
This property is initialized by the value of
the :variable:`CMAKE_<LANG>_CLANG_TIDY_EXPORT_FIXES_DIR` variable if it is set