mirror of
https://github.com/Kitware/CMake.git
synced 2026-04-30 11:10:06 -05:00
Merge topic 'ExternalProject_independent-step-targets'
468fb734Help: Add notes for topic 'ExternalProject_independent-step-targets'67cfbf8eExternalProject: Add unit testsf598f1aaExternalProject: Add ExternalProject_Add_StepDependencies function4ae133e0ExternalProject: Add independent step targets
This commit is contained in:
Brad King
+115
-14
@@ -166,6 +166,9 @@ Create custom targets to build projects in external trees
|
||||
|
||||
``STEP_TARGETS <step-target>...``
|
||||
Generate custom targets for these steps
|
||||
``INDEPENDENT_STEP_TARGETS <step-target>...``
|
||||
Generate custom targets for these steps that do not depend on other
|
||||
external projects even if a dependency is set
|
||||
|
||||
The ``*_DIR`` options specify directories for the project, with default
|
||||
directories computed as follows. If the ``PREFIX`` option is given to
|
||||
@@ -260,18 +263,30 @@ not defined. Behavior of shell operators like ``&&`` is not defined.
|
||||
The ``ExternalProject_Add_StepTargets`` function generates custom
|
||||
targets for the steps listed::
|
||||
|
||||
ExternalProject_Add_StepTargets(<name> [step1 [step2 [...]]])
|
||||
ExternalProject_Add_StepTargets(<name> [NO_DEPENDS] [step1 [step2 [...]]])
|
||||
|
||||
If ``STEP_TARGETS`` is set then ``ExternalProject_Add_StepTargets`` is
|
||||
automatically called at the end of matching calls to
|
||||
``ExternalProject_Add_Step``. Pass ``STEP_TARGETS`` explicitly to
|
||||
If ``NO_DEPENDS`` is set, the target will not depend on the
|
||||
dependencies of the complete project. This is usually safe to use for
|
||||
the download, update, and patch steps that do not require that all the
|
||||
dependencies are updated and built. Using ``NO_DEPENDS`` for other
|
||||
of the default steps might break parallel builds, so you should avoid,
|
||||
it. For custom steps, you should consider whether or not the custom
|
||||
commands requires that the dependencies are configured, built and
|
||||
installed.
|
||||
|
||||
If ``STEP_TARGETS`` or ``INDEPENDENT_STEP_TARGETS`` is set then
|
||||
``ExternalProject_Add_StepTargets`` is automatically called at the end
|
||||
of matching calls to ``ExternalProject_Add_Step``. Pass
|
||||
``STEP_TARGETS`` or ``INDEPENDENT_STEP_TARGETS`` explicitly to
|
||||
individual ``ExternalProject_Add`` calls, or implicitly to all
|
||||
``ExternalProject_Add`` calls by setting the directory property
|
||||
``EP_STEP_TARGETS``.
|
||||
``ExternalProject_Add`` calls by setting the directory properties
|
||||
``EP_STEP_TARGETS`` and ``EP_INDEPENDENT_STEP_TARGETS``. The
|
||||
``INDEPENDENT`` version of the argument and of the property will call
|
||||
``ExternalProject_Add_StepTargets`` with the ``NO_DEPENDS`` argument.
|
||||
|
||||
If ``STEP_TARGETS`` is not set, clients may still manually call
|
||||
``ExternalProject_Add_StepTargets`` after calling
|
||||
``ExternalProject_Add`` or ``ExternalProject_Add_Step``.
|
||||
If ``STEP_TARGETS`` and ``INDEPENDENT_STEP_TARGETS`` are not set,
|
||||
clients may still manually call ``ExternalProject_Add_StepTargets``
|
||||
after calling ``ExternalProject_Add`` or ``ExternalProject_Add_Step``.
|
||||
|
||||
This functionality is provided to make it easy to drive the steps
|
||||
independently of each other by specifying targets on build command
|
||||
@@ -288,6 +303,19 @@ line prior to any ``ExternalProject_Add`` calls in your ``CMakeLists.txt``
|
||||
file::
|
||||
|
||||
set_property(DIRECTORY PROPERTY EP_STEP_TARGETS configure build test)
|
||||
|
||||
.. command:: ExternalProject_Add_StepDependencies
|
||||
|
||||
The ``ExternalProject_Add_StepDependencies`` function add some
|
||||
dependencies for some external project step::
|
||||
|
||||
ExternalProject_Add_StepDependencies(<name> <step> [target1 [target2 [...]]])
|
||||
|
||||
This function takes care to set both target and file level
|
||||
dependencies, and will ensure that parallel builds will not break.
|
||||
It should be used instead of :command:`add_dependencies()` when adding
|
||||
a dependency for some of the step targets generated by
|
||||
``ExternalProject``.
|
||||
#]=======================================================================]
|
||||
|
||||
#=============================================================================
|
||||
@@ -397,10 +425,19 @@ define_property(DIRECTORY PROPERTY "EP_STEP_TARGETS" INHERITED
|
||||
BRIEF_DOCS
|
||||
"List of ExternalProject steps that automatically get corresponding targets"
|
||||
FULL_DOCS
|
||||
"These targets will be dependent on the main target dependencies"
|
||||
"See documentation of the ExternalProject_Add_StepTargets() function in the "
|
||||
"ExternalProject module."
|
||||
)
|
||||
|
||||
define_property(DIRECTORY PROPERTY "EP_INDEPENDENT_STEP_TARGETS" INHERITED
|
||||
BRIEF_DOCS
|
||||
"List of ExternalProject steps that automatically get corresponding targets"
|
||||
FULL_DOCS
|
||||
"These targets will not be dependent on the main target dependencies"
|
||||
"See documentation of the ExternalProject_Add_StepTargets() function in the "
|
||||
"ExternalProject module."
|
||||
)
|
||||
|
||||
function(_ep_write_gitclone_script script_filename source_dir git_EXECUTABLE git_repository git_tag git_submodules src_name work_dir gitclone_infofile gitclone_stampfile)
|
||||
file(WRITE ${script_filename}
|
||||
@@ -1283,19 +1320,28 @@ endfunction()
|
||||
|
||||
function(ExternalProject_Add_StepTargets name)
|
||||
set(steps ${ARGN})
|
||||
|
||||
if("${ARGV1}" STREQUAL "NO_DEPENDS")
|
||||
set(no_deps 1)
|
||||
list(REMOVE_AT steps 0)
|
||||
endif()
|
||||
foreach(step ${steps})
|
||||
if(no_deps AND "${step}" MATCHES "^(configure|build|install|test)$")
|
||||
message(AUTHOR_WARNING "Using NO_DEPENDS for \"${step}\" step might break parallel builds")
|
||||
endif()
|
||||
_ep_get_step_stampfile(${name} ${step} stamp_file)
|
||||
add_custom_target(${name}-${step}
|
||||
DEPENDS ${stamp_file})
|
||||
set_property(TARGET ${name}-${step} PROPERTY _EP_IS_EXTERNAL_PROJECT_STEP 1)
|
||||
set_property(TARGET ${name}-${step} PROPERTY LABELS ${name})
|
||||
set_property(TARGET ${name}-${step} PROPERTY FOLDER "ExternalProjectTargets/${name}")
|
||||
|
||||
# Depend on other external projects (target-level).
|
||||
get_property(deps TARGET ${name} PROPERTY _EP_DEPENDS)
|
||||
foreach(arg IN LISTS deps)
|
||||
add_dependencies(${name}-${step} ${arg})
|
||||
endforeach()
|
||||
if(NOT no_deps)
|
||||
get_property(deps TARGET ${name} PROPERTY _EP_DEPENDS)
|
||||
foreach(arg IN LISTS deps)
|
||||
add_dependencies(${name}-${step} ${arg})
|
||||
endforeach()
|
||||
endif()
|
||||
endforeach()
|
||||
endfunction()
|
||||
|
||||
@@ -1386,6 +1432,7 @@ function(ExternalProject_Add_Step name step)
|
||||
WORKING_DIRECTORY ${work_dir}
|
||||
VERBATIM
|
||||
)
|
||||
set_property(TARGET ${name} APPEND PROPERTY _EP_STEPS ${step})
|
||||
|
||||
# Add custom "step target"?
|
||||
get_property(step_targets TARGET ${name} PROPERTY _EP_STEP_TARGETS)
|
||||
@@ -1398,6 +1445,60 @@ function(ExternalProject_Add_Step name step)
|
||||
break()
|
||||
endif()
|
||||
endforeach()
|
||||
|
||||
get_property(independent_step_targets TARGET ${name} PROPERTY _EP_INDEPENDENT_STEP_TARGETS)
|
||||
if(NOT independent_step_targets)
|
||||
get_property(independent_step_targets DIRECTORY PROPERTY EP_INDEPENDENT_STEP_TARGETS)
|
||||
endif()
|
||||
foreach(st ${independent_step_targets})
|
||||
if("${st}" STREQUAL "${step}")
|
||||
ExternalProject_Add_StepTargets(${name} NO_DEPENDS ${step})
|
||||
break()
|
||||
endif()
|
||||
endforeach()
|
||||
endfunction()
|
||||
|
||||
|
||||
function(ExternalProject_Add_StepDependencies name step)
|
||||
set(dependencies ${ARGN})
|
||||
|
||||
# Sanity checks on "name" and "step".
|
||||
if(NOT TARGET ${name})
|
||||
message(FATAL_ERROR "Cannot find target \"${name}\". Perhaps it has not yet been created using ExternalProject_Add.")
|
||||
endif()
|
||||
|
||||
get_property(is_ep TARGET ${name} PROPERTY _EP_IS_EXTERNAL_PROJECT)
|
||||
if(NOT is_ep)
|
||||
message(FATAL_ERROR "Target \"${name}\" was not generated by ExternalProject_Add.")
|
||||
endif()
|
||||
|
||||
get_property(steps TARGET ${name} PROPERTY _EP_STEPS)
|
||||
list(FIND steps ${step} is_step)
|
||||
if(NOT is_step)
|
||||
message(FATAL_ERROR "External project \"${name}\" does not have a step \"${step}\".")
|
||||
endif()
|
||||
|
||||
if(TARGET ${name}-${step})
|
||||
get_property(is_ep_step TARGET ${name}-${step} PROPERTY _EP_IS_EXTERNAL_PROJECT_STEP)
|
||||
if(NOT is_ep_step)
|
||||
message(FATAL_ERROR "Target \"${name}\" was not generated by ExternalProject_Add_StepTargets.")
|
||||
endif()
|
||||
endif()
|
||||
|
||||
# Always add file-level dependency, but add target-level dependency
|
||||
# only if the target exists for that step.
|
||||
_ep_get_step_stampfile(${name} ${step} stamp_file)
|
||||
foreach(dep ${dependencies})
|
||||
add_custom_command(APPEND
|
||||
OUTPUT ${stamp_file}
|
||||
DEPENDS ${dep})
|
||||
if(TARGET ${name}-${step})
|
||||
foreach(dep ${dependencies})
|
||||
add_dependencies(${name}-${step} ${dep})
|
||||
endforeach()
|
||||
endif()
|
||||
endforeach()
|
||||
|
||||
endfunction()
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user