pwclient reads configuration from the
.pwclientrc file, located in your
home directory (
~). Patchwork itself provides sample
.pwclientrc files for projects at:
For example, here is the
.pwclientrc file for Patchwork itself.
.pwclientrc file is an INI-style config file, containing an
options section along with a section for each project.
options section provides the following configuration options:
- The default project to use. Must be configured if not specifying a project via the command line.
- Add a
Signed-Off-By:line to commit messages when applying patches using the git-am command. Defaults to
- Enable three-way merge when applying patches using the git-am
command. Defaults to
The names of the project sections must correspond to the project names in Patchwork, as reflected in the project’s URL in Patchwork. Multiple projects can be defined, but no two projects can share the same name. Project sections require the following configuration options:
The URL of the XMLRPC endpoint for the Patchwork instance that the project is available on. Typically
$PATCHWORK_URL/xmlrpc. For example:
In addition, the following options are optional:
- Your Patchwork username.
- Your Patchwork password.
Patchwork credentials are only needed for certain operations, such as updating the state of a patch. You will also require admin priviledges on the instance in question.
[base] default = patchwork [patchwork] url = http://patchwork.ozlabs.org/xmlrpc/ username = johndoe password = password
Older Patchwork instances may provide a legacy version of the
file that did not support multiple projects. pwclient will automatically
convert this version of the file to the latest version.