diff options
| author | Philippe Blain <levraiphilippeblain@gmail.com> | 2024-02-25 17:12:20 -0500 |
|---|---|---|
| committer | Konstantin Ryabitsev <konstantin@linuxfoundation.org> | 2024-02-26 13:19:14 -0500 |
| commit | 75f18a72fbdfde6155b3aea6e1d434a5ca3a3499 (patch) | |
| tree | 77562d35cb267cdb7326499c9974cd02f9d7e199 | |
| parent | 8bdbe754bd599674330c420f6faa4aeca2233d28 (diff) | |
| download | b4-75f18a72fbdfde6155b3aea6e1d434a5ca3a3499.tar.gz | |
docs: document tokens for b4.prep-cover-template
List the recognized tokens used to construct the cover letter template.
Signed-off-by: Philippe Blain <levraiphilippeblain@gmail.com>
| -rw-r--r-- | docs/config.rst | 10 |
1 files changed, 9 insertions, 1 deletions
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`` |