From patchwork Tue Dec 13 17:40:41 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stephen Finucane X-Patchwork-Id: 705474 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org 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 3tdRqv22sWz9t2T for ; Wed, 14 Dec 2016 04:42:51 +1100 (AEDT) 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="lPu5W83P"; dkim-atps=neutral Received: from mail.linux-foundation.org (localhost [127.0.0.1]) by mail.linuxfoundation.org (Postfix) with ESMTP id 14CE7BE1; Tue, 13 Dec 2016 17:41:02 +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 73BE7BC7 for ; Tue, 13 Dec 2016 17:40:58 +0000 (UTC) X-Greylist: from auto-whitelisted by SQLgrey-1.7.6 Received: from brown.birch.relay.mailchannels.net (brown.birch.relay.mailchannels.net [23.83.209.23]) by smtp1.linuxfoundation.org (Postfix) with ESMTPS id AAE1D1C5 for ; Tue, 13 Dec 2016 17:40:57 +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 6B089A11E5 for ; Tue, 13 Dec 2016 17:40:51 +0000 (UTC) Received: from one.mxroute.com (ip-10-220-3-24.us-west-2.compute.internal [10.220.3.24]) by relay.mailchannels.net (Postfix) with ESMTPA id E183FA0115 for ; Tue, 13 Dec 2016 17:40:50 +0000 (UTC) X-Sender-Id: mxroute|x-authuser|stephen@that.guru Received: from one.mxroute.com ([UNAVAILABLE]. [10.25.23.62]) (using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384) by 0.0.0.0:2500 (trex/5.7.8); Tue, 13 Dec 2016 17:40:51 +0000 X-MC-Relay: Neutral X-MailChannels-SenderId: mxroute|x-authuser|stephen@that.guru X-MailChannels-Auth-Id: mxroute X-MC-Loop-Signature: 1481650851095:1265471977 X-MC-Ingress-Time: 1481650851095 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=that.guru; s=default; h=References:In-Reply-To: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:List-Id:List-Help:List-Unsubscribe: List-Subscribe:List-Post:List-Owner:List-Archive; bh=Fr5R59npvYDM7QBbSUJS+Yspq+XOiCY0cEhJllYMuyI=; b=lPu5W83P9VJEHgBVNokOyzlT6d +ryRoNKe+aB05UtJSSaToywmOZDcgs+XjuZQp8sMbH6FVLowFPkA1hpVwmOGdjYhVTU9+2GgLeSPh ybKkqndhDaY0XYNcuaNq11PlFBFBUn0wPME8Y1jseFl8NbvGFFPCJY/TXtRVLbWOHo3vRFaJu+vwf xQnoiqcEUMNUVipBpiHBIyWU5o9G93R0ADmI0QPZkSnyAtXzVNRm1B4uZwoClq56gOqdFxDBBOe7z 0dM2LkOwprCNFJDQf/S/3OE1EzjGIo6Py9OcfgcY/+03Ulvagg3Rxr6Lc1sjOywdbnwmqExsF8yP5 Xi7ddAdQ==; From: Stephen Finucane To: dev@openvswitch.org Date: Tue, 13 Dec 2016 17:40:41 +0000 Message-Id: <20161213174042.6098-5-stephen@that.guru> X-Mailer: git-send-email 2.9.3 In-Reply-To: <20161213174042.6098-1-stephen@that.guru> References: <20161213174042.6098-1-stephen@that.guru> X-AuthUser: stephen@that.guru X-Spam-Status: No, score=-1.8 required=5.0 tests=BAYES_00,DKIM_SIGNED, RCVD_IN_DNSWL_NONE,T_DKIM_INVALID autolearn=no version=3.3.1 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on smtp1.linux-foundation.org Subject: [ovs-dev] [PATCH 4/5] doc: Document Patchwork instance 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 I know more than a little bit about this :) Signed-off-by: Stephen Finucane --- Documentation/automake.mk | 1 + Documentation/index.rst | 1 + Documentation/internals/index.rst | 1 + Documentation/internals/patchwork.rst | 61 +++++++++++++++++++++++++++++++++++ 4 files changed, 64 insertions(+) create mode 100644 Documentation/internals/patchwork.rst diff --git a/Documentation/automake.mk b/Documentation/automake.mk index ffb8ae3..8bf1e07 100644 --- a/Documentation/automake.mk +++ b/Documentation/automake.mk @@ -64,6 +64,7 @@ EXTRA_DIST += \ Documentation/internals/committer-responsibilities.rst \ Documentation/internals/mailing-lists.rst \ Documentation/internals/maintainers.rst \ + Documentation/internals/patchwork.rst \ Documentation/internals/release-process.rst \ Documentation/internals/security.rst \ Documentation/internals/contributing/index.rst \ diff --git a/Documentation/index.rst b/Documentation/index.rst index ca367f1..d682651 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -82,6 +82,7 @@ Learn more about the Open vSwitch project and about how you can contribute: - **Community:** :doc:`internals/release-process` | :doc:`internals/authors` | :doc:`internals/mailing-lists` | + :doc:`internals/patchwork` | :doc:`internals/bugs` | :doc:`internals/security` diff --git a/Documentation/internals/index.rst b/Documentation/internals/index.rst index 9588861..b0ae9b4 100644 --- a/Documentation/internals/index.rst +++ b/Documentation/internals/index.rst @@ -35,6 +35,7 @@ itself and how they might involved. contributing/index mailing-lists + patchwork release-process bugs security diff --git a/Documentation/internals/patchwork.rst b/Documentation/internals/patchwork.rst new file mode 100644 index 0000000..3ae0d95 --- /dev/null +++ b/Documentation/internals/patchwork.rst @@ -0,0 +1,61 @@ +.. + Copyright (C) 2016, Stephen Finucane + + Licensed under the Apache License, Version 2.0 (the "License"); you may + not use this file except in compliance with the License. You may obtain + a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + License for the specific language governing permissions and limitations + under the License. + + Convention for heading levels in Open vSwitch documentation: + + ======= Heading 0 (reserved for the title in a document) + ------- Heading 1 + ~~~~~~~ Heading 2 + +++++++ Heading 3 + ''''''' Heading 4 + + Avoid deeper levels because they do not render well. + +========= +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`__ + +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`) +- 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: + +pwclient +-------- + +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:: + + $ pwclient help + +to get more information about the functionality pwclient provides. + +__ https://patchwork.ozlabs.org/pwclient/