diff options
Diffstat (limited to 'docs/usage/xmlrpc.rst')
| -rw-r--r-- | docs/usage/xmlrpc.rst | 51 |
1 files changed, 0 insertions, 51 deletions
diff --git a/docs/usage/xmlrpc.rst b/docs/usage/xmlrpc.rst deleted file mode 100644 index 1bebcc8..0000000 --- a/docs/usage/xmlrpc.rst +++ /dev/null @@ -1,51 +0,0 @@ -The XML-RPC API -=============== - -.. note:: - - This guide covers usage information for the Patchwork XML-RPC API. For - information on using the REST API, refer to :doc:`rest`. For information on - developing custom applications or clients for this API, refer to the - :doc:`../development/xmlrpc`. - -Patchwork provides an XML-RPC API. This API can be used to be used to retrieve -and modify information about patches, projects and more. - -.. important:: - - The XML-RPC API can be enabled/disabled by the administrator: it may not be - available in every instance. Refer to ``/about`` on your given instance for - the status of the API, e.g. - - https://patchwork.ozlabs.org/about - - This URL is only supported on Patchwork 2.0+. - -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`__, 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: - -.. code-block:: shell - - $ pwclient --help - -__ https://patchwork.ozlabs.org/pwclient/ |