summaryrefslogtreecommitdiff
path: root/doc/source/client.rst
diff options
context:
space:
mode:
authorAntoine Musso <hashar@free.fr>2014-06-30 21:35:26 +0200
committerAntoine Musso <hashar@free.fr>2014-06-30 21:35:26 +0200
commit6aa898464fdd68eb0594ce61ce638d5834440e80 (patch)
treeb164e432f8d28ef07709964d11661ca7cf170ed9 /doc/source/client.rst
parentae6b9ee599098c8e6995b09f1461af0d12774042 (diff)
downloadzuul-6aa898464fdd68eb0594ce61ce638d5834440e80.tar.gz
Sphinx doc for zuul {promote,show}
The Zuul client documentation was missing entries for the promote and show sub commands. Change-Id: Ia5501886984c8be2f900389bd65c166e093d416d
Diffstat (limited to 'doc/source/client.rst')
-rw-r--r--doc/source/client.rst18
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/source/client.rst b/doc/source/client.rst
index 1a843e504..5fe22523d 100644
--- a/doc/source/client.rst
+++ b/doc/source/client.rst
@@ -31,3 +31,21 @@ Example::
zuul enqueue --trigger gerrit --pipeline check --project example_project --change 12345,1
Note that the format of change id is <number>,<patchset>.
+
+Promote
+^^^^^^^
+.. program-output:: zuul promote --help
+
+Example::
+
+ zuul promote --pipeline check --changes 12345,1 13336,3
+
+Note that the format of changes id is <number>,<patchset>.
+
+Show
+^^^^
+.. program-output:: zuul show --help
+
+Example::
+
+ zuul show running-jobs