doc: Document Patchwork instance

I know more than a little bit about this :) Signed-off-by: Stephen Finucane <[email protected]> Signed-off-by: Ben Pfaff <[email protected]>
jotak · Dec 21, 2016 · 3c2604f · 3c2604f
1 parent 569e388
commit 3c2604f
Show file tree

Hide file tree

Showing 4 changed files with 64 additions and 0 deletions.
diff --git a/Documentation/automake.mk b/Documentation/automake.mk
@@ -73,6 +73,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
@@ -84,6 +84,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
@@ -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
@@ -0,0 +1,61 @@
+..
+      Copyright (C) 2016, Stephen Finucane <[email protected]>
+
+      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 <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`__
+
+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/