aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKonstantin Ryabitsev <konstantin@linuxfoundation.org>2022-09-20 14:56:41 -0400
committerKonstantin Ryabitsev <konstantin@linuxfoundation.org>2022-09-20 14:56:41 -0400
commit6592719c28f975643071b6e47cf0c333befb2c19 (patch)
treebcf496309fb630a09b85e4fc31e400073dbe3b86
parent87e0e464959c026ada435ef744bcd6ca22adccb5 (diff)
downloadb4-6592719c28f975643071b6e47cf0c333befb2c19.tar.gz
docs: fix patchwork documentation
The patchwork documentation was incorrect: 1. it was claiming that 0.9 supported patchwork 2. it was claiming that some settings had defaults This should fix both problems. Signed-off-by: Konstantin Ryabitsev <konstantin@linuxfoundation.org>
-rw-r--r--b4/__init__.py4
-rw-r--r--docs/config.rst25
2 files changed, 15 insertions, 14 deletions
diff --git a/b4/__init__.py b/b4/__init__.py
index 415301f..08edf65 100644
--- a/b4/__init__.py
+++ b/b4/__init__.py
@@ -2263,7 +2263,7 @@ def get_main_config() -> dict:
# some options can be provided via the toplevel .b4-config file,
# so load them up and use as defaults
topdir = git_get_toplevel()
- wtglobs = ['send-*', '*mask', '*template*', 'trailer*']
+ wtglobs = ['send-*', '*mask', '*template*', 'trailer*', 'pw-*']
if topdir:
wtcfg = os.path.join(topdir, '.b4-config')
if os.access(wtcfg, os.R_OK):
@@ -3061,7 +3061,7 @@ def patchwork_set_state(msgids: List[str], state: str) -> bool:
pwurl = config.get('pw-url')
pwproj = config.get('pw-project')
if not (pwkey and pwurl and pwproj):
- logger.debug('Patchwork support not configured')
+ logger.debug('Patchwork support requires pw-key, pw-url and pw-project settings')
return False
pses, url = get_patchwork_session(pwkey, pwurl)
patches_url = '/'.join((url, 'patches'))
diff --git a/docs/config.rst b/docs/config.rst
index 520ed0e..c4cd4ae 100644
--- a/docs/config.rst
+++ b/docs/config.rst
@@ -266,43 +266,44 @@ Patchwork integration settings
If your project uses a patchwork server, these settings allow you to
integrate your b4 workflow with patchwork.
-``b4.pw-url`` (v0.9+)
+``b4.pw-url`` (v0.10+)
The URL of your patchwork server. Note, that this should point at the
toplevel of your patchwork installation and NOT at the project patch
listing. E.g.: ``https://patchwork.kernel.org/``.
Default: ``None``
-``b4.pw-key`` (v0.9+)
+``b4.pw-key`` (v0.10+)
You should be able to obtain an API key from your patchwork user
profile. This API key will be used to perform actions on your behalf.
Default: ``None``
-``b4.pw-project`` (v0.9+)
+``b4.pw-project`` (v0.10+)
This should contain the name of your patchwork project, as seen in the
URL subpath to it (e.g. ``linux-usb``).
Default: ``None``
-``b4.pw-review-state`` (v0.9+)
+``b4.pw-review-state`` (v0.10+)
When patchwork integration is enabled, every time you run ``b4 am`` or
- ``b4 shazam``, b4 will mark those patches as with this state (e.g.
- "under review").
+ ``b4 shazam``, b4 will mark those patches as with this state. E.g.:
+ ``under-review``).
- Default: ``under-review``
+ Default: ``None``
-``b4.pw-accept-state`` (v0.9+)
+``b4.pw-accept-state`` (v0.10+)
After you run ``b4 ty`` to thank the contributor, b4 will move the
- matching patches into this state.
+ matching patches into this state. E.g.: ``accepted``.
- Default: ``accepted``
+ Default: ``None``
-``b4.pw-discard-state`` (v0.9+)
+``b4.pw-discard-state`` (v0.10+)
If you run ``b4 ty -d`` to delete the tracking information for a patch
series, it will also be set on the patchwork server with this state.
+ E.g.: ``deferred`` (or ``rejected``).
- Default: ``deferred``
+ Default: ``None``
.. _contributor_settings: