aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Axtens <dja@axtens.net>2018-02-23 00:36:06 +1100
committerDaniel Axtens <dja@axtens.net>2018-02-24 01:05:30 +1100
commitebab733abad4648e8d1c3c95c095bca8bc86b644 (patch)
tree523e11424c070f49d40ca1ff5c704a92ee2d6cd0
parent3cfe618e5e8f9f079713324442c7c0777d2a7bcd (diff)
downloadpatchwork-ebab733abad4648e8d1c3c95c095bca8bc86b644.tar
patchwork-ebab733abad4648e8d1c3c95c095bca8bc86b644.tar.gz
docs: X-Patchwork-Ignore doesn't work, X-Patchwork-Hint: ignore does
Make this match what is tested for in parser.py Signed-off-by: Daniel Axtens <dja@axtens.net>
-rw-r--r--docs/usage/headers.rst10
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/usage/headers.rst b/docs/usage/headers.rst
index 8741d9c..26e97c0 100644
--- a/docs/usage/headers.rst
+++ b/docs/usage/headers.rst
@@ -5,16 +5,16 @@ 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`
+`X-Patchwork-Hint`
- Valid values: *
+ Valid values: ignore
- When set, the mere presence of this header will ensure the provided email is
- not parsed by Patchwork. For example:
+ 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-Ignore: test" master
+ $ git send-email --add-header="X-Patchwork-Hint: ignore" master
`X-Patchwork-Delegate`