Document undocumented ci-jobs macros
[releng/global-jjb.git] / docs / jjb / lf-macros.rst
index 724dad6..08722cf 100644 (file)
@@ -91,6 +91,24 @@ Run `packer validate` to verify packer configuration.
         server as CLOUDENV environment variable.
     :packer-version: Version of packer to use.
 
         server as CLOUDENV environment variable.
     :packer-version: Version of packer to use.
 
+lf-infra-push-gerrit-patch
+--------------------------
+
+Push a change through a Jenkins job to a Gerrit repository in an automated
+way using git-review.
+
+:Required parameters:
+
+    :gerrit-commit-message: Commit message to assign.
+    :gerrit-host: Gerrit hostname.
+    :gerrit-topic: Gerrit topic.
+    :gerrit-user: Gerrit user-id used for submitting the change.
+    :reviewers-email: Reviewers email. Space-separated list of
+        email addresses to CC on the patch.
+    :project: Gerrit project name.
+
+.. _lf-infra-ship-logs:
+
 lf-infra-ship-logs
 ------------------
 
 lf-infra-ship-logs
 ------------------
 
@@ -149,6 +167,11 @@ lf-rtd-verify
 
 ReadTheDocs verify script.
 
 
 ReadTheDocs verify script.
 
+lf-infra-provide-docker-cleanup
+-------------------------------
+
+Forcibly removes all of the docker images.
+
 Parameters
 ==========
 
 Parameters
 ==========
 
@@ -218,14 +241,6 @@ On the `branch` variable you can assign `$sha1` or `$ghprbActualCommit`
 as the value.  This will require that the job be triggered via
 the GHPRB plugin and not manually.
 
 as the value.  This will require that the job be triggered via
 the GHPRB plugin and not manually.
 
-Triggers
-========
-
-lf-infra-github-pr-trigger
---------------------------
-
-Provides configuration for a GitHub PR Trigger.
-
 Wrappers
 ========
 
 Wrappers
 ========