aboutsummaryrefslogtreecommitdiff
path: root/docs/usage/headers.rst
blob: 26e97c0ade7eaf465ee94d66b8d8c583e097c4b0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
Hint Headers
============

Patchwork provides a number of special email headers to control how a patch is
handled when it is received. The examples provided below use `git-send-email`,
but custom headers can also be set when using tools like `mutt`.

`X-Patchwork-Hint`

  Valid values: ignore

  When set, this header will ensure the provided email is not parsed
  by Patchwork. For example:

  .. code-block:: shell

     $ git send-email --add-header="X-Patchwork-Hint: ignore" master

`X-Patchwork-Delegate`

  Valid values: An email address associated with a Patchwork user

  If set and valid, the user corresponding to the provided email address will
  be assigned as the delegate of any patch parsed. If invalid, it will be
  ignored.  For example:

  .. code-block:: shell

     $ git send-email --add-header="X-Patchwork-Delegate: a@example.com" master

`X-Patchwork-State`

  Valid values: Varies between deployments. This can usually be one of
  "Accepted", "Rejected", "RFC" or "Awaiting Upstream", among others.

  If set and valid, the state provided will be assigned as the state of any
  patch parsed. If invalid, it will be ignored. For example:

  .. code-block:: shell

     $ git send-email --add-header="X-Patchwork-State: RFC" master