From mboxrd@z Thu Jan 1 00:00:00 1970 From: Christian Couder Subject: [PATCH v6 00/11] Add interpret-trailers builtin Date: Tue, 04 Mar 2014 20:47:58 +0100 Message-ID: <20140304193250.14249.56949.chriscool@tuxfamily.org> Cc: git@vger.kernel.org, Johan Herland , Josh Triplett , Thomas Rast , Michael Haggerty , Dan Carpenter , Greg Kroah-Hartman , Jeff King , Eric Sunshine To: Junio C Hamano X-From: git-owner@vger.kernel.org Tue Mar 04 20:49:40 2014 Return-path: Envelope-to: gcvg-git-2@plane.gmane.org Received: from vger.kernel.org ([209.132.180.67]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1WKvLK-0008MP-In for gcvg-git-2@plane.gmane.org; Tue, 04 Mar 2014 20:49:34 +0100 Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1754811AbaCDTta (ORCPT ); Tue, 4 Mar 2014 14:49:30 -0500 Received: from mail-3y.bbox.fr ([194.158.98.45]:63918 "EHLO mail-3y.bbox.fr" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1753078AbaCDTt3 (ORCPT ); Tue, 4 Mar 2014 14:49:29 -0500 Received: from [127.0.1.1] (cha92-h01-128-78-31-246.dsl.sta.abo.bbox.fr [128.78.31.246]) by mail-3y.bbox.fr (Postfix) with ESMTP id 33BE656; Tue, 4 Mar 2014 20:49:25 +0100 (CET) X-Mailer: git-mail-commits v0.5.2 Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Archived-At: 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] [([(=|:)])...] The following features are implemented: - the result is printed on stdout - the [[=]>] arguments are interpreted - a commit message read from stdin is interpreted - the "trailer..key" options in the config are interpreted - the "trailer..where" options are interpreted - the "trailer..ifExist" options are interpreted - the "trailer..ifMissing" options are interpreted - the "trailer..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 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..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