mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-04-23 22:58:37 -05:00
Code Issues Packages Projects Releases Wiki Activity

ExternalProject: Enable Make Job Server with Explicit Build Command

Browse Source 
Introduces `BUILD_JOB_SERVER_AWARE` option to `ExternalProject_Add` and
`JOB_SERVER_AWARE` to `ExternalProject_Add_Step`. When using an explicit
`BUILD_COMMAND` or `COMMAND`, the generated commands won't use `$(MAKE)`
thus failing to connect to the outer make's job server. These new
options enable explicit job server integration.

Co-authored-by: Brad King <brad.king@kitware.com>

Fixes: #16273
This commit is contained in:
Chris Mahoney
2023-08-09 14:28:25 +00:00
parent 99be022428
commit bc43398e72
8 changed files with 121 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Modules/ExternalProject.cmake
+40
View File
@@ -684,6 +684,14 @@ pass ``-v`` to the external project's build step, even if it also uses
build step's own underlying call to :command:`add_custom_command`, which
has additional documentation.
``BUILD_JOB_SERVER_AWARE <bool>``
.. versionadded:: 3.28
Specifies that the build step is aware of the GNU Make job server.
See the :command:`add_custom_command` documentation of its
``JOB_SERVER_AWARE`` option for details. This option is relevant
only when an explicit ``BUILD_COMMAND`` is specified.
Install Step Options
""""""""""""""""""""
@@ -1021,6 +1029,13 @@ control needed to implement such step-level capabilities.
When enabled, this option specifies that the custom step should always be
run (i.e. that it is always considered out of date).
``JOB_SERVER_AWARE <bool>``
.. versionadded:: 3.28
Specifies that the custom step is aware of the GNU Make job server.
See the :command:`add_custom_command` documentation of its
``JOB_SERVER_AWARE`` option for details.
``EXCLUDE_FROM_MAIN <bool>``
When enabled, this option specifies that the external project's main target
does not depend on the custom step.
@@ -2366,6 +2381,7 @@ function(ExternalProject_Add_Step name step)
INDEPENDENT
BYPRODUCTS
ALWAYS
JOB_SERVER_AWARE
EXCLUDE_FROM_MAIN
WORKING_DIRECTORY
LOG
@@ -2545,6 +2561,16 @@ function(ExternalProject_Add_Step name step)
set(maybe_COMMAND_touch "COMMAND \${CMAKE_COMMAND} -E touch \${stamp_file}")
endif()
get_property(job_server_aware
TARGET ${name}
PROPERTY _EP_${step}_JOB_SERVER_AWARE
)
if(job_server_aware)
set(maybe_JOB_SERVER_AWARE "JOB_SERVER_AWARE 1")
else()
set(maybe_JOB_SERVER_AWARE "")
endif()
# Wrap with log script?
get_property(log TARGET ${name} PROPERTY _EP_${step}_LOG)
if(command AND log)
@@ -2571,6 +2597,7 @@ function(ExternalProject_Add_Step name step)
COMMENT \${comment}
COMMAND ${__cmdQuoted}
${maybe_COMMAND_touch}
${maybe_JOB_SERVER_AWARE}
DEPENDS \${depends}
WORKING_DIRECTORY \${work_dir}
VERBATIM
@@ -3945,6 +3972,17 @@ function(_ep_add_build_command name)
PROPERTY _EP_BUILD_BYPRODUCTS
)
get_property(build_job_server_aware
TARGET ${name}
PROPERTY _EP_BUILD_JOB_SERVER_AWARE
)
if(build_job_server_aware)
set(maybe_JOB_SERVER_AWARE "JOB_SERVER_AWARE 1")
else()
set(maybe_JOB_SERVER_AWARE "")
endif()
set(__cmdQuoted)
foreach(__item IN LISTS cmd)
string(APPEND __cmdQuoted " [==[${__item}]==]")
@@ -3958,6 +3996,7 @@ function(_ep_add_build_command name)
DEPENDEES configure
DEPENDS \${file_deps}
ALWAYS \${always}
${maybe_JOB_SERVER_AWARE}
${log}
${uses_terminal}
)"
@@ -4252,6 +4291,7 @@ function(ExternalProject_Add name)
BUILD_IN_SOURCE
BUILD_ALWAYS
BUILD_BYPRODUCTS
BUILD_JOB_SERVER_AWARE
#
# Install step options
#