mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-01-03 20:29:56 -06:00
Code Issues Packages Projects Releases Wiki Activity

ExternalProject: Clarify BYPRODUCTS docs

Browse Source 
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.
This commit is contained in:
Alois Klink
2022-11-03 15:27:09 +00:00
parent 3aa6d79a50
commit 4bcfff2df3
1 changed files with 10 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
Modules/ExternalProject.cmake
View File

@@ -637,8 +637,11 @@ External Project Definition
Specifies files that will be generated by the build command but which Specifies files that will be generated by the build command but which
might or might not have their modification time updated by subsequent might or might not have their modification time updated by subsequent
builds. These ultimately get passed through as ``BYPRODUCTS`` to the builds. This may also be required to explicitly declare dependencies
build step's own underlying call to :command:`add_custom_command`. 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:** **Install Step Options:**
If the configure step assumed the external project uses CMake as its build 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 .. versionadded:: 3.2
Files that will be generated by this custom step but which might or might 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 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 <bool>`` ``ALWAYS <bool>``
When enabled, this option specifies that the custom step should always be When enabled, this option specifies that the custom step should always be