From 06378101d9cfc0d4aec78980ae4c7eaf66a187ab Mon Sep 17 00:00:00 2001
From: Stephen Finucane <stephen@that.guru>
Date: Wed, 22 Mar 2017 23:17:16 +0000
Subject: docs: Covert usage guide

Signed-off-by: Stephen Finucane <stephen@that.guru>
---
 docs/usage/headers.rst | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 docs/usage/headers.rst

(limited to 'docs/usage/headers.rst')

diff --git a/docs/usage/headers.rst b/docs/usage/headers.rst
new file mode 100644
index 0000000..8741d9c
--- /dev/null
+++ b/docs/usage/headers.rst
@@ -0,0 +1,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-Ignore`
+
+  Valid values: *
+
+  When set, the mere presence of this header will ensure the provided email is
+  not parsed by Patchwork. For example:
+
+  .. code-block:: shell
+
+     $ git send-email --add-header="X-Patchwork-Ignore: test" 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
-- 
cgit v1.2.3