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>,
	Eric Sunshine <sunshine@sunshineco.com>
Subject: [PATCH v6 00/11] Add interpret-trailers builtin
Date: Tue, 04 Mar 2014 20:47:58 +0100	[thread overview]
Message-ID: <20140304193250.14249.56949.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] [(<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

             reply	other threads:[~2014-03-04 19:49 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-03-04 19:47 Christian Couder [this message]
2014-03-04 19:47 ` [PATCH v6 01/11] Add data structures and basic functions for commit trailers Christian Couder
2014-03-04 19:48 ` [PATCH v6 02/11] trailer: process trailers from stdin and arguments Christian Couder
2014-03-05 22:52   ` Junio C Hamano
2014-03-07  6:19     ` Christian Couder
2014-03-07  8:08       ` Dan Carpenter
2014-03-07 12:41         ` Christian Couder
2014-03-04 19:48 ` [PATCH v6 03/11] trailer: read and process config information Christian Couder
2014-03-04 19:48 ` [PATCH v6 04/11] trailer: process command line trailer arguments Christian Couder
2014-03-05 22:55   ` Junio C Hamano
2014-03-04 19:48 ` [PATCH v6 05/11] trailer: parse trailers from stdin Christian Couder
2014-03-05 22:56   ` Junio C Hamano
2014-03-04 19:48 ` [PATCH v6 06/11] trailer: put all the processing together and print Christian Couder
2014-03-04 19:48 ` [PATCH v6 07/11] trailer: add interpret-trailers command Christian Couder
2014-03-04 19:48 ` [PATCH v6 08/11] trailer: add tests for "git interpret-trailers" Christian Couder
2014-03-05 22:59   ` Junio C Hamano
2014-03-04 19:48 ` [PATCH v6 09/11] trailer: execute command from 'trailer.<name>.command' Christian Couder
2014-03-05 22:57   ` Junio C Hamano
2014-03-04 19:48 ` [PATCH v6 10/11] trailer: add tests for commands in config file Christian Couder
2014-03-04 19:48 ` [PATCH v6 11/11] Documentation: add documentation for 'git interpret-trailers' Christian Couder
2014-03-06  1:18 ` [PATCH v6 00/11] Add interpret-trailers builtin Ramsay Jones

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=20140304193250.14249.56949.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=sunshine@sunshineco.com \
    --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).