zuul
/
zuul
Code Issues Proposed changes

Merge "Clarify terms around pause-job documentation"

This commit is contained in:
Zuul 2020-11-30 20:43:32 +00:00 committed by Gerrit Code Review
parent 25d7e18816 7a031f73b0
commit 49976c439d
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/source/reference/jobs.rst
View File

@ -912,12 +912,12 @@ the elements of `zuul.file_comments` from each invocation will be appended.
Pausing the job
~~~~~~~~~~~~~~~
A job can be paused after the run phase. In this case the child jobs can start
and the parent job stays paused until all child jobs are finished. This for
example can be useful to start a docker registry in a parent job that will be
used by the child job. To indicate that the job should be paused use
A job can be paused after the run phase. In this case the dependent jobs can start
and the prior job stays paused until all dependent jobs are finished. This for
example can be useful to start a docker registry in a job that will be
used by the dependent job. To indicate that the job should be paused use
*zuul_return* to set the **zuul.pause** value. You still can at the same time
supply any arbitrary data to the child jobs. For example:
supply any arbitrary data to the dependent jobs. For example:
.. code-block:: yaml