aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKonstantin Ryabitsev <konstantin@linuxfoundation.org>2022-09-15 15:38:23 -0400
committerKonstantin Ryabitsev <konstantin@linuxfoundation.org>2022-09-15 15:38:23 -0400
commit5d3d1b88466c7ed1f581f4c5384692a27e7524ba (patch)
tree8ff5dbc8dcfbdccfd1ef09b8e504d5c6bcd2becf
parentd59fa46c4fd695b3853b396266d15124cf904f21 (diff)
downloadb4-5d3d1b88466c7ed1f581f4c5384692a27e7524ba.tar.gz
docs: add some cross-references
Complete the configuration file section and add some cross-references where needed. Signed-off-by: Konstantin Ryabitsev <konstantin@linuxfoundation.org>
-rw-r--r--docs/config.rst48
-rw-r--r--docs/contributor/prep.rst5
-rw-r--r--docs/contributor/send.rst15
3 files changed, 46 insertions, 22 deletions
diff --git a/docs/config.rst b/docs/config.rst
index 7e299a1..9094646 100644
--- a/docs/config.rst
+++ b/docs/config.rst
@@ -224,6 +224,16 @@ These settings control the behaviour of ``b4 ty`` command.
Default: ``None``
+``b4.email-exclude``
+ A comma-separated list of shell-style globbing patterns with addresses
+ that should always be excluded from the recipient list.
+
+``b4.sendemail-identity``
+ Sendemail identity to use when sending mail directly from b4 (applies
+ to ``b4 send`` and ``b4 ty``). See ``man git-send-email`` for info
+ about sendemail identities.
+
+
.. _patchwork_settings:
Patchwork integration settings
@@ -270,43 +280,45 @@ integrate your b4 workflow with patchwork.
Default: ``deferred``
-TO DOCUMENT
-~~~~~~~~~~~
+.. _contributor_settings:
+
+Contributor-oriented settings
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
``b4.send-endpoint-web``
- TODO
+ The web submission endpoint to use (see :ref:`web_endpoint`).
``b4.send-series-to``
- TODO
+ Address or comma-separated addresses to always add to the To: header
+ (see :ref:`prep_recipients`).
``b4.send-series-cc``
- TODO
+ Address or comma-separated addresses to always add to the To: header
+ (see :ref:`prep_recipients`).
``b4.send-no-patatt-sign``
- TODO
+ Do not sign patches with patatt before sending them (ignored when
+ using the web submission endpoint).
``b4.send-hide-cover-to-cc``
- TODO
+ Always hide To: and Cc: trailers from the cover letter, just include
+ them into the corresponding message recipient headers.
``b4.send-auto-to-cmd``
- TODO
+ Alternative command to use to generate the list of To: recipients.
``b4.send-auto-cc-cmd``
- TODO
-
-``b4.sendemail-identity``
- TODO
+ Alternative command to use to generate the list of Cc: recipients.
``b4.prep-cover-strategy``
- TODO
+ Alternative cover letter storage strategy to use (see
+ :ref:`prep_cover_strategies`).
``b4.prep-cover-template``
- TODO
-
-``b4.email-exclude``
- TODO
+ Path to the template to use for the cover letter.
``b4.gh-api-key``
- TODO
+ Deliberately undocumented because the feature is incomplete and poorly
+ tested.
.. _`patatt`: https://pypi.org/project/patatt/
diff --git a/docs/contributor/prep.rst b/docs/contributor/prep.rst
index 99cc22f..3eefe00 100644
--- a/docs/contributor/prep.rst
+++ b/docs/contributor/prep.rst
@@ -42,6 +42,8 @@ This will fire up a text editor using your defined ``$EDITOR`` or
``core.editor`` and automatically update the cover letter commit when
you are done.
+.. _prep_cover_strategies:
+
Cover letter strategies
~~~~~~~~~~~~~~~~~~~~~~~
By default, b4 will keep the cover letter in an empty commit at the
@@ -169,6 +171,7 @@ should be preserved through all rebase operations.
you do want to edit it directly using ``git rebase -i``, remember to
use ``git commit --allow-empty`` to commit it back into the tree.
+.. _prep_recipients:
Prepare the list of recipients
------------------------------
@@ -196,6 +199,8 @@ repository's ``.git/config`` file as follows::
[b4]
send-series-to = some@list.name
+.. _prep_flags:
+
Prep command flags
------------------
``-c, --auto-to-cc``
diff --git a/docs/contributor/send.rst b/docs/contributor/send.rst
index ce18172..00d5ec6 100644
--- a/docs/contributor/send.rst
+++ b/docs/contributor/send.rst
@@ -35,6 +35,8 @@ other upsides:
you will need it to take part in discussions and for sending and
receiving code review feedback.
+.. _web_endpoint:
+
Authenticating with the web submission endpoint
-----------------------------------------------
Before you start, you will need to configure your attestation mechanism.
@@ -195,7 +197,9 @@ Command line flags
``--no-trailer-to-cc``
Do not add any addresses found in the cover or patch trailers to To:
or Cc:. This is usually handy for testing purposes, in case you want
- to send a set of patches to yourself.
+ to send a set of patches to yourself. Can be set in the configuration
+ file using the ``b4.send-hide-cover-to-cc`` option (see
+ :ref:`contributor_settings`).
``--hide-cover-to-cc``
It is common for the ``To:`` and ``Cc:`` sections in cover letters to
@@ -205,11 +209,13 @@ Command line flags
``--to``
Add any more email addresses to include into the To: header here
- (comma-separated)
+ (comma-separated). Can be set in the configuration file using the
+ ``b4.send-series-to`` option (see :ref:`contributor_settings`).
``--cc``
Add any more email addresses to include into the Cc: header here
- (comma-separated)
+ (comma-separated). Can be set in the configuration file using the
+ ``b4.send-series-cc`` option (see :ref:`contributor_settings`).
``--not-me-too``
Removes your own email address from the recipients.
@@ -218,7 +224,8 @@ Command line flags
Don't sign your patches with your configured attestation mechanism.
Note, that patch signing is required for the web submission endpoint,
so this is only a valid option to use with ``-o`` or when using your
- own SMTP server.
+ own SMTP server. This can be set in the configuration using the
+ ``b4.send-no-patatt-sign`` (see :ref:`contributor_settings`).
``--resend V``
Resend a previously sent version (see above for more info).