git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Christian Couder <chriscool@tuxfamily.org>
To: Junio C Hamano <gitster@pobox.com>
Cc: git@vger.kernel.org, Johan Herland <johan@herland.net>,
	Josh Triplett <josh@joshtriplett.org>,
	Thomas Rast <tr@thomasrast.ch>,
	Michael Haggerty <mhagger@alum.mit.edu>,
	Dan Carpenter <dan.carpenter@oracle.com>,
	Greg Kroah-Hartman <greg@kroah.com>, Jeff King <peff@peff.net>
Subject: [PATCH v2 00/16] Add interpret-trailers builtin
Date: Sun, 19 Jan 2014 09:53:38 +0100	[thread overview]
Message-ID: <20140119083636.2734.14378.chriscool@tuxfamily.org> (raw)

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
        - (new) 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
        - (new) the "trailer.<token>.command" config works
        - (new) GIT_{AUTHOR,COMMITTER}_{NAME,EMAIL} env variables
          can be used in commands 
        - there are a lot of tests

The following features are planned but not yet implemented:
        - some documentation
        - integration with "git commit"

Possible improvements:
        - support GIT_COMMIT_PROTO env variable in commands

3) Notes:

* I used "sed -e 's/ Z$/ /' <<-\EOF" in the tests as suggested by Junio. 

* I added many commits on top of the previous series, but of course they
can be squashed.

Christian Couder (16):
  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

 .gitignore                    |   1 +
 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                     | 639 ++++++++++++++++++++++++++++++++++++++++++
 trailer.h                     |   6 +
 10 files changed, 966 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.5.2.201.gacc5987

             reply	other threads:[~2014-01-19  8:55 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-01-19  8:53 Christian Couder [this message]
2014-01-19  8:53 ` [PATCH v2 01/16] Add data structures and basic functions for commit trailers Christian Couder
2014-01-19  8:53 ` [PATCH v2 02/16] trailer: process trailers from file and arguments Christian Couder
2014-01-19  8:53 ` [PATCH v2 03/16] trailer: read and process config information Christian Couder
2014-01-19  8:53 ` [PATCH v2 04/16] trailer: process command line trailer arguments Christian Couder
2014-01-21 22:41   ` Junio C Hamano
2014-01-21 22:50     ` Junio C Hamano
2014-01-26 17:28       ` Christian Couder
2014-01-19  8:53 ` [PATCH v2 05/16] strbuf: add strbuf_isspace() Christian Couder
2014-01-19  8:53 ` [PATCH v2 06/16] trailer: parse trailers from input file Christian Couder
2014-01-19  8:53 ` [PATCH v2 07/16] trailer: put all the processing together and print Christian Couder
2014-01-19  8:53 ` [PATCH v2 08/16] trailer: add interpret-trailers command Christian Couder
2014-01-19  8:53 ` [PATCH v2 09/16] trailer: add tests for "git interpret-trailers" Christian Couder
2014-01-19  8:53 ` [PATCH v2 10/16] trailer: if no input file is passed, read from stdin Christian Couder
2014-01-19  8:53 ` [PATCH v2 11/16] trailer: add new_trailer_item() function Christian Couder
2014-01-19  8:53 ` [PATCH v2 12/16] strbuf: add strbuf_replace() Christian Couder
2014-01-19  8:53 ` [PATCH v2 13/16] trailer: execute command from 'trailer.<name>.command' Christian Couder
2014-01-19  8:53 ` [PATCH v2 14/16] trailer: add tests for trailer command Christian Couder
2014-01-19  8:53 ` [PATCH v2 15/16] trailer: set author and committer env variables Christian Couder
2014-01-19  8:53 ` [PATCH v2 16/16] trailer: add tests for commands using " Christian Couder

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20140119083636.2734.14378.chriscool@tuxfamily.org \
    --to=chriscool@tuxfamily.org \
    --cc=dan.carpenter@oracle.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=greg@kroah.com \
    --cc=johan@herland.net \
    --cc=josh@joshtriplett.org \
    --cc=mhagger@alum.mit.edu \
    --cc=peff@peff.net \
    --cc=tr@thomasrast.ch \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).