Avoids sending people to the code to find out about this stuff. Include examples using 'git-send-email', which should cover most folks.
Signed-off-by: Stephen Finucane <step...@that.guru> --- docs/TODO | 2 +- docs/usage/headers.md | 34 ++++++++++++++++++++++++++++++++++ mkdocs.yml | 1 + 3 files changed, 36 insertions(+), 1 deletion(-) create mode 100644 docs/usage/headers.md diff --git a/docs/TODO b/docs/TODO index 17d8cd1..37c30fd 100644 --- a/docs/TODO +++ b/docs/TODO @@ -2,7 +2,7 @@ * Person link should go to -> (person,project) patch list view * https for logins * Patch flags -* Help: XML RPC interface, bundling, Hint headers +* Help: bundling * Allow manual update of commit ref * store rejected mails * In-message From: header diff --git a/docs/usage/headers.md b/docs/usage/headers.md new file mode 100644 index 0000000..dc87397 --- /dev/null +++ b/docs/usage/headers.md @@ -0,0 +1,34 @@ +# 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: + + $ 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: + + $ 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: + + $ git send-email --add-header="X-Patchwork-State: RFC" master diff --git a/mkdocs.yml b/mkdocs.yml index 0332f46..ceb57d9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -17,3 +17,4 @@ pages: - Usage Guide: - REST API: 'usage/rest.md' - XML-RPC API: 'usage/xmlrpc.md' + - Hint Headers: 'usage/headers.md' -- 2.7.4 _______________________________________________ Patchwork mailing list Patchwork@lists.ozlabs.org https://lists.ozlabs.org/listinfo/patchwork