summaryrefslogtreecommitdiff
path: root/Documentation/internals
diff options
context:
space:
mode:
authorStephen Finucane <stephen@that.guru>2016-12-14 10:07:59 +0000
committerBen Pfaff <blp@ovn.org>2016-12-21 13:54:40 -0800
commit3c2604f727892c241be4853ad9c02df46da7e782 (patch)
treebafe9e3978ef02ad57c4250f96fb0e99ddb6b3b1 /Documentation/internals
parent569e3885c539882fe8bd5f907a7c6184d0b1e88d (diff)
downloadopenvswitch-3c2604f727892c241be4853ad9c02df46da7e782.tar.gz
doc: Document Patchwork instance
I know more than a little bit about this :) Signed-off-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Ben Pfaff <blp@ovn.org>
Diffstat (limited to 'Documentation/internals')
-rw-r--r--Documentation/internals/index.rst1
-rw-r--r--Documentation/internals/patchwork.rst61
2 files changed, 62 insertions, 0 deletions
diff --git a/Documentation/internals/index.rst b/Documentation/internals/index.rst
index 9588861d2..b0ae9b4e7 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 000000000..3ae0d9503
--- /dev/null
+++ b/Documentation/internals/patchwork.rst
@@ -0,0 +1,61 @@
+..
+ Copyright (C) 2016, Stephen Finucane <stephen@that.guru>
+
+ 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/