diff options
| author | Stephen Finucane <stephen@that.guru> | 2016-10-11 18:58:38 +0100 |
|---|---|---|
| committer | Stephen Finucane <stephen@that.guru> | 2016-10-11 19:00:14 +0100 |
| commit | 8f11c647a601adf647dbb5cf7084e46e6de9b2eb (patch) | |
| tree | 36b6daa187a178a3db136203469acbe19d910a5b | |
| parent | a0107af12373644b95a42201d7ad30c53709e006 (diff) | |
| download | patchwork-8f11c647a601adf647dbb5cf7084e46e6de9b2eb.tar patchwork-8f11c647a601adf647dbb5cf7084e46e6de9b2eb.tar.gz | |
docs: Add delegation guide
We do autodelegation - let's tell people all about it.
Signed-off-by: Stephen Finucane <stephen@that.guru>
| -rw-r--r-- | docs/usage/delegation.md | 35 | ||||
| -rw-r--r-- | mkdocs.yml | 1 |
2 files changed, 36 insertions, 0 deletions
diff --git a/docs/usage/delegation.md b/docs/usage/delegation.md new file mode 100644 index 0000000..9553fd8 --- /dev/null +++ b/docs/usage/delegation.md @@ -0,0 +1,35 @@ +# Delegates + +Patchwork has the concept of patch delegation. Delegates are akin to reviewers, +in that they are Patchwork users who are responsible for both reviewing a patch +and setting its eventual state in Patchwork. Delegation works particularly well +for larger projects where various subsystems, each with their own +maintainer(s), can be identified. + +## Autodelegation + +Autodelegation allows patches to be automatically delegated to a user based on +the files modified by the patch. To do this, a number of rules can be +configured in the project admininstration page. This can usually be found at +`/admin/patchwork/project/<project_id>/change`. + +**NOTE:** Autodelegation can only be configured by Patchwork administrators, +i.e. those that can access the 'admin' panel. If you require configuration of +autodelegation rules on a local instance, contact your Patchwork administrator. + +In this section there are the following fields: + +<dl> + <dt>Path</dt> + <dd>A path in <a href="https://docs.python.org/2/library/fnmatch.html"> + fnmatch</a> format. The fnmatch library allows for limited, Unix shell-style + wildcarding</dd> + <dt>User</dt> + <dd>The patchwork user that should be autodelegated to the patch</dd> + <dt>Priority</dt> + <dd>The priority of the rule relative to other patches. Higher values + indicate higher priority</dd> +</dl> + +Rules should be configured by setting the above fields and saving the rules. +These rules will be applied at patch parse time. @@ -18,3 +18,4 @@ pages: - REST API: 'usage/rest.md' - XML-RPC API: 'usage/xmlrpc.md' - Hint Headers: 'usage/headers.md' + - Delegation: 'usage/delegation.md' |