Browse Source

Merge topic 'help-add-custom-comman-byproducts'

00b788e85e Help:custom_command: link policy on BYPRODUCTS

Acked-by: Kitware Robot <[email protected]>
Merge-request: !7662
Brad King 3 years ago
parent
commit
e9d9cd348c
2 changed files with 5 additions and 0 deletions
  1. 2 0
      Help/command/add_custom_command.rst
  2. 3 0
      Help/policy/CMP0058.rst

+ 2 - 0
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

+ 3 - 0
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: