Now that Patchwork 2.0 is out, folks can start to take advantage of some of the new features that it offers. Chief among these is series support, which is only exposed via the web UI and new REST API and which, in turn, necessitates using git-pw rather than pwclient. As such, this tool is slightly documented.
Signed-off-by: Stephen Finucane <[email protected]> --- PS: I still plan to get back to converting the man pages to rST, but have been sidetracked by other projects/work. Eventually! :) --- Documentation/internals/patchwork.rst | 34 ++++++++++++++++++++++++++-------- 1 file changed, 26 insertions(+), 8 deletions(-) diff --git a/Documentation/internals/patchwork.rst b/Documentation/internals/patchwork.rst index 3ae0d9503..07b233bd3 100644 --- a/Documentation/internals/patchwork.rst +++ b/Documentation/internals/patchwork.rst @@ -29,33 +29,51 @@ Patchwork Open vSwitch uses `Patchwork`__ to track the status of patches sent to the :doc:`ovs-dev mailing list <mailing-lists>`. The Open vSwitch Patchwork -instance can be found on `ozlabs.org`__. The ``pwclientrc`` file, required for -*pwclient*, can be found on the `project page`__ +instance can be found on `ozlabs.org`__. Patchwork provides a number of useful features for developers working on Open vSwitch: - Tracking the lifecycle of patches (accepted, rejected, under-review, ...) - Assigning reviewers (delegates) to patches -- Downloading/applying patches via the web UI or the XML-RPC API (see - :ref:`pwclient`) +- Downloading/applying patches, series, and bundles via the web UI, REST API + (see :ref:`git-pw`), or the legacy XML-RPC API (see :ref:`pwclient`) - A usable UI for viewing patch discussions __ https://github.com/getpatchwork/patchwork __ https://patchwork.ozlabs.org/project/openvswitch/list/ -__ https://patchwork.ozlabs.org/project/openvswitch/ + +.. _git-pw: + +git-pw +------ + +The *git-pw* tool provides a way to download and apply patches, series, and +bundles. You can install *git-pw* from `PyPi`__ like so:: + + $ pip install --user git-pw + +Once installed, run:: + + $ git pw --help + +to get more information about the functionality *git-pw* provides. + +__ https://pypi.python.org/pypi/git-pw .. _pwclient: pwclient -------- -The *pwclient* tool provides an way to download and apply patches, change the +The *pwclient* tool provides a way to download and apply patches, change the state of patches in Patchwork, and more. You can download *pwclient* from -`here`__. Once downloaded, run:: +`here`__. You will also need a ``pwclientrc`` file, which can be found on the +`Open vSwitch project page`__. Once both files are downloaded, run:: $ pwclient help -to get more information about the functionality pwclient provides. +to get more information about the functionality *pwclient* provides. __ https://patchwork.ozlabs.org/pwclient/ +__ https://patchwork.ozlabs.org/project/openvswitch/ -- 2.13.5 _______________________________________________ dev mailing list [email protected] https://mail.openvswitch.org/mailman/listinfo/ovs-dev
