From cebccdebaf12adc83c50f418c51b2d6b989d5350 Mon Sep 17 00:00:00 2001 From: Craig Scott Date: Fri, 7 Jun 2019 21:08:08 +1000 Subject: Help: Move ADDITIONAL_MAKE_CLEAN_FILES dir prop to deprecated section --- Help/manual/cmake-properties.7.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 -- cgit v0.12 From e61074c67226e3def13e75173e3b8bbdb1c3df2d Mon Sep 17 00:00:00 2001 From: Sebastian Holtermann Date: Wed, 5 Jun 2019 16:26:27 +0200 Subject: Help: Improve ADDITIONAL_CLEAN_FILES documentation Extend the `ADDITIONAL_CLEAN_FILES' target and directory property documentation. Fixes: #19341 --- Help/prop_dir/ADDITIONAL_CLEAN_FILES.rst | 15 ++++++++++----- Help/prop_tgt/ADDITIONAL_CLEAN_FILES.rst | 17 ++++++++++++----- 2 files changed, 22 insertions(+), 10 deletions(-) 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 ` 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 ` 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 `. 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 ` 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 ` 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 `. 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. -- cgit v0.12