From: ZheNing Hu <adlternative@xxxxxxxxx>
Historically, Git has supported the 'Signed-off-by' commit trailer
using the '--signoff' and the '-s' option from the command line.
But users may need to provide other trailer information from the
command line such as "Helped-by", "Reported-by", "Mentored-by",
Now implement a new `--trailer <token>[(=|:)<value>]` option to pass
other trailers to `interpret-trailers` and insert them into commit
messages.
Signed-off-by: ZheNing Hu <adlternative@xxxxxxxxx>
---
[GSOC] commit: add --trailer option
Now maintainers or developers can also use commit
--trailer="Signed-off-by:commiter<email>" from the command line to
provide trailers to commit messages. This solution may be more
generalized than v1.
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-901%2Fadlternative%2Fcommit-with-multiple-signatures-v4
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-901/adlternative/commit-with-multiple-signatures-v4
Pull-Request: https://github.com/gitgitgadget/git/pull/901
Range-diff vs v3:
1: b4e161a98f8b ! 1: dc507553ef4f [GSOC] commit: add --trailer option
@@ Documentation/git-commit.txt: The `-m` option is mutually exclusive with `-c`, `
+--trailer <token>[(=|:)<value>]::
+ Specify a (<token>, <value>) pair that should be applied as a
-+ trailer. (e.g. `git commit --trailer "Signed-off-by:C O Mitter <committer@xxxxxxxxxxx>" \
-+ --trailer "Helped-by:C O Mitter <committer@xxxxxxxxxxx>"`will add the "Signed-off" trailer
++ trailer. (e.g. `git commit --trailer "Signed-off-by:C O Mitter \
++ <committer@xxxxxxxxxxx>" --trailer "Helped-by:C O Mitter \
++ <committer@xxxxxxxxxxx>"` will add the "Signed-off" trailer
+ and the "Helped-by" trailer in the commit message.)
+
-n::
@@ builtin/commit.c: static struct strbuf message = STRBUF_INIT;
+ strvec_clear(&run_trailer.args);
+ return -1;
+ }
-+ run_trailer.git_cmd = 1;
+ strvec_pushl(&run_trailer.args, "--trailer", arg, NULL);
+ return 0;
+}
@@ builtin/commit.c: static int prepare_to_commit(const char *index_file, const cha
fclose(s->fp);
-+ run_command(&run_trailer);
++ if (run_trailer.args.nr != 4) {
++ run_trailer.git_cmd = 1;
++ run_command(&run_trailer);
++ } else
++ strvec_clear(&run_trailer.args);
+
/*
* Reject an attempt to record a non-merge empty commit without
@@ builtin/commit.c: int cmd_commit(int argc, const char **argv, const char *prefix
}
verbose = -1; /* unspecified */
+ strvec_pushl(&run_trailer.args, "interpret-trailers",
-+ "--in-place", "--where=end", git_path_commit_editmsg(), NULL);
++ "--in-place", "--where=end", git_path_commit_editmsg(), NULL);
argc = parse_and_validate_options(argc, argv, builtin_commit_options,
builtin_commit_usage,
prefix, current_head, &s);
@@ t/t7502-commit-porcelain.sh: test_expect_success 'sign off' '
+ >file1 &&
+ git add file1 &&
+ git commit -s --trailer "Signed-off-by:C O Mitter1 <committer1@xxxxxxxxxxx>" \
-+ --trailer "Helped-by:C O Mitter2 <committer2@xxxxxxxxxxx>" \
-+ --trailer "Reported-by:C O Mitter3 <committer3@xxxxxxxxxxx>" \
-+ --trailer "Mentored-by:C O Mitter4 <committer4@xxxxxxxxxxx>" \
-+ -m "hello" &&
++ --trailer "Helped-by:C O Mitter2 <committer2@xxxxxxxxxxx>" \
++ --trailer "Reported-by:C O Mitter3 <committer3@xxxxxxxxxxx>" \
++ --trailer "Mentored-by:C O Mitter4 <committer4@xxxxxxxxxxx>" \
++ -m "hello" &&
+ git cat-file commit HEAD >commit.msg &&
+ sed -e "1,7d" commit.msg >actual &&
+ cat >expected <<-\EOF &&
Documentation/git-commit.txt | 9 ++++++++-
builtin/commit.c | 21 +++++++++++++++++++++
t/t7502-commit-porcelain.sh | 20 ++++++++++++++++++++
3 files changed, 49 insertions(+), 1 deletion(-)
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 17150fa7eabe..73a7507db47f 100644
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -14,7 +14,7 @@ SYNOPSIS
[--allow-empty-message] [--no-verify] [-e] [--author=<author>]
[--date=<date>] [--cleanup=<mode>] [--[no-]status]
[-i | -o] [--pathspec-from-file=<file> [--pathspec-file-nul]]
- [-S[<keyid>]] [--] [<pathspec>...]
+ [-S[<keyid>]] [--] [<pathspec>...] [(--trailer <token>[(=|:)<value>])...]
DESCRIPTION
-----------
@@ -166,6 +166,13 @@ The `-m` option is mutually exclusive with `-c`, `-C`, and `-F`.
include::signoff-option.txt[]
+--trailer <token>[(=|:)<value>]::
+ Specify a (<token>, <value>) pair that should be applied as a
+ trailer. (e.g. `git commit --trailer "Signed-off-by:C O Mitter \
+ <committer@xxxxxxxxxxx>" --trailer "Helped-by:C O Mitter \
+ <committer@xxxxxxxxxxx>"` will add the "Signed-off" trailer
+ and the "Helped-by" trailer in the commit message.)
+
-n::
--no-verify::
This option bypasses the pre-commit and commit-msg hooks.
diff --git a/builtin/commit.c b/builtin/commit.c
index 739110c5a7f6..b35ae5c9790d 100644
--- a/builtin/commit.c
+++ b/builtin/commit.c
@@ -113,6 +113,8 @@ static int config_commit_verbose = -1; /* unspecified */
static int no_post_rewrite, allow_empty_message, pathspec_file_nul;
static char *untracked_files_arg, *force_date, *ignore_submodule_arg, *ignored_arg;
static char *sign_commit, *pathspec_from_file;
+struct child_process run_trailer = CHILD_PROCESS_INIT;
+static const char *trailer;
/*
* The default commit message cleanup mode will remove the lines
@@ -131,6 +133,16 @@ static struct strbuf message = STRBUF_INIT;
static enum wt_status_format status_format = STATUS_FORMAT_UNSPECIFIED;
+static int opt_pass_trailer(const struct option *opt, const char *arg, int unset)
+{
+ if (unset) {
+ strvec_clear(&run_trailer.args);
+ return -1;
+ }
+ strvec_pushl(&run_trailer.args, "--trailer", arg, NULL);
+ return 0;
+}
+
static int opt_parse_porcelain(const struct option *opt, const char *arg, int unset)
{
enum wt_status_format *value = (enum wt_status_format *)opt->value;
@@ -958,6 +970,12 @@ static int prepare_to_commit(const char *index_file, const char *prefix,
fclose(s->fp);
+ if (run_trailer.args.nr != 4) {
+ run_trailer.git_cmd = 1;
+ run_command(&run_trailer);
+ } else
+ strvec_clear(&run_trailer.args);
+
/*
* Reject an attempt to record a non-merge empty commit without
* explicit --allow-empty. In the cherry-pick case, it may be
@@ -1507,6 +1525,7 @@ int cmd_commit(int argc, const char **argv, const char *prefix)
OPT_STRING(0, "fixup", &fixup_message, N_("commit"), N_("use autosquash formatted message to fixup specified commit")),
OPT_STRING(0, "squash", &squash_message, N_("commit"), N_("use autosquash formatted message to squash specified commit")),
OPT_BOOL(0, "reset-author", &renew_authorship, N_("the commit is authored by me now (used with -C/-c/--amend)")),
+ OPT_CALLBACK(0, "trailer", &trailer, N_("trailer"), N_("trailer(s) to add"), opt_pass_trailer),
OPT_BOOL('s', "signoff", &signoff, N_("add a Signed-off-by trailer")),
OPT_FILENAME('t', "template", &template_file, N_("use specified template file")),
OPT_BOOL('e', "edit", &edit_flag, N_("force edit of commit")),
@@ -1577,6 +1596,8 @@ int cmd_commit(int argc, const char **argv, const char *prefix)
die(_("could not parse HEAD commit"));
}
verbose = -1; /* unspecified */
+ strvec_pushl(&run_trailer.args, "interpret-trailers",
+ "--in-place", "--where=end", git_path_commit_editmsg(), NULL);
argc = parse_and_validate_options(argc, argv, builtin_commit_options,
builtin_commit_usage,
prefix, current_head, &s);
diff --git a/t/t7502-commit-porcelain.sh b/t/t7502-commit-porcelain.sh
index 6396897cc818..0acf23799931 100755
--- a/t/t7502-commit-porcelain.sh
+++ b/t/t7502-commit-porcelain.sh
@@ -154,6 +154,26 @@ test_expect_success 'sign off' '
'
+test_expect_success 'trailer' '
+ >file1 &&
+ git add file1 &&
+ git commit -s --trailer "Signed-off-by:C O Mitter1 <committer1@xxxxxxxxxxx>" \
+ --trailer "Helped-by:C O Mitter2 <committer2@xxxxxxxxxxx>" \
+ --trailer "Reported-by:C O Mitter3 <committer3@xxxxxxxxxxx>" \
+ --trailer "Mentored-by:C O Mitter4 <committer4@xxxxxxxxxxx>" \
+ -m "hello" &&
+ git cat-file commit HEAD >commit.msg &&
+ sed -e "1,7d" commit.msg >actual &&
+ cat >expected <<-\EOF &&
+ Signed-off-by: C O Mitter <committer@xxxxxxxxxxx>
+ Signed-off-by: C O Mitter1 <committer1@xxxxxxxxxxx>
+ Helped-by: C O Mitter2 <committer2@xxxxxxxxxxx>
+ Reported-by: C O Mitter3 <committer3@xxxxxxxxxxx>
+ Mentored-by: C O Mitter4 <committer4@xxxxxxxxxxx>
+ EOF
+ test_cmp expected actual
+'
+
test_expect_success 'multiple -m' '
>negative &&
base-commit: 13d7ab6b5d7929825b626f050b62a11241ea4945
--
gitgitgadget
