This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "CMake".
The branch, master has been updated
via d93fe90c17de741c3986c3b13a6c5f5653a8104e (commit)
via e61074c67226e3def13e75173e3b8bbdb1c3df2d (commit)
via cebccdebaf12adc83c50f418c51b2d6b989d5350 (commit)
from 0e96fdbc15471b652fe9e242ab4ff1e1dc87d8dc (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
https://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=d93fe90c17de741c3986c3b13a6c5f5653a8104e
commit d93fe90c17de741c3986c3b13a6c5f5653a8104e
Merge: 0e96fdb e61074c
Author: Craig Scott <craig.sc...@crascit.com>
AuthorDate: Sat Jun 8 06:52:53 2019 +0000
Commit: Kitware Robot <kwro...@kitware.com>
CommitDate: Sat Jun 8 02:53:21 2019 -0400
Merge topic 'additional_clean_files_help'
e61074c672 Help: Improve ADDITIONAL_CLEAN_FILES documentation
cebccdebaf Help: Move ADDITIONAL_MAKE_CLEAN_FILES dir prop to deprecated
section
Acked-by: Kitware Robot <kwro...@kitware.com>
Merge-request: !3428
https://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=e61074c67226e3def13e75173e3b8bbdb1c3df2d
commit e61074c67226e3def13e75173e3b8bbdb1c3df2d
Author: Sebastian Holtermann <sebh...@xwmw.org>
AuthorDate: Wed Jun 5 16:26:27 2019 +0200
Commit: Craig Scott <craig.sc...@crascit.com>
CommitDate: Fri Jun 7 21:10:19 2019 +1000
Help: Improve ADDITIONAL_CLEAN_FILES documentation
Extend the `ADDITIONAL_CLEAN_FILES' target and directory property
documentation.
Fixes: #19341
diff --git a/Help/prop_dir/ADDITIONAL_CLEAN_FILES.rst
b/Help/prop_dir/ADDITIONAL_CLEAN_FILES.rst
index 54a78ef..051d22a 100644
--- a/Help/prop_dir/ADDITIONAL_CLEAN_FILES.rst
+++ b/Help/prop_dir/ADDITIONAL_CLEAN_FILES.rst
@@ -1,16 +1,21 @@
ADDITIONAL_CLEAN_FILES
----------------------
-Additional files to remove during the clean stage.
+A :ref:`;-list <CMake Language Lists>` of files or directories that will be
+removed as a part of the global ``clean`` target. It is useful for
+specifying generated files or directories that are used by multiple targets
+or by CMake itself, or that are generated in ways which cannot be captured as
+outputs or byproducts of custom commands.
-A :ref:`;-list <CMake Language Lists>` of files that will be removed as a
-part of the ``clean`` target.
+If an additional clean file is specific to a single target only, then the
+:prop_tgt:`ADDITIONAL_CLEAN_FILES` target property would usually be a better
+choice than this directory property.
Relative paths are allowed and are interpreted relative to the
current binary directory.
-Arguments to :prop_dir:`ADDITIONAL_CLEAN_FILES` may use
+Contents of ``ADDITIONAL_CLEAN_FILES`` may use
:manual:`generator expressions <cmake-generator-expressions(7)>`.
This property only works for the :generator:`Ninja` and the Makefile
-generators. It is ignored on other generators.
+generators. It is ignored by other generators.
diff --git a/Help/prop_tgt/ADDITIONAL_CLEAN_FILES.rst
b/Help/prop_tgt/ADDITIONAL_CLEAN_FILES.rst
index 856bb38..3b9d965 100644
--- a/Help/prop_tgt/ADDITIONAL_CLEAN_FILES.rst
+++ b/Help/prop_tgt/ADDITIONAL_CLEAN_FILES.rst
@@ -1,16 +1,23 @@
ADDITIONAL_CLEAN_FILES
----------------------
-Additional files to remove during the clean stage.
+A :ref:`;-list <CMake Language Lists>` of files or directories that will be
+removed as a part of the global ``clean`` target. It can be used to specify
+files and directories that are generated as part of building the target or
+that are directly associated with the target in some way (e.g. created as a
+result of running the target).
-A :ref:`;-list <CMake Language Lists>` of files that will be removed as a
-part of the ``clean`` target.
+For custom targets, if such files can be captured as outputs or byproducts
+instead, then that should be preferred over adding them to this property.
+If an additional clean file is used by multiple targets or isn't
+target-specific, then the :prop_dir:`ADDITIONAL_CLEAN_FILES` directory
+property may be the more appropriate property to use.
Relative paths are allowed and are interpreted relative to the
current binary directory.
-Arguments to :prop_tgt:`ADDITIONAL_CLEAN_FILES` may use
+Contents of ``ADDITIONAL_CLEAN_FILES`` may use
:manual:`generator expressions <cmake-generator-expressions(7)>`.
This property only works for the :generator:`Ninja` and the Makefile
-generators. It is ignored on other generators.
+generators. It is ignored by other generators.
https://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=cebccdebaf12adc83c50f418c51b2d6b989d5350
commit cebccdebaf12adc83c50f418c51b2d6b989d5350
Author: Craig Scott <craig.sc...@crascit.com>
AuthorDate: Fri Jun 7 21:08:08 2019 +1000
Commit: Craig Scott <craig.sc...@crascit.com>
CommitDate: Fri Jun 7 21:08:08 2019 +1000
Help: Move ADDITIONAL_MAKE_CLEAN_FILES dir prop to deprecated section
diff --git a/Help/manual/cmake-properties.7.rst
b/Help/manual/cmake-properties.7.rst
index 25aab8d..77b1ae8 100644
--- a/Help/manual/cmake-properties.7.rst
+++ b/Help/manual/cmake-properties.7.rst
@@ -62,7 +62,6 @@ Properties on Directories
:maxdepth: 1
/prop_dir/ADDITIONAL_CLEAN_FILES
- /prop_dir/ADDITIONAL_MAKE_CLEAN_FILES
/prop_dir/BINARY_DIR
/prop_dir/BUILDSYSTEM_TARGETS
/prop_dir/CACHE_VARIABLES
@@ -505,6 +504,7 @@ Deprecated Properties on Directories
.. toctree::
:maxdepth: 1
+ /prop_dir/ADDITIONAL_MAKE_CLEAN_FILES
/prop_dir/COMPILE_DEFINITIONS_CONFIG
/prop_dir/TEST_INCLUDE_FILE
-----------------------------------------------------------------------
Summary of changes:
Help/manual/cmake-properties.7.rst | 2 +-
Help/prop_dir/ADDITIONAL_CLEAN_FILES.rst | 15 ++++++++++-----
Help/prop_tgt/ADDITIONAL_CLEAN_FILES.rst | 17 ++++++++++++-----
3 files changed, 23 insertions(+), 11 deletions(-)
hooks/post-receive
--
CMake
_______________________________________________
Cmake-commits mailing list
Cmake-commits@cmake.org
https://cmake.org/mailman/listinfo/cmake-commits
