zuul/zuul
Code Issues Proposed changes

Merge "Clarify anonymous nodeset docs"

Browse Source
This commit is contained in:
Zuul 2022-03-08 00:37:33 +00:00 committed by Gerrit Code Review
commit 6f122dc18d
2 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/source/config/job.rst
View File

@ -367,9 +367,10 @@ Here is an example of two job definitions:
may be supplied either as a string, in which case it references
a :ref:`nodeset` definition which appears elsewhere in the
configuration, or a dictionary, in which case it is interpreted
in the same way as a Nodeset definition, though the ``name``
attribute should be omitted (in essence, it is an anonymous
Nodeset definition unique to this job). See the :ref:`nodeset`
in the same way as a Nodeset definition, though the top-level
nodeset ``name`` attribute should be omitted (in essence, it is
an anonymous Nodeset definition unique to this job; the nodes
themselves still require names). See the :ref:`nodeset`
reference for the syntax to use in that case.
If a job has an empty (or no) :ref:`nodeset` definition, it will

4
doc/source/config/nodeset.rst
View File

@ -49,6 +49,10 @@ branch will not immediately produce a configuration error.
The name of the Nodeset, to be referenced by a :ref:`job`.
This is required when defining a standalone Nodeset in Zuul.
When defining an in-line anonymous nodeset within a job
definition, this attribute should be omitted.
.. attr:: nodes
:required: