zuul/zuul
Code Issues Proposed changes

Clarify anonymous nodeset docs

Browse Source 
The admonition to omit the "name" attribute in an anonymous nodeset
appears to be ambiguous as to which "name" to drop.  Clarify that.

Change-Id: I1abab0c40358365612c28a577188d27d71a94c59
This commit is contained in:
James E. Blair
2022-03-04 06:52:28 -08:00
parent bb2b38c4be
commit fb586ff6cd
2 changed files with 8 additions and 3 deletions
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: