summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2022-09-19 14:22:53 (GMT)
committerKitware Robot <kwrobot@kitware.com>2022-09-19 14:23:02 (GMT)
commite9d9cd348cc55ec1ef318a22efc6f795a3d8e185 (patch)
tree1f4852133550941c8382d123cd719517467baa6f /Help
parent6949d0195d9d87cd92ce7da73cfde5d56bc2decd (diff)
parent00b788e85ee9ebdbf2c40ea9b71a0b1bdf07c99d (diff)
downloadCMake-e9d9cd348cc55ec1ef318a22efc6f795a3d8e185.zip
CMake-e9d9cd348cc55ec1ef318a22efc6f795a3d8e185.tar.gz
CMake-e9d9cd348cc55ec1ef318a22efc6f795a3d8e185.tar.bz2
Merge topic 'help-add-custom-comman-byproducts'
00b788e85e Help:custom_command: link policy on BYPRODUCTS Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !7662
Diffstat (limited to 'Help')
-rw-r--r--Help/command/add_custom_command.rst2
-rw-r--r--Help/policy/CMP0058.rst3
2 files changed, 5 insertions, 0 deletions
diff --git a/Help/command/add_custom_command.rst b/Help/command/add_custom_command.rst
index 9e60d2d..523e1b3 100644
--- a/Help/command/add_custom_command.rst
+++ b/Help/command/add_custom_command.rst
@@ -67,6 +67,8 @@ The options are:
Each byproduct file will be marked with the :prop_sf:`GENERATED`
source file property automatically.
+ *See policy* :policy:`CMP0058` *for the motivation behind this feature.*
+
Explicit specification of byproducts is supported by the
:generator:`Ninja` generator to tell the ``ninja`` build tool
how to regenerate byproducts when they are missing. It is
diff --git a/Help/policy/CMP0058.rst b/Help/policy/CMP0058.rst
index 06cc74b..a9a8f1c 100644
--- a/Help/policy/CMP0058.rst
+++ b/Help/policy/CMP0058.rst
@@ -71,6 +71,9 @@ every custom command dependency, even on source files, needs to
be treated this way because CMake does not have enough information
to know which files are generated as byproducts of custom commands.
+Introducing Byproducts
+^^^^^^^^^^^^^^^^^^^^^^
+
CMake 3.2 introduced the ``BYPRODUCTS`` option to the
:command:`add_custom_command` and :command:`add_custom_target`
commands. This option allows byproducts to be specified explicitly: