diff mbox series

[b4,1/2] docs: document tokens for b4.prep-cover-template

Message ID 20240225-ez-range-diff-cover-letter-v1-1-0df35b63bcf2@gmail.com (mailing list archive)
State Accepted
Headers show
Series ez: allow inserting a range-diff in the cover letter | expand

Commit Message

Philippe Blain Feb. 25, 2024, 10:12 p.m. UTC 
List the recognized tokens used to construct the cover letter template.

Signed-off-by: Philippe Blain <levraiphilippeblain@gmail.com>
---
 docs/config.rst | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)
diff mbox series

Patch

diff --git a/docs/config.rst b/docs/config.rst
index c46d43a..8523107 100644
--- a/docs/config.rst
+++ b/docs/config.rst
@@ -400,7 +400,15 @@  Contributor-oriented settings
   Default: ``commit``
 
 ``b4.prep-cover-template`` (v0.10+)
-  Path to the template to use for the cover letter.
+  Path to the template to use for the cover letter. The following tokens
+  are recognized:
+
+  * ``${cover}``: the content of the cover letter itself
+  * ``${shortlog}``: the ``git shortlog`` output for the series
+  * ``${diffstat}``: the ``git diff --stat`` output for the series
+  * ``${base_commit}``: the base commit of the series
+  * ``${change_id}``: the change-id of the series
+  * ``${signature}``: your signature, either from ``~/.signature`` if found, or from your Git config
 
   Default: ``None``