Document zuul-changes.py tool script.
* doc/source/zuul.rst: Mention zuul-changes.py and provide sample
syntax in the restarting section.
Change-Id: I05888ca40e16681111e56b9ebf92acc3dc36175b
Reviewed-on: https://review.openstack.org/23938
Reviewed-by: Clark Boylan <clark.boylan@gmail.com>
Approved: Monty Taylor <mordred@inaugust.com>
Reviewed-by: Monty Taylor <mordred@inaugust.com>
Tested-by: Jenkins
diff --git a/doc/source/zuul.rst b/doc/source/zuul.rst
index 3863500..7f3dfbb 100644
--- a/doc/source/zuul.rst
+++ b/doc/source/zuul.rst
@@ -529,3 +529,14 @@
then exit. While waiting to exit Zuul will queue Gerrit events and
save these events prior to exiting. When Zuul starts again it will
read these saved events and act on them.
+
+If you need to abort zuul and intend to manually requeue changes for
+jobs which were running in its pipelines, prior to terminating you can
+use the zuul-changes.py tool script to simplify the process. For
+example, this would give you a list of Gerrit commands to reverify or
+recheck changes for the gate and check pipelines respectively::
+
+ ./tools/zuul-changes.py --review-host=review.openstack.org \
+ http://zuul.openstack.org/ gate 'reverify no bug'
+ ./tools/zuul-changes.py --review-host=review.openstack.org \
+ http://zuul.openstack.org/ check 'recheck no bug'