From e9c8a85f0d91b75ab931837dd2c997ff027955eb Mon Sep 17 00:00:00 2001
From: Ian Wienand <iwienand@redhat.com>
Date: Tue, 8 Apr 2014 16:08:47 +1000
Subject: [PATCH] Add example of comment formatting

Add a link to the regex's for comment formatting and an example of how
to format test results nicely

Change-Id: Id917161ccf5e51855acf87a87544882dcf69b14e
---
 doc/source/third_party.rst | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/doc/source/third_party.rst b/doc/source/third_party.rst
index 206cea3c77..00868e6cef 100644
--- a/doc/source/third_party.rst
+++ b/doc/source/third_party.rst
@@ -112,6 +112,14 @@ setup to test on if required.  In SmokeStack's case all failures are manually
 reviewed before getting pushed to OpenStack, whilst this may no scale it is
 advisable during initial testing of the setup.
 
+There are several triggers that gerrit will match to alter the
+formatting of comments.  The raw regular expressions can be seen in
+`gerrit.pp <https://git.openstack.org/cgit/openstack-infra/config/tree/modules/openstack_project/manifests/gerrit.pp>`_.
+For example, to have your test results formatted in the same manner as
+the upstream Jenkins results, use a template for each result matching::
+
+  * test-name-no-spaces http://link.to/result : [SUCCESS|FAILURE] some comment about the test
+
 .. _request-account-label:
 
 Requesting a Service Account