summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKyle Edwards <kyle.edwards@kitware.com>2023-02-09 16:09:47 (GMT)
committerKyle Edwards <kyle.edwards@kitware.com>2023-02-09 16:41:48 (GMT)
commitf9d9258d5cb3f9dc4271ac34af2e2ede02301730 (patch)
treed1a4f97436cae2278b76a6b6412e2b3f52085ecf
parentf9ccb7fada66ce686667db8658c01afa114bb37b (diff)
downloadCMake-f9d9258d5cb3f9dc4271ac34af2e2ede02301730.zip
CMake-f9d9258d5cb3f9dc4271ac34af2e2ede02301730.tar.gz
CMake-f9d9258d5cb3f9dc4271ac34af2e2ede02301730.tar.bz2
Help: Avoid making guarantees about <LANG>_CLANG_TIDY_EXPORT_FIXES_DIR
Rather than stating specifically which files may be written or deleted, simply state that CMake owns the directory and that a dedicated directory should be used for exporting the fixes.
-rw-r--r--Help/prop_tgt/LANG_CLANG_TIDY_EXPORT_FIXES_DIR.rst12
1 files changed, 6 insertions, 6 deletions
diff --git a/Help/prop_tgt/LANG_CLANG_TIDY_EXPORT_FIXES_DIR.rst b/Help/prop_tgt/LANG_CLANG_TIDY_EXPORT_FIXES_DIR.rst
index 265fade..fc88f0f 100644
--- a/Help/prop_tgt/LANG_CLANG_TIDY_EXPORT_FIXES_DIR.rst
+++ b/Help/prop_tgt/LANG_CLANG_TIDY_EXPORT_FIXES_DIR.rst
@@ -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