Signed-off-by: Stephen Finucane <step...@that.guru> Cc: Florent Revest <rev...@chromium.org> --- README.rst | 20 ++++++++++++++++++++ docs/usage/clients.rst | 32 +++++++++++++++++++++++++++----- 2 files changed, 47 insertions(+), 5 deletions(-)
diff --git README.rst README.rst index 94ae431d..979801fb 100644 --- README.rst +++ README.rst @@ -38,6 +38,26 @@ subsystems of the Linux kernel. Although Patchwork has been developed with the kernel workflow in mind, the aim is to be flexible enough to suit the majority of community projects. +Usage +----- + +Patchwork provides a web UI, a REST API, and a XML-RPC API (*deprecated*). You +can use the APIs to `build you own application`__ or you can use one the many +`existing clients`__. + +There are many existing Patchwork instances. Unless you're a larger project +that is already hosting many of its own resources, you may wish to request a +project on one of these instances. + +- patchwork.ozlabs.org +- patchwork.kernel.org +- patches.linaro.org +- patchwork.sourceware.org +- patchwork.open-mesh.org + +__ https://patchwork.readthedocs.io/en/latest/development/api/ +__ https://patchwork.readthedocs.io/en/latest/usage/clients/ + Requirements ------------ diff --git docs/usage/clients.rst docs/usage/clients.rst index 01dd62a2..47ddb3a1 100644 --- docs/usage/clients.rst +++ docs/usage/clients.rst @@ -4,6 +4,13 @@ Clients A number of clients are available for interacting with Patchwork's various APIs. +.. note:: + + Got a client that you think might be useful to the broader community? Feel + free to add it to this page by `submitting a patch`__. + + __ https://patchwork.readthedocs.io/en/latest/development/contributing/ + pwclient -------- @@ -31,7 +38,7 @@ __ https://github.com/getpatchwork/pwclient/ git-pw ------ -The :program:`git-pw` application can be used to integrate Git with Patchwork. +The :program:`git-pw` application can be used to integrate Patchwork with Git. The :program:`git-pw` application relies on the REST API and can be used to interact to list, download and apply series, bundles and individual patches. @@ -42,13 +49,28 @@ __ https://git-pw.readthedocs.io/ __ https://github.com/getpatchwork/git-pw/ +VSCode-Patchwork +---------------- + +The *Patchwork* VSCode plugin can be used to integrate Patchwork with VSCode. +This plugin relies on the REST API and can be used to view both patches and +series and to apply them locally. You can also browse patches and series and +look at replies. + +More information on the *Patchwork* VSCode plugin can be found on the `VSCode +Marketplace`__ and the `GitHub repo`__. + +__ https://marketplace.visualstudio.com/items?itemName=florent-revest.patchwork +__ https://github.com/FlorentRevest/vscode-patchwork + + 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. +The *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`__. -- 2.37.3 _______________________________________________ Patchwork mailing list Patchwork@lists.ozlabs.org https://lists.ozlabs.org/listinfo/patchwork