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 0/9] Add interpret-trailers builtin
Date: Tue, 24 Dec 2013 07:37:16 +0100	[thread overview]
Message-ID: <20131224061541.19560.17773.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
        - 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

             reply	other threads:[~2013-12-24  6:38 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-12-24  6:37 Christian Couder [this message]
2013-12-24  6:37 ` [PATCH 1/9] Add data structures and basic functions for commit trailers Christian Couder
2013-12-24  6:37 ` [PATCH 2/9] trailer: process trailers from file and arguments Christian Couder
2013-12-24  6:37 ` [PATCH 3/9] trailer: read and process config information Christian Couder
2013-12-24 13:47   ` Christian Couder
2013-12-24  6:37 ` [PATCH 4/9] trailer: process command line trailer arguments Christian Couder
2013-12-24  6:37 ` [PATCH 5/9] strbuf: add strbuf_isspace() Christian Couder
2013-12-24  6:37 ` [PATCH 6/9] trailer: parse trailers from input file Christian Couder
2013-12-24  6:37 ` [PATCH 7/9] trailer: put all the processing together and print Christian Couder
2013-12-24  6:37 ` [PATCH 8/9] trailer: add interpret-trailers command Christian Couder
2013-12-24  6:37 ` [PATCH 9/9] trailer: add tests for "git interpret-trailers" Christian Couder
2013-12-30 17:19   ` Junio C Hamano
2013-12-30 20:20     ` Josh Triplett
2013-12-30 20:46       ` Junio C Hamano
2013-12-30 20:52         ` Josh Triplett
2013-12-30 21:05           ` Junio C Hamano
2013-12-30 22:27             ` Josh Triplett

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=20131224061541.19560.17773.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).