..
      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/
