Document lf-infra-push-gerrit-patch macro in RTD 43/11043/4
authorAnil Belur <abelur@linuxfoundation.org>
Wed, 6 Jun 2018 03:28:47 +0000 (13:28 +1000)
committerAnil Belur <abelur@linuxfoundation.org>
Thu, 7 Jun 2018 23:01:35 +0000 (09:01 +1000)
JIRA: RELENG-945
Change-Id: I709aec08a10bb6a55b1c84c71c32c303bc1fdce5
Signed-off-by: Anil Belur <abelur@linuxfoundation.org>
docs/jjb/lf-macros.rst

index 558aedd..9f7693a 100644 (file)
@@ -91,6 +91,22 @@ Run `packer validate` to verify packer configuration.
         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
 ------------------