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

[PATCH v6 00/11] Add interpret-trailers builtin

From
Christian Couder <chriscool@tuxfamily.org>
Date
Mar 4, 2014, 19:47 UTC
Message-ID
<20140304193250.14249.56949.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] [(<token>[(=|:)<value>])...]
The following features are implemented:
        - the result is printed on stdout
        - the [<token>[=<value>]>] arguments are interpreted
        - a commit message read from stdin 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
        - the "trailer.<token>.command" config works
        - $ARG can be used in commands
        - 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 5, thanks to Junio and Eric:
* the --infile <file> option has been removed 
* many small functions are back to just 'static' instead of 'static inline'
* alnum_len() has been adjust to have a "size_t len" parameter and a size_t
  return value again
* strcspn() is used in void parse_trailer()
* some test setup commands have been moved in some proper tests
* some commit messages have been improved
* a patch to setup env variables for commands has been removed
* all the memory leaks should have been fixed
Christian Couder (11):
  Add data structures and basic functions for commit trailers
  trailer: process trailers from stdin and arguments
  trailer: read and process config information
  trailer: process command line trailer arguments
  trailer: parse trailers from stdin
  trailer: put all the processing together and print
  trailer: add interpret-trailers command
  trailer: add tests for "git interpret-trailers"
  trailer: execute command from 'trailer.<name>.command'
  trailer: add tests for commands in config file
  Documentation: add documentation for 'git interpret-trailers'
 .gitignore                               |   1 +
 Documentation/git-interpret-trailers.txt | 123 ++++++
 Makefile                                 |   2 +
 builtin.h                                |   1 +
 builtin/interpret-trailers.c             |  33 ++
 git.c                                    |   1 +
 t/t7513-interpret-trailers.sh            | 261 ++++++++++++
 trailer.c                                | 661 +++++++++++++++++++++++++++++++
 trailer.h                                |   6 +
 9 files changed, 1089 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.204.gcfe299d.dirty
Next: Christian Couder
Message 1 of 21 in “Add interpret-trailers builtin”
  1. 00/11 Add interpret-trailers builtinChristian Couder, Mar 4, 2014
  2. 01/11 Add data structures and basic functions for commit trailersChristian Couder, Mar 4, 2014
  3. 02/11 trailer: process trailers from stdin and argumentsChristian Couder, Mar 4, 2014
  4. Junio C HamanoMar 5, 2014
  5. Christian CouderMar 7, 2014
  6. Dan CarpenterMar 7, 2014
  7. Christian CouderMar 7, 2014
  8. 03/11 trailer: read and process config informationChristian Couder, Mar 4, 2014
  9. 04/11 trailer: process command line trailer argumentsChristian Couder, Mar 4, 2014
  10. Junio C HamanoMar 5, 2014
  11. 05/11 trailer: parse trailers from stdinChristian Couder, Mar 4, 2014
  12. Junio C HamanoMar 5, 2014
  13. 06/11 trailer: put all the processing together and printChristian Couder, Mar 4, 2014
  14. 07/11 trailer: add interpret-trailers commandChristian Couder, Mar 4, 2014
  15. 08/11 trailer: add tests for "git interpret-trailers"Christian Couder, Mar 4, 2014
  16. Junio C HamanoMar 5, 2014
  17. 09/11 trailer: execute command from 'trailer.<name>.command'Christian Couder, Mar 4, 2014
  18. Junio C HamanoMar 5, 2014
  19. 10/11 trailer: add tests for commands in config fileChristian Couder, Mar 4, 2014
  20. 11/11 Documentation: add documentation for 'git interpret-trailers'Christian Couder, Mar 4, 2014
  21. Ramsay JonesMar 6, 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.