From 885e2020abea4c117665420ddce67711e9934176 Mon Sep 17 00:00:00 2001 From: Stephen Finucane Date: Tue, 11 Oct 2016 18:14:36 +0100 Subject: docs: Rework XML-RPC docs Add a barebones usage guide for pwclient and simplify the existing doc for this API. This entails move the existing doc from the deployment section to development section, which makes more sense given its focus. Signed-off-by: Stephen Finucane --- docs/usage/xmlrpc.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 docs/usage/xmlrpc.md (limited to 'docs/usage') diff --git a/docs/usage/xmlrpc.md b/docs/usage/xmlrpc.md new file mode 100644 index 0000000..de95a07 --- /dev/null +++ b/docs/usage/xmlrpc.md @@ -0,0 +1,37 @@ +# The XML-RPC API + +**NOTE:** This guide covers usage information for the Patchwork XML-RPC API. +For information on developing custom applications or clients for this API, +refer to the [developers documentation][doc-development]. + +Patchwork provides an XML-RPC API. This API can be used to be used to retrieve +and modify information about patches, projects and more. + +**NOTE:** The XML-RPC API can be enabled/disabled by the administrator: it may +not be available in every instance. + +## pwclient + +The `pwclient` application, provided with Patchwork, can be used to interact +with Patchwork from the command line. Functionality provided by `pwclient` +includes: + +* Listing patches, projects, and checks +* Downloading and applying patches to a local code base +* Modifying the status of patches +* Creating new checks + +pwclient can be downloaded from the [Ozlabs Patchwork instance][ref-pw-oz], or +at the following path for other Patchwork instances: + + http://patchwork.example.com/pwclient/ + +where `patchwork.example.com` corresponds to the URL a Patchwork instance is +hosted at. + +Once downloaded, to view information about all the operations supported by +`pwclient`, run: + + $ pwclient --help + +[doc-development]: ../development/xmlrpc.md -- cgit v1.2.3