Browse Source

Minor fixes to styling and coherency

Adds missing periods in item descriptions to bring in line with
the rest of the documentation. Also fixes some typos and styling.

Change-Id: I11ef0bf3f89ecf5f09bb5781cced9b655c71bc65
changes/42/77442/1
Łukasz Jernaś 8 years ago
parent
commit
048acb4b20
  1. 28
      doc/source/launchers.rst
  2. 4
      doc/source/reporters.rst
  3. 14
      doc/source/zuul.rst

28
doc/source/launchers.rst

@ -77,17 +77,17 @@ as well as to the running job as environment variables. They are as
follows:
**ZUUL_UUID**
Zuul provided key to link builds with Gerrit events
Zuul provided key to link builds with Gerrit events.
**ZUUL_REF**
Zuul provided ref that includes commit(s) to build
Zuul provided ref that includes commit(s) to build.
**ZUUL_COMMIT**
The commit SHA1 at the head of ZUUL_REF
The commit SHA1 at the head of ZUUL_REF.
**ZUUL_PROJECT**
The project that triggered this build
The project that triggered this build.
**ZUUL_PIPELINE**
The Zuul pipeline that is building this job
The Zuul pipeline that is building this job.
**ZUUL_URL**
The url for the zuul server as configured in zuul.conf.
The URL for the zuul server as configured in zuul.conf.
A test runner may use this URL as the basis for fetching
git commits.
@ -96,28 +96,28 @@ associated with changes (i.e., in response to patchset-created or
comment-added events):
**ZUUL_BRANCH**
The target branch for the change that triggered this build
The target branch for the change that triggered this build.
**ZUUL_CHANGE**
The Gerrit change ID for the change that triggered this build
The Gerrit change ID for the change that triggered this build.
**ZUUL_CHANGE_IDS**
All of the Gerrit change IDs that are included in this build (useful
when the DependentPipelineManager combines changes for testing)
when the DependentPipelineManager combines changes for testing).
**ZUUL_PATCHSET**
The Gerrit patchset number for the change that triggered this build
The Gerrit patchset number for the change that triggered this build.
The following additional parameters will only be provided for
post-merge (ref-updated) builds:
**ZUUL_OLDREV**
The SHA1 of the old revision at this ref (recall the ref name is
in ZUUL_REF)
in ZUUL_REF).
**ZUUL_NEWREV**
The SHA1 of the new revision at this ref (recall the ref name is
in ZUUL_REF)
in ZUUL_REF).
**ZUUL_SHORT_OLDREV**
The shortened (7 character) SHA1 of the old revision
The shortened (7 character) SHA1 of the old revision.
**ZUUL_SHORT_NEWREV**
The shortened (7 character) SHA1 of the new revision
The shortened (7 character) SHA1 of the new revision.
In order to test the correct build, configure the Jenkins Git SCM
plugin as follows::

4
doc/source/reporters.rst

@ -39,10 +39,10 @@ A simple email reporter is also available.
SMTP Configuration
~~~~~~~~~~~~~~~~~~
zuul.conf contains the SMTP server and default to/from as describe
zuul.conf contains the SMTP server and default to/from as described
in :ref:`zuulconf`.
Each pipeline can overwrite the subject or the to or from address by
Each pipeline can overwrite the ``subject`` or the ``to`` or ``from`` address by
providing alternatives as arguments to the reporter. For example, ::
pipelines:

14
doc/source/zuul.rst

@ -10,11 +10,11 @@ Zuul has three configuration files:
**zuul.conf**
Connection information for Gerrit and Gearman, locations of the
other config files
other config files.
**layout.yaml**
Project and pipeline configuration -- what Zuul does
Project and pipeline configuration -- what Zuul does.
**logging.conf**
Python logging config
Python logging config.
Examples of each of the three files can be found in the etc/ directory
of the source distribution.
@ -46,7 +46,7 @@ gearman
``server=gearman.example.com``
**port**
Port on which the Gearman server is listening
Port on which the Gearman server is listening.
``port=4730``
gearman_server
@ -365,14 +365,14 @@ explanation of each of the parameters::
If present, the approval must be older than this amount of time
to match. Provide a time interval as a number with a suffix of
"w" (weeks), "d" (days), "h" (hours), "m" (minutes), "s"
(seconds). Example "48h" or "2d".
(seconds). Example ``48h`` or ``2d``.
*newer-than*
If present, the approval must be newer than this amount of time
to match. Same format as "older-than".
Any other field is interpreted as a review category and value
pair. For example "verified: 1" would require that the approval
pair. For example ``verified: 1`` would require that the approval
be for a +1 vote in the "Verified" column.
**timer**
@ -547,7 +547,7 @@ That kind of pipeline is nice to run regression or performance tests.
The ``change-merged`` event does not include the commit sha1 which can be
hazardous, it would let you report back to Gerrit though. If you were to
build a tarball for a specific commit, you should consider instead using
the ``ref-updated`` event which does include the commit sha1 (but lack the
the ``ref-updated`` event which does include the commit sha1 (but lacks the
Gerrit change number).
Jobs

Loading…
Cancel
Save