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

[PATCH v4 00/17] Add interpret-trailers builtin

From
Christian Couder <chriscool@tuxfamily.org>
Date
Jan 30, 2014, 06:49 UTC
Message-ID
<20140130064217.7504.473.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
        - if "--infile" is not used, a commit message is read from stdin
        - 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
        - the "trailer.<token>.command" config works
        - $ARG can be used in commands
        - ditto for GIT_{AUTHOR,COMMITTER}_{NAME,EMAIL} env variables
        - there are some tests
        - there is some documentation
The following features are planned but not yet implemented:
        - add more tests related to commands
        - add examples in documentation
        - integration with "git commit"
Possible improvements:
        - support GIT_COMMIT_PROTO env variable in commands
3) Changes since version 3, thanks to Eric and Junio:
* the usage string/synopsis of the command was improved
* some spelling/wording mistakes in the doc were fixed
* some style issues were fixed
Christian Couder (17):
  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"
  trailer: if no input file is passed, read from stdin
  trailer: add new_trailer_item() function
  strbuf: add strbuf_replace()
  trailer: execute command from 'trailer.<name>.command'
  trailer: add tests for trailer command
  trailer: set author and committer env variables
  trailer: add tests for commands using env variables
  Documentation: add documentation for 'git interpret-trailers'
 .gitignore                               |   1 +
 Documentation/git-interpret-trailers.txt | 132 +++++++
 Makefile                                 |   2 +
 builtin.h                                |   1 +
 builtin/interpret-trailers.c             |  36 ++
 git.c                                    |   1 +
 strbuf.c                                 |  14 +
 strbuf.h                                 |   4 +
 t/t7513-interpret-trailers.sh            | 262 +++++++++++++
 trailer.c                                | 637 +++++++++++++++++++++++++++++++
 trailer.h                                |   6 +
 11 files changed, 1096 insertions(+)
 create mode 100644 Documentation/git-interpret-trailers.txt
 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.5.2.201.gacc5987
Next: Christian Couder
Message 1 of 33 in “Add interpret-trailers builtin”
  1. 00/17 Add interpret-trailers builtinChristian Couder, Jan 30, 2014
  2. 01/17 Add data structures and basic functions for commit trailersChristian Couder, Jan 30, 2014
  3. Eric SunshineJan 30, 2014
  4. 02/17 trailer: process trailers from file and argumentsChristian Couder, Jan 30, 2014
  5. Eric SunshineJan 31, 2014
  6. 03/17 trailer: read and process config informationChristian Couder, Jan 30, 2014
  7. Eric SunshineJan 31, 2014
  8. 04/17 trailer: process command line trailer argumentsChristian Couder, Jan 30, 2014
  9. Eric SunshineJan 31, 2014
  10. 05/17 strbuf: add strbuf_isspace()Christian Couder, Jan 30, 2014
  11. Eric SunshineJan 31, 2014
  12. Eric SunshineJan 31, 2014
  13. 06/17 trailer: parse trailers from input fileChristian Couder, Jan 30, 2014
  14. Eric SunshineJan 31, 2014
  15. 07/17 trailer: put all the processing together and printChristian Couder, Jan 30, 2014
  16. 08/17 trailer: add interpret-trailers commandChristian Couder, Jan 30, 2014
  17. Eric SunshineJan 31, 2014
  18. Christian CouderFeb 6, 2014
  19. 09/17 trailer: add tests for "git interpret-trailers"Christian Couder, Jan 30, 2014
  20. 10/17 trailer: if no input file is passed, read from stdinChristian Couder, Jan 30, 2014
  21. Eric SunshineFeb 2, 2014
  22. Christian CouderFeb 6, 2014
  23. Junio C HamanoFeb 6, 2014
  24. Christian CouderFeb 9, 2014
  25. 11/17 trailer: add new_trailer_item() functionChristian Couder, Jan 30, 2014
  26. Eric SunshineFeb 2, 2014
  27. 12/17 strbuf: add strbuf_replace()Christian Couder, Jan 30, 2014
  28. Eric SunshineJan 31, 2014
  29. 13/17 trailer: execute command from 'trailer.<name>.command'Christian Couder, Jan 30, 2014
  30. 14/17 trailer: add tests for trailer commandChristian Couder, Jan 30, 2014
  31. 15/17 trailer: set author and committer env variablesChristian Couder, Jan 30, 2014
  32. 16/17 trailer: add tests for commands using env variablesChristian Couder, Jan 30, 2014
  33. 17/17 Documentation: add documentation for 'git interpret-trailers'Christian Couder, Jan 30, 2014

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.