Repository files navigation

Patchwork is a patch tracking system for community-based projects. It isintended to make the patch management process easier for both the project'scontributors and maintainers, leaving time for the more important (and moreinteresting) stuff.

Patches that have been sent to a mailing list are "caught" by the system, andappear on a web page. Any comments posted that reference the patch are appendedto the patch page too. The project's maintainer can then scan through the listof patches, marking each with a certain state, such as Accepted, Rejected orUnder Review. Old patches can be sent to the archive or deleted.

Currently, Patchwork is being used for a number of open-source projects, mostlysubsystems of the Linux kernel. Although Patchwork has been developed with thekernel workflow in mind, the aim is to be flexible enough to suit the majorityof community projects.

Patchwork provides a web UI, a REST API, and a XML-RPC API (deprecated). Youcan use the APIs tobuild you own application or you can use one the manyexisting clients.

There are many existing Patchwork instances. Unless you're a larger projectthat is already hosting many of its own resources, you may wish to request aproject on one of these instances.

• patchwork.ozlabs.org
• patchwork.kernel.org
• patches.linaro.org
• patchwork.sourceware.org
• patchwork.open-mesh.org

Patchwork requires reasonably recent versions of:

• Python 3
• Django
• Django REST Framework
• Django Filters

The precise versions supported are listed in therelease notes.

Docker is the recommended installation method for a Patchwork developmentenvironment. To install Patchwork:

1. InstallDocker anddocker-compose.

2. Clone the Patchwork repo:

   $ git clone https://github.com/getpatchwork/patchwork.git

3. (Optional) Create a.env file in the root directory of the project andstore yourUID andGID attributes there:

   $ cd patchwork && printf "UID=$(id -u)\nGID=$(id -g)\n" > .env

   This should only be necessary if you have aUID orGID other than1000.

4. Build the images. This will download a number of packages from the internet,and compile several versions of Python:

   $ docker-compose build

5. Run docker-compose up:

   $ docker-compose up

The Patchwork instance will now be deployed at http://localhost:8000/.

For more information, including helpful command line options and alternativeinstallation methods, refer to thedocumentation.

• Mailing List, Meet CI (slides) - FOSDEM 2017
• Patches carved into stone tablets (slides) - Kernel Recipes Conference2016
• A New Patchwork (slides) - FOSDEM 2016
• Patchwork: reducing your patch workload (slides) - Linux PlumbersConference 2011

For further information, refer to thedocumentation.

For bug reports, patch submissions or other questions, use themailing list.