summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2023-07-20 14:23:04 (GMT)
committerKitware Robot <kwrobot@kitware.com>2023-07-20 14:23:31 (GMT)
commit88c6dc75ba864cac5a755ca4f4951d559b068443 (patch)
treebe930e6bc9e681758d65700d32c9d254f5a75de5 /Help
parente0ed4d7a6f9a2c9fe35360b2d9fb208eca5311f0 (diff)
parent95941fd99020bb2345869ed393abde1a44529837 (diff)
downloadCMake-88c6dc75ba864cac5a755ca4f4951d559b068443.zip
CMake-88c6dc75ba864cac5a755ca4f4951d559b068443.tar.gz
CMake-88c6dc75ba864cac5a755ca4f4951d559b068443.tar.bz2
Merge topic 'command-job-server-aware'
95941fd990 add_custom_{target,command}: Add argument JOB_SERVER_AWARE Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: buildbot <buildbot@kitware.com> Merge-request: !8547
Diffstat (limited to 'Help')
-rw-r--r--Help/command/add_custom_command.rst14
-rw-r--r--Help/command/add_custom_target.rst14
-rw-r--r--Help/release/dev/command-job-server-aware.rst5
3 files changed, 33 insertions, 0 deletions
diff --git a/Help/command/add_custom_command.rst b/Help/command/add_custom_command.rst
index aa232cb..c305cc2 100644
--- a/Help/command/add_custom_command.rst
+++ b/Help/command/add_custom_command.rst
@@ -24,6 +24,7 @@ The first signature is for adding a custom command to produce an output:
[COMMENT comment]
[DEPFILE depfile]
[JOB_POOL job_pool]
+ [JOB_SERVER_AWARE <bool>]
[VERBATIM] [APPEND] [USES_TERMINAL]
[COMMAND_EXPAND_LISTS]
[DEPENDS_EXPLICIT_ONLY])
@@ -221,6 +222,19 @@ The options are:
Using a pool that is not defined by :prop_gbl:`JOB_POOLS` causes
an error by ninja at build time.
+``JOB_SERVER_AWARE``
+ .. versionadded:: 3.28
+
+ Specify that the command is GNU Make job server aware.
+
+ For the :generator:`Unix Makefiles`, :generator:`MSYS Makefiles`, and
+ :generator:`MinGW Makefiles` generators this will add the ``+`` prefix to the
+ recipe line. See the `GNU Make Documentation`_ for more information.
+
+ This option is silently ignored by other generators.
+
+.. _`GNU Make Documentation`: https://www.gnu.org/software/make/manual/html_node/MAKE-Variable.html
+
``MAIN_DEPENDENCY``
Specify the primary input source file to the command. This is
treated just like any value given to the ``DEPENDS`` option
diff --git a/Help/command/add_custom_target.rst b/Help/command/add_custom_target.rst
index 545b9a5..ef0c8d9 100644
--- a/Help/command/add_custom_target.rst
+++ b/Help/command/add_custom_target.rst
@@ -12,6 +12,7 @@ Add a target with no output so it will always be built.
[WORKING_DIRECTORY dir]
[COMMENT comment]
[JOB_POOL job_pool]
+ [JOB_SERVER_AWARE <bool>]
[VERBATIM] [USES_TERMINAL]
[COMMAND_EXPAND_LISTS]
[SOURCES src1 [src2...]])
@@ -146,6 +147,19 @@ The options are:
Using a pool that is not defined by :prop_gbl:`JOB_POOLS` causes
an error by ninja at build time.
+``JOB_SERVER_AWARE``
+ .. versionadded:: 3.28
+
+ Specify that the command is GNU Make job server aware.
+
+ For the :generator:`Unix Makefiles`, :generator:`MSYS Makefiles`, and
+ :generator:`MinGW Makefiles` generators this will add the ``+`` prefix to the
+ recipe line. See the `GNU Make Documentation`_ for more information.
+
+ This option is silently ignored by other generators.
+
+.. _`GNU Make Documentation`: https://www.gnu.org/software/make/manual/html_node/MAKE-Variable.html
+
``SOURCES``
Specify additional source files to be included in the custom target.
Specified source files will be added to IDE project files for
diff --git a/Help/release/dev/command-job-server-aware.rst b/Help/release/dev/command-job-server-aware.rst
new file mode 100644
index 0000000..224c739
--- /dev/null
+++ b/Help/release/dev/command-job-server-aware.rst
@@ -0,0 +1,5 @@
+command-job-server-aware
+------------------------
+
+* The :command:`add_custom_command` and :command:`add_custom_target`
+ commands gained a ``JOB_SERVER_AWARE`` option.