From patchwork Mon Sep 4 13:09:44 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stephen Finucane X-Patchwork-Id: 809677 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=pass (mailfrom) smtp.mailfrom=openvswitch.org (client-ip=140.211.169.12; helo=mail.linuxfoundation.org; envelope-from=ovs-dev-bounces@openvswitch.org; receiver=) Authentication-Results: ozlabs.org; dkim=fail reason="key not found in DNS" (0-bit key; unprotected) header.d=that.guru header.i=@that.guru header.b="XgHANZlX"; dkim-atps=neutral Received: from mail.linuxfoundation.org (mail.linuxfoundation.org [140.211.169.12]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 3xm9Dn4jYgz9sR9 for ; Mon, 4 Sep 2017 23:10:01 +1000 (AEST) Received: from mail.linux-foundation.org (localhost [127.0.0.1]) by mail.linuxfoundation.org (Postfix) with ESMTP id 326CCA91; Mon, 4 Sep 2017 13:09:58 +0000 (UTC) X-Original-To: dev@openvswitch.org Delivered-To: ovs-dev@mail.linuxfoundation.org Received: from smtp1.linuxfoundation.org (smtp1.linux-foundation.org [172.17.192.35]) by mail.linuxfoundation.org (Postfix) with ESMTPS id 8387587A for ; Mon, 4 Sep 2017 13:09:57 +0000 (UTC) X-Greylist: from auto-whitelisted by SQLgrey-1.7.6 Received: from nov-007-i623.relay.mailchannels.net (nov-007-i623.relay.mailchannels.net [46.232.183.177]) by smtp1.linuxfoundation.org (Postfix) with ESMTPS id 9E45A12A for ; Mon, 4 Sep 2017 13:09:54 +0000 (UTC) X-Sender-Id: mxroute|x-authuser|stephen@that.guru Received: from relay.mailchannels.net (localhost [127.0.0.1]) by relay.mailchannels.net (Postfix) with ESMTP id 5D6CB7CA0AD for ; Mon, 4 Sep 2017 13:09:51 +0000 (UTC) Received: from one.mxroute.com (unknown [100.96.128.157]) (Authenticated sender: mxroute) by relay.mailchannels.net (Postfix) with ESMTPA id D249A7C9993 for ; Mon, 4 Sep 2017 13:09:50 +0000 (UTC) X-Sender-Id: mxroute|x-authuser|stephen@that.guru Received: from one.mxroute.com (one-outgoing.mxroute.com [172.20.63.242]) (using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384) by 0.0.0.0:2500 (trex/5.9.14); Mon, 04 Sep 2017 13:09:51 +0000 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; s=default; h=Message-Id:Date:Subject:Cc:To:From:Sender:Reply-To:MIME-Version :Content-Type:Content-Transfer-Encoding:Content-ID:Content-Description: Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID: In-Reply-To:References:List-Id:List-Help:List-Unsubscribe:List-Subscribe: List-Post:List-Owner:List-Archive; bh=4U+3v5znZlzxgXBXBIeCX6dEXZYkIMwIuwdqnmSycWU=; b=XgHANZlXcFv1F71cuVbNBoJLRZ PPF+r+cZc3dqc/Z5frVzj0Gtu8tlCnHStsqbyQcgSFVBa4fkmjjEtYcjb5BjG4pI8/Fb/zdh4H+4J ft3OvfchIe6u9S64GHaxcA4OTT+mvkGEmAFz0m/zdgiJfAk5Jgc2axbu+hacJgyzJJWwzBLuqMji+ oTO+ihCCMVErmT3OjpfXHm5bji3M5rWUBYF0lh6JEeN7KUo364b+C+tFmMVR623gDUi8n7SU9IQbN 0YUVtE6BK5GFKZUlD3SEKgE4JkV5bUYN5d0fVXKvswVEtIOXcxpNHHL873y2B1nISQN6YI7BI8PpY Cs+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, RCVD_IN_DNSWL_NONE, T_DKIM_INVALID autolearn=disabled version=3.3.1 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on smtp1.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: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Sender: ovs-dev-bounces@openvswitch.org Errors-To: ovs-dev-bounces@openvswitch.org 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 --- v2: - Add information on configuring git-pw for the OVS project - Remove most documentation for pwclient, leaving only a footnote about its deprecated nature --- Documentation/internals/patchwork.rst | 51 +++++++++++++++++++++++++---------- 1 file changed, 37 insertions(+), 14 deletions(-) diff --git a/Documentation/internals/patchwork.rst b/Documentation/internals/patchwork.rst index 3ae0d9503..bc5c89c96 100644 --- a/Documentation/internals/patchwork.rst +++ b/Documentation/internals/patchwork.rst @@ -29,33 +29,56 @@ Patchwork Open vSwitch uses `Patchwork`__ to track the status of patches sent to the :doc:`ovs-dev mailing list `. 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 or the REST + API (see :ref:`git-pw`) - 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/ -.. _pwclient: +.. _git-pw: -pwclient --------- +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 + +To actually use *git-pw*, you must configure it with the Patchwork instance +URL, Patchwork project, and your Patchwork user authentication token. The URL +and project are provided below, but you must obtain your authentication token +from your `Patchwork User Profile`__ page. If you do not already have a +Patchwork user account, you should create one now. + +Once your token is obtained, configure *git-pw* as below. Note that this must +be run from within the Open vSwitch Git repository:: -The *pwclient* tool provides an way to download and apply patches, change the -state of patches in Patchwork, and more. You can download *pwclient* from -`here`__. Once downloaded, run:: + $ git config pw.server https://patchwork.ozlabs.org/ + $ git config pw.project openvswitch + $ git config pw.token $PW_TOKEN # using the token obtained earlier - $ pwclient help +Once configured, run the following to get information about available +commands:: -to get more information about the functionality pwclient provides. + $ git pw --help + +__ https://pypi.python.org/pypi/git-pw +__ https://patchwork.ozlabs.org/user/ + +.. _pwclient: + +pwclient +-------- -__ https://patchwork.ozlabs.org/pwclient/ +The *pwclient* is a legacy tool that provides some of the functionality of +*git-pw* but uses the legacy XML-RPC API. It is considered deprecated in its +current form and *git-pw* should be used instead.