summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorHinell <al.neodim@gmail.com>2022-09-09 19:40:24 (GMT)
committerBrad King <brad.king@kitware.com>2022-09-16 14:50:46 (GMT)
commit00b788e85ee9ebdbf2c40ea9b71a0b1bdf07c99d (patch)
tree47ef89619b8d28c31c2af23620045666f402b712 /Help
parentcabba23ab270eb5cc672c43265f9eb3cb7dda8cc (diff)
downloadCMake-00b788e85ee9ebdbf2c40ea9b71a0b1bdf07c99d.zip
CMake-00b788e85ee9ebdbf2c40ea9b71a0b1bdf07c99d.tar.gz
CMake-00b788e85ee9ebdbf2c40ea9b71a0b1bdf07c99d.tar.bz2
Help:custom_command: link policy on BYPRODUCTS
Link policy explaining BYPRODUCTS. Fixes: #23786
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: