mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-01-07 22:30:13 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'additional_clean_files_help' into release-3.15

Browse Source 
Merge-request: !3428
This commit is contained in:
Craig Scott
2019-06-08 16:58:19 +10:00
parent 43316424d0 e61074c672
commit 8d3c919a3c
3 changed files with 23 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Help/manual/cmake-properties.7.rst
View File

@@ -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

15
Help/prop_dir/ADDITIONAL_CLEAN_FILES.rst
View File

@@ -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.

17
Help/prop_tgt/ADDITIONAL_CLEAN_FILES.rst
View File

@@ -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.