{"id":809677,"url":"http://patchwork.ozlabs.org/api/patches/809677/?format=json","web_url":"http://patchwork.ozlabs.org/project/openvswitch/patch/20170904130944.25298-1-stephen@that.guru/","project":{"id":47,"url":"http://patchwork.ozlabs.org/api/projects/47/?format=json","name":"Open vSwitch","link_name":"openvswitch","list_id":"ovs-dev.openvswitch.org","list_email":"ovs-dev@openvswitch.org","web_url":"http://openvswitch.org/","scm_url":"git@github.com:openvswitch/ovs.git","webscm_url":"https://github.com/openvswitch/ovs","list_archive_url":"","list_archive_url_format":"","commit_url_format":""},"msgid":"<20170904130944.25298-1-stephen@that.guru>","list_archive_url":null,"date":"2017-09-04T13:09:44","name":"[ovs-dev,v2] docs: Add references to git-pw","commit_ref":null,"pull_url":null,"state":"accepted","archived":false,"hash":"3ab376cff3775280a9fc9adaf8d6b690e92f0c7b","submitter":{"id":69991,"url":"http://patchwork.ozlabs.org/api/people/69991/?format=json","name":"Stephen Finucane","email":"stephen@that.guru"},"delegate":null,"mbox":"http://patchwork.ozlabs.org/project/openvswitch/patch/20170904130944.25298-1-stephen@that.guru/mbox/","series":[{"id":1379,"url":"http://patchwork.ozlabs.org/api/series/1379/?format=json","web_url":"http://patchwork.ozlabs.org/project/openvswitch/list/?series=1379","date":"2017-09-04T13:09:44","name":"[ovs-dev,v2] docs: Add references to git-pw","version":2,"mbox":"http://patchwork.ozlabs.org/series/1379/mbox/"}],"comments":"http://patchwork.ozlabs.org/api/patches/809677/comments/","check":"pending","checks":"http://patchwork.ozlabs.org/api/patches/809677/checks/","tags":{},"related":[],"headers":{"Return-Path":"","X-Original-To":["incoming@patchwork.ozlabs.org","dev@openvswitch.org"],"Delivered-To":["patchwork-incoming@bilbo.ozlabs.org","ovs-dev@mail.linuxfoundation.org"],"Authentication-Results":["ozlabs.org;\n\tspf=pass (mailfrom) smtp.mailfrom=openvswitch.org\n\t(client-ip=140.211.169.12; helo=mail.linuxfoundation.org;\n\tenvelope-from=ovs-dev-bounces@openvswitch.org;\n\treceiver=)","ozlabs.org;\n\tdkim=fail reason=\"key not found in DNS\" (0-bit key;\n\tunprotected) header.d=that.guru header.i=@that.guru\n\theader.b=\"XgHANZlX\"; dkim-atps=neutral"],"Received":["from mail.linuxfoundation.org (mail.linuxfoundation.org\n\t[140.211.169.12])\n\t(using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256\n\tbits)) (No client certificate requested)\n\tby ozlabs.org (Postfix) with ESMTPS id 3xm9Dn4jYgz9sR9\n\tfor ;\n\tMon, 4 Sep 2017 23:10:01 +1000 (AEST)","from mail.linux-foundation.org (localhost [127.0.0.1])\n\tby mail.linuxfoundation.org (Postfix) with ESMTP id 326CCA91;\n\tMon, 4 Sep 2017 13:09:58 +0000 (UTC)","from smtp1.linuxfoundation.org (smtp1.linux-foundation.org\n\t[172.17.192.35])\n\tby mail.linuxfoundation.org (Postfix) with ESMTPS id 8387587A\n\tfor ; Mon, 4 Sep 2017 13:09:57 +0000 (UTC)","from nov-007-i623.relay.mailchannels.net\n\t(nov-007-i623.relay.mailchannels.net [46.232.183.177])\n\tby smtp1.linuxfoundation.org (Postfix) with ESMTPS id 9E45A12A\n\tfor ; Mon, 4 Sep 2017 13:09:54 +0000 (UTC)","from relay.mailchannels.net (localhost [127.0.0.1])\n\tby relay.mailchannels.net (Postfix) with ESMTP id 5D6CB7CA0AD\n\tfor ; Mon, 4 Sep 2017 13:09:51 +0000 (UTC)","from one.mxroute.com (unknown [100.96.128.157])\n\t(Authenticated sender: mxroute)\n\tby relay.mailchannels.net (Postfix) with ESMTPA id D249A7C9993\n\tfor ; Mon, 4 Sep 2017 13:09:50 +0000 (UTC)","from one.mxroute.com (one-outgoing.mxroute.com [172.20.63.242])\n\t(using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384)\n\tby 0.0.0.0:2500 (trex/5.9.14); Mon, 04 Sep 2017 13:09:51 +0000"],"X-Greylist":"from auto-whitelisted by SQLgrey-1.7.6","X-Sender-Id":["mxroute|x-authuser|stephen@that.guru","mxroute|x-authuser|stephen@that.guru"],"X-MC-Relay":"Neutral","X-MailChannels-SenderId":"mxroute|x-authuser|stephen@that.guru","X-MailChannels-Auth-Id":"mxroute","X-Daffy-Absorbed":"4fb7efb716e5a8a9_1504530591129_79436570","X-MC-Loop-Signature":"1504530591128:302263175","X-MC-Ingress-Time":"1504530591128","DKIM-Signature":"v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=that.guru;\n\ts=default;\n\th=Message-Id:Date:Subject:Cc:To:From:Sender:Reply-To:MIME-Version\n\t:Content-Type:Content-Transfer-Encoding:Content-ID:Content-Description:\n\tResent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:\n\tIn-Reply-To:References:List-Id:List-Help:List-Unsubscribe:List-Subscribe:\n\tList-Post:List-Owner:List-Archive;\n\tbh=4U+3v5znZlzxgXBXBIeCX6dEXZYkIMwIuwdqnmSycWU=;\n\tb=XgHANZlXcFv1F71cuVbNBoJLRZ\n\tPPF+r+cZc3dqc/Z5frVzj0Gtu8tlCnHStsqbyQcgSFVBa4fkmjjEtYcjb5BjG4pI8/Fb/zdh4H+4J\n\tft3OvfchIe6u9S64GHaxcA4OTT+mvkGEmAFz0m/zdgiJfAk5Jgc2axbu+hacJgyzJJWwzBLuqMji+\n\toTO+ihCCMVErmT3OjpfXHm5bji3M5rWUBYF0lh6JEeN7KUo364b+C+tFmMVR623gDUi8n7SU9IQbN\n\t0YUVtE6BK5GFKZUlD3SEKgE4JkV5bUYN5d0fVXKvswVEtIOXcxpNHHL873y2B1nISQN6YI7BI8PpY\n\tCs+OuEoQ==;","From":"Stephen Finucane ","To":"dev@openvswitch.org","Date":"Mon, 4 Sep 2017 14:09:44 +0100","Message-Id":"<20170904130944.25298-1-stephen@that.guru>","X-Mailer":"git-send-email 2.13.5","X-AuthUser":"stephen@that.guru","X-Spam-Status":"No, score=0.1 required=5.0 tests=DKIM_SIGNED,\n\tRCVD_IN_DNSWL_NONE, \n\tT_DKIM_INVALID autolearn=disabled version=3.3.1","X-Spam-Checker-Version":"SpamAssassin 3.3.1 (2010-03-16) on\n\tsmtp1.linux-foundation.org","Subject":"[ovs-dev] [PATCH v2] docs: Add references to git-pw","X-BeenThere":"ovs-dev@openvswitch.org","X-Mailman-Version":"2.1.12","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","MIME-Version":"1.0","Content-Type":"text/plain; charset=\"us-ascii\"","Content-Transfer-Encoding":"7bit","Sender":"ovs-dev-bounces@openvswitch.org","Errors-To":"ovs-dev-bounces@openvswitch.org"},"content":"Now that Patchwork 2.0 is out, folks can start to take advantage of some\nof the new features that it offers. Chief among these is series support,\nwhich is only exposed via the web UI and new REST API and which, in\nturn, necessitates using git-pw rather than pwclient. As such, this tool\nis slightly documented.\n\nSigned-off-by: Stephen Finucane \n---\nv2:\n- Add information on configuring git-pw for the OVS project\n- Remove most documentation for pwclient, leaving only a footnote about\n its deprecated nature\n---\n Documentation/internals/patchwork.rst | 51 +++++++++++++++++++++++++----------\n 1 file changed, 37 insertions(+), 14 deletions(-)","diff":"diff --git a/Documentation/internals/patchwork.rst b/Documentation/internals/patchwork.rst\nindex 3ae0d9503..bc5c89c96 100644\n--- a/Documentation/internals/patchwork.rst\n+++ b/Documentation/internals/patchwork.rst\n@@ -29,33 +29,56 @@ Patchwork\n \n Open vSwitch uses `Patchwork`__ to track the status of patches sent to the\n :doc:`ovs-dev mailing list `. The Open vSwitch Patchwork\n-instance can be found on `ozlabs.org`__. The ``pwclientrc`` file, required for\n-*pwclient*, can be found on the `project page`__\n+instance can be found on `ozlabs.org`__.\n \n Patchwork provides a number of useful features for developers working on Open\n vSwitch:\n \n - Tracking the lifecycle of patches (accepted, rejected, under-review, ...)\n - Assigning reviewers (delegates) to patches\n-- Downloading/applying patches via the web UI or the XML-RPC API (see\n- :ref:`pwclient`)\n+- Downloading/applying patches, series, and bundles via the web UI or the REST\n+ API (see :ref:`git-pw`)\n - A usable UI for viewing patch discussions\n \n __ https://github.com/getpatchwork/patchwork\n __ https://patchwork.ozlabs.org/project/openvswitch/list/\n-__ https://patchwork.ozlabs.org/project/openvswitch/\n \n-.. _pwclient:\n+.. _git-pw:\n \n-pwclient\n---------\n+git-pw\n+------\n+\n+The *git-pw* tool provides a way to download and apply patches, series, and\n+bundles. You can install *git-pw* from `PyPi`__ like so::\n+\n+ $ pip install --user git-pw\n+\n+To actually use *git-pw*, you must configure it with the Patchwork instance\n+URL, Patchwork project, and your Patchwork user authentication token. The URL\n+and project are provided below, but you must obtain your authentication token\n+from your `Patchwork User Profile`__ page. If you do not already have a\n+Patchwork user account, you should create one now.\n+\n+Once your token is obtained, configure *git-pw* as below. Note that this must\n+be run from within the Open vSwitch Git repository::\n \n-The *pwclient* tool provides an way to download and apply patches, change the\n-state of patches in Patchwork, and more. You can download *pwclient* from\n-`here`__. Once downloaded, run::\n+ $ git config pw.server https://patchwork.ozlabs.org/\n+ $ git config pw.project openvswitch\n+ $ git config pw.token $PW_TOKEN # using the token obtained earlier\n \n- $ pwclient help\n+Once configured, run the following to get information about available\n+commands::\n \n-to get more information about the functionality pwclient provides.\n+ $ git pw --help\n+\n+__ https://pypi.python.org/pypi/git-pw\n+__ https://patchwork.ozlabs.org/user/\n+\n+.. _pwclient:\n+\n+pwclient\n+--------\n \n-__ https://patchwork.ozlabs.org/pwclient/\n+The *pwclient* is a legacy tool that provides some of the functionality of\n+*git-pw* but uses the legacy XML-RPC API. It is considered deprecated in its\n+current form and *git-pw* should be used instead.\n","prefixes":["ovs-dev","v2"]}