]> git.ipfire.org Git - thirdparty/patchwork.git/commitdiff
docs: document snowpatch as an API client
authorDaniel Axtens <dja@axtens.net>
Fri, 18 Oct 2019 02:41:47 +0000 (13:41 +1100)
committerDaniel Axtens <dja@axtens.net>
Fri, 18 Oct 2019 05:43:42 +0000 (16:43 +1100)
Snowpatch is one of the few publically visible API clients.
Document it in the clients list.

Signed-off-by: Daniel Axtens <dja@axtens.net>
Reviewed-by: Stephen Finucane <stephen@that.guru>
docs/usage/clients.rst

index 57c8a1a14a4db60ecc5335ac9327eaf3fc6bc737..01dd62a28e503461b3dd583f5e813cb53d753878 100644 (file)
@@ -40,3 +40,16 @@ instructions, can be found in the `documentation`__ and the `GitHub repo`__.
 
 __ https://git-pw.readthedocs.io/
 __ https://github.com/getpatchwork/git-pw/
+
+
+snowpatch
+---------
+
+The :program:`snowpatch` application is a bridge between Patchwork and the
+Jenkins continuous integration automation server. It monitors the REST API
+for incoming patches, applies them on top of an existing git tree, triggers
+appropriate builds and test suites, and reports the results back to Patchwork.
+
+Find out more about :program:`snowpatch` at its `GitHub repo`__.
+
+__ https://github.com/ruscur/snowpatch