]> git.ipfire.org Git - thirdparty/patchwork.git/commitdiff
docs: X-Patchwork-Ignore doesn't work, X-Patchwork-Hint: ignore does
authorDaniel Axtens <dja@axtens.net>
Thu, 22 Feb 2018 13:36:06 +0000 (00:36 +1100)
committerDaniel Axtens <dja@axtens.net>
Fri, 23 Feb 2018 14:05:30 +0000 (01:05 +1100)
Make this match what is tested for in parser.py

Signed-off-by: Daniel Axtens <dja@axtens.net>
docs/usage/headers.rst

index 8741d9c18a448fd75451c5907d620aade15b520a..26e97c0ade7eaf465ee94d66b8d8c583e097c4b0 100644 (file)
@@ -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`