User Tools

Site Tools


userdoc:patchwork

This is an old revision of the document!


How to request a new project on patchwork

Patchwork is a tool to help track patches sent to a mailing list, to make sure they are not lost in the traffic or otherwise overlooked.

To get a new project added to patchwork, please send an email request to support with the following info:

  1. The website with the details about the mailing list (e.g. mailman listinfo page)
  2. The patchwork.kernel.org username of the person (or persons) who will be the project admin in patchwork. If you don't have a username yet, please create one on patchwork.kernel.org.
  3. Patchwork-bot integration details, if desired (see below)

Adding patchwork-bot integration

If you have your git tree on git.kernel.org, you can send a request to support to request patchwork-bot integration. Please provide all of the following info as part of your request:

  1. Refname:state map: (e.g. refs/heads/next:Accepted, refs/heads/master:Mainlined)
  2. Summary to: (e.g. example@kernel.org, example@gmail.com)
  3. Notify submitters?: (yes/no)
  4. Auto-supersede series? (yes, within NN days/no)
  5. Auto-archive old patches? (yes, when older than NN days/no)

Auto-superseding series and archiving old patches

The bot can do some basic housekeeping chores, such as automatically marking patches belonging to older versions of the series as "superseded." E.g. if a contributor sends "[PATCH NN/30] Do foo to bar", and then after that a new revision "[PATCH NN/30 v2] Do foo to bar", the bot can automatically mark the 30 patches belonging to the "v1" of the series as "superseded". In order to work, the following conditions must be met:

- It must be submitted by the same person - It must have the exact same series name (first patch or cover letter subject wording) - It must be within the cutoff period of days specified. In other word, if the cutoff is 90 days and the new series comes in 4 months later, there will be no match

Similarly, the bot can archive patches older than a certain period of time.

Notifying submitters

If you choose to notify submitters, it would send them a summary email per all patches marked as "Accepted" within one session, for example:

Subject: Your patches were applied to shuah/linux-kselftest.git
From: patchwork-bot@kernel.org
To: Submitter Name <submitter@kernel.org>

Hello:

The following patches you sent were recently pushed to
shuah/linux-kselftest.git (refs/heads/next):

media: rc: self test for IR encoders and decoders
    Status   : Accepted
    Patchwork: https://patchwork.kernel.org/patch/10643585
    Webview  : https://git.kernel.org/shuah/linux-kselftest/c/e55c884ea5c66a29a713d41ed0819fee8038762b

media: [something else]
    Status   : Accepted
    Patchwork: https://patchwork.kernel.org/patch/x
    Webview  : https://git.kernel.org/shuah/linux-kselftest/c/x

media: [and another one]
    Status   : Accepted
    Patchwork: https://patchwork.kernel.org/patch/x
    Webview  : https://git.kernel.org/shuah/linux-kselftest/c/x

Total patches: 3

You are awesome, thank you!

--
Deet-doot-dot, I am a bot.
https://korg.wiki.kernel.org/userdoc/pwbot

This way, if you are applying a series of 50 patches from the same person, the submitter will only receive a single notification email (as long as you push them in one batch).

userdoc/patchwork.1543371955.txt.gz · Last modified: 2018-11-28 02:25 by mricon