From 4bcfff2df3889a60b64e46d2431229cc6871c981 Mon Sep 17 00:00:00 2001 From: Alois Klink Date: Thu, 3 Nov 2022 15:27:09 +0000 Subject: ExternalProject: Clarify `BYPRODUCTS` docs Clarify that the `BUILD_BYPRODUCTS` and `BYPRODUCTS` options in ExternalProject may also be required when using the Ninja generator (as that's one of the primary reasons why you'd want to use those options). I've also mentioned that `add_custom_command` has additional documentation on what `BYPRODUCTS` does. --- Modules/ExternalProject.cmake | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/Modules/ExternalProject.cmake b/Modules/ExternalProject.cmake index 141b185..4af0952 100644 --- a/Modules/ExternalProject.cmake +++ b/Modules/ExternalProject.cmake @@ -637,8 +637,11 @@ External Project Definition Specifies files that will be generated by the build command but which might or might not have their modification time updated by subsequent - builds. These ultimately get passed through as ``BYPRODUCTS`` to the - build step's own underlying call to :command:`add_custom_command`. + builds. This may also be required to explicitly declare dependencies + when using the :generator:`Ninja` generator. + These ultimately get passed through as ``BYPRODUCTS`` to the + build step's own underlying call to :command:`add_custom_command`, which + has additional documentation. **Install Step Options:** If the configure step assumed the external project uses CMake as its build @@ -943,9 +946,12 @@ control needed to implement such step-level capabilities. .. versionadded:: 3.2 Files that will be generated by this custom step but which might or might - not have their modification time updated by subsequent builds. This list of + not have their modification time updated by subsequent builds. + This may also be required to explicitly declare dependencies + when using the :generator:`Ninja` generator. This list of files will ultimately be passed through as the ``BYPRODUCTS`` option to the - :command:`add_custom_command` used to implement the custom step internally. + :command:`add_custom_command` used to implement the custom step internally, + which has additional documentation. ``ALWAYS `` When enabled, this option specifies that the custom step should always be -- cgit v0.12