diff mbox series

[1/3] docs: document snowpatch as an API client

Message ID 20191018024149.8775-2-dja@axtens.net
State Accepted
Headers show
Series Remove XML-RPC API | expand

Commit Message

Daniel Axtens Oct. 18, 2019, 2:41 a.m. UTC
Snowpatch is one of the few publically visible API clients.
Document it in the clients list.

Signed-off-by: Daniel Axtens <dja@axtens.net>
---
 docs/usage/clients.rst | 13 +++++++++++++
 1 file changed, 13 insertions(+)

Comments

Stephen Finucane Oct. 18, 2019, 5:30 a.m. UTC | #1
On Fri, 2019-10-18 at 13:41 +1100, Daniel Axtens wrote:
> Snowpatch is one of the few publically visible API clients.
> Document it in the clients list.
> 
> Signed-off-by: Daniel Axtens <dja@axtens.net>

This can go in as part of 2.2, IMO. There's nothing specific to the
XML-RPC API removal in here.

Reviewed-by: Stephen Finucane <stephen@that.guru>

Stephen

> ---
>  docs/usage/clients.rst | 13 +++++++++++++
>  1 file changed, 13 insertions(+)
> 
> diff --git docs/usage/clients.rst docs/usage/clients.rst
> index 57c8a1a14a4d..01dd62a28e50 100644
> --- docs/usage/clients.rst
> +++ docs/usage/clients.rst
> @@ -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
Daniel Axtens Oct. 18, 2019, 5:47 a.m. UTC | #2
Stephen Finucane <stephen@that.guru> writes:

> On Fri, 2019-10-18 at 13:41 +1100, Daniel Axtens wrote:
>> Snowpatch is one of the few publically visible API clients.
>> Document it in the clients list.
>> 
>> Signed-off-by: Daniel Axtens <dja@axtens.net>
>
> This can go in as part of 2.2, IMO. There's nothing specific to the
> XML-RPC API removal in here.

Yeah, I was planning for that, it was just simpler to send them as 1
series. Applied.

Regards,
Daniel
>
> Reviewed-by: Stephen Finucane <stephen@that.guru>
>
> Stephen
>
>> ---
>>  docs/usage/clients.rst | 13 +++++++++++++
>>  1 file changed, 13 insertions(+)
>> 
>> diff --git docs/usage/clients.rst docs/usage/clients.rst
>> index 57c8a1a14a4d..01dd62a28e50 100644
>> --- docs/usage/clients.rst
>> +++ docs/usage/clients.rst
>> @@ -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
diff mbox series

Patch

diff --git docs/usage/clients.rst docs/usage/clients.rst
index 57c8a1a14a4d..01dd62a28e50 100644
--- docs/usage/clients.rst
+++ docs/usage/clients.rst
@@ -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