On 29 August 2017 at 02:54, Stephen Finucane <step...@that.guru> wrote: > 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 <step...@that.guru> > --- > 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
Perhaps we could document what config the user needs to set up for this to work? Eg: $ git config pw.server https://patchwork.ozlabs.org/ I'd also like to filter to relevant patches: $ git config pw.project openvswitch However, it seems like this is broken right now. (git-pw patch list returns empty list if I have project configured) > > .. _pwclient: > > pwclient > -------- <snip> I was going to ask if we still need pwclient documentation, but I guess if git-pw is super new and working through some bugs then we should probably keep it around a while. _______________________________________________ dev mailing list d...@openvswitch.org https://mail.openvswitch.org/mailman/listinfo/ovs-dev