git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH 0/9] Add interpret-trailers builtin

From
Christian Couder <chriscool@tuxfamily.org>
Date
Dec 24, 2013, 06:37 UTC
Message-ID
<20131224061541.19560.17773.chriscool@tuxfamily.org>
This patch series implements a new command:
        git interpret-trailers

and an infrastructure to process trailers that can be reused, for example in "commit.c".

1) Rationale:

This command should help with RFC 822 style headers, called "trailers", that are found at the end of commit messages.

(Note that these headers do not follow and are not intended to follow many rules that are in RFC 822. For example they do not follow the line breaking rules, the encoding rules and probably many other rules.)

For a long time, these trailers have become a de facto standard way to add helpful information into commit messages.

Until now git commit has only supported the well known "Signed-off-by: " trailer, that is used by many projects like the Linux kernel and Git.

It is better to implement features for these trailers first in a new command rather than in builtin/commit.c, because this way the prepare-commit-msg and commit-msg hooks can reuse this command.

2) Current state:
Currently the usage string of this command is:
git interpret-trailers [--trim-empty] [--infile=file] [<token[=value]>...]
The following features are implemented:
        - the result is printed on stdout
        - the [<token[=value]>...] arguments are interpreted
        - a commit message passed using the "--infile=file" option is interpreted
        - the "trailer.<token>.key" options in the config are interpreted
        - the "trailer.<token>.where" options are interpreted
        - the "trailer.<token>.ifExist" options are interpreted
        - the "trailer.<token>.ifMissing" options are interpreted
	- there are a lot of tests
The following features are planned but not yet implemented:
	- making "git interpret-trailers" a filter
        - some documentation
        - the "trailer.<token>.command" config option
3) Notes:
* I chose "trailer.<token>.key" over "trailer.<token>.value" and
"trailer.<token>.trailer", as I think it is clearer.
* I focused on a cleaner and more complete implementation than the
PATCH/RFC I sent previously.
Happy end of year!
Christian Couder (9):
  Add data structures and basic functions for commit trailers
  trailer: process trailers from file and arguments
  trailer: read and process config information
  trailer: process command line trailer arguments
  strbuf: add strbuf_isspace()
  trailer: parse trailers from input file
  trailer: put all the processing together and print
  trailer: add interpret-trailers command
  trailer: add tests for "git interpret-trailers"
 .gitignore                    |   1 +
 Makefile                      |   2 +
 builtin.h                     |   1 +
 builtin/interpret-trailers.c  |  36 +++
 git.c                         |   1 +
 strbuf.c                      |   7 +
 strbuf.h                      |   1 +
 t/t7513-interpret-trailers.sh | 206 ++++++++++++++++
 trailer.c                     | 544 ++++++++++++++++++++++++++++++++++++++++++
 trailer.h                     |   6 +
 10 files changed, 805 insertions(+)
 create mode 100644 builtin/interpret-trailers.c
 create mode 100755 t/t7513-interpret-trailers.sh
 create mode 100644 trailer.c
 create mode 100644 trailer.h
-- 
1.8.4.1.616.g07f5c81
Next: Christian Couder
Message 1 of 17 in “Add interpret-trailers builtin”
  1. 0/9 Add interpret-trailers builtinChristian Couder, Dec 24, 2013
  2. 1/9 Add data structures and basic functions for commit trailersChristian Couder, Dec 24, 2013
  3. 2/9 trailer: process trailers from file and argumentsChristian Couder, Dec 24, 2013
  4. 3/9 trailer: read and process config informationChristian Couder, Dec 24, 2013
  5. Christian CouderDec 24, 2013
  6. 4/9 trailer: process command line trailer argumentsChristian Couder, Dec 24, 2013
  7. 5/9 strbuf: add strbuf_isspace()Christian Couder, Dec 24, 2013
  8. 6/9 trailer: parse trailers from input fileChristian Couder, Dec 24, 2013
  9. 7/9 trailer: put all the processing together and printChristian Couder, Dec 24, 2013
  10. 8/9 trailer: add interpret-trailers commandChristian Couder, Dec 24, 2013
  11. 9/9 trailer: add tests for "git interpret-trailers"Christian Couder, Dec 24, 2013
  12. Junio C HamanoDec 30, 2013
  13. Josh TriplettDec 30, 2013
  14. Junio C HamanoDec 30, 2013
  15. Josh TriplettDec 30, 2013
  16. Junio C HamanoDec 30, 2013
  17. Josh TriplettDec 30, 2013

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.