From: ZheNing Hu <adlternative@xxxxxxxxx>
Use the newly added option `--own-identity` in
`interpret-trailers`, implement new commit option
`--own-identity` to allow user optionalise <value>
in `--trailer`, by substitute user's identity if
missing. Using the `--own-identity` option, users
can directly use `--trailer="Signed-off-by"` to
generate a signoff trailer with their own identities
in commit messages,
The effect is basically the same as the `--signoff`
option. However, users can add more useful options at
the same time. e.g. `--trailer="Helped-by" --own-identity`
can general `Helped-by: C O Mitter <committer@xxxxxxxxxxx>`,
or through appropriate configuration:
`git -c trailer.signoff.key="Signed-off-by" commit \
--trailer="signoff" --own-identity`
can also general their needs trailers with their favorite
keys and their own identities.
Signed-off-by: ZheNing Hu <adlternative@xxxxxxxxx>
---
Documentation/git-commit.txt | 19 +++++-
builtin/commit.c | 8 +++
t/t7501-commit-basic-functionality.sh | 91 +++++++++++++++++++++++++++
t/t7502-commit-porcelain.sh | 20 ++++++
4 files changed, 136 insertions(+), 2 deletions(-)
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 2ba2fe0dd10e..69b3e694eb20 100644
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -14,8 +14,8 @@ SYNOPSIS
[--allow-empty-message] [--no-verify] [-e] [--author=<author>]
[--date=<date>] [--cleanup=<mode>] [--[no-]status]
[-i | -o] [--pathspec-from-file=<file> [--pathspec-file-nul]]
- [(--trailer <token>[(=|:)<value>])...] [-S[<keyid>]]
- [--] [<pathspec>...]
+ [(--trailer <token>[(=|:)<value>])... [--own-identity]]
+ [-S[<keyid>]] [--] [<pathspec>...]
DESCRIPTION
-----------
@@ -175,6 +175,21 @@ include::signoff-option.txt[]
and the "Helped-by" trailer in the commit message.)
Use `git -c trailer.* commit --trailer` to make the appropriate
configuration. See linkgit:git-interpret-trailers[1] for details.
+
+--own-identity::
+ Used with `--trailer`. Those trailers without value with the
+ `--own-identity` option all will add the user's own identity.
+ For example, `git commit --trailer \
+ "A:B" --trailer "Signed-off-by" --trailer "Helped-by" --own-identity`,
+ will output:
+ "
+ A:B
+ Signed-off-by: C O Mitter <committer@xxxxxxxxxxx>
+ Helped-by: C O Mitter <committer@xxxxxxxxxxx>
+ "
+ in commit messages.
+ See linkgit:git-interpret-trailers[1]for details.
+
-n::
--no-verify::
This option bypasses the pre-commit and commit-msg hooks.
diff --git a/builtin/commit.c b/builtin/commit.c
index 4b06672bd07d..dc2fc0dc46ff 100644
--- a/builtin/commit.c
+++ b/builtin/commit.c
@@ -114,6 +114,7 @@ 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;
static struct strvec trailer_args = STRVEC_INIT;
+static int own_identity;
/*
* The default commit message cleanup mode will remove the lines
@@ -972,6 +973,8 @@ static int prepare_to_commit(const char *index_file, const char *prefix,
strvec_pushl(&run_trailer.args, "interpret-trailers",
"--in-place", git_path_commit_editmsg(), NULL);
+ if (own_identity)
+ strvec_push(&run_trailer.args, "--own-identity");
strvec_pushv(&run_trailer.args, trailer_args.v);
run_trailer.git_cmd = 1;
if (run_command(&run_trailer))
@@ -1529,6 +1532,8 @@ int cmd_commit(int argc, const char **argv, const char *prefix)
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_F(0, "trailer", NULL, N_("trailer"), N_("add custom trailer(s)"), PARSE_OPT_NONEG, opt_pass_trailer),
+ OPT_BOOL(0, "own-identity", &own_identity,
+ N_("specify the user's own identity for omitted trailers value")),
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")),
@@ -1605,6 +1610,9 @@ int cmd_commit(int argc, const char **argv, const char *prefix)
if (verbose == -1)
verbose = (config_commit_verbose < 0) ? 0 : config_commit_verbose;
+ if (own_identity && !trailer_args.nr)
+ die(_("--own_identity requires --trailer"));
+
if (dry_run)
return dry_run_commit(argv, prefix, current_head, &s);
index_file = prepare_index(argv, prefix, current_head, 0);
diff --git a/t/t7501-commit-basic-functionality.sh b/t/t7501-commit-basic-functionality.sh
index 512ae2781fe2..7ff74cf81e75 100755
--- a/t/t7501-commit-basic-functionality.sh
+++ b/t/t7501-commit-basic-functionality.sh
@@ -423,6 +423,25 @@ test_expect_success 'sign off (1)' '
'
+test_expect_success '--trailer="signoff" (1)' '
+
+ echo 1 >>positive &&
+ git add positive &&
+ git -c trailer.signoff.key="Signed-off-by" \
+ commit --trailer="signoff" --own-identity \
+ -m "thank you" &&
+ git cat-file commit HEAD >commit &&
+ sed -e "1,/^\$/d" commit >actual &&
+ (
+ echo thank you &&
+ echo &&
+ git var GIT_COMMITTER_IDENT >ident &&
+ sed -e "s/>.*/>/" -e "s/^/Signed-off-by: /" ident
+ ) >expected &&
+ test_cmp expected actual
+
+'
+
test_expect_success 'sign off (2)' '
echo 2 >positive &&
@@ -444,6 +463,30 @@ $existing" &&
'
+test_expect_success '--trailer="signoff" (2)' '
+
+ echo 2 >>positive &&
+ git add positive &&
+ existing="Signed-off-by: Watch This <watchthis@xxxxxxxxxxx>" &&
+ git -c trailer.signoff.key="Signed-off-by" \
+ commit --trailer="signoff" --own-identity \
+ -m "thank you
+
+$existing" &&
+ git cat-file commit HEAD >commit &&
+ sed -e "1,/^\$/d" commit >actual &&
+ (
+ echo thank you &&
+ echo &&
+ echo $existing &&
+ git var GIT_COMMITTER_IDENT >ident &&
+ sed -e "s/>.*/>/" -e "s/^/Signed-off-by: /" ident
+ ) >expected &&
+ test_cmp expected actual
+
+'
+
+
test_expect_success 'signoff gap' '
echo 3 >positive &&
@@ -464,6 +507,29 @@ $alt" &&
test_cmp expected actual
'
+test_expect_success '--trailer="signoff" gap' '
+
+ echo 3 >>positive &&
+ git add positive &&
+ alt="Alt-RFC-822-Header: Value" &&
+ git -c trailer.signoff.key="Signed-off-by" \
+ commit --trailer="signoff" --own-identity \
+ -m "welcome
+
+$alt" &&
+ git cat-file commit HEAD >commit &&
+ sed -e "1,/^\$/d" commit >actual &&
+ (
+ echo welcome &&
+ echo &&
+ echo $alt &&
+ git var GIT_COMMITTER_IDENT >ident &&
+ sed -e "s/>.*/>/" -e "s/^/Signed-off-by: /" ident
+ ) >expected &&
+ test_cmp expected actual
+'
+
+
test_expect_success 'signoff gap 2' '
echo 4 >positive &&
@@ -487,6 +553,31 @@ $alt" &&
test_cmp expected actual
'
+test_expect_success '--trailer="signoff" gap 2' '
+
+ echo 4 >>positive &&
+ git add positive &&
+ alt="fixed: 34" &&
+ git -c trailer.signoff.key="Signed-off-by" \
+ commit --trailer="signoff" --own-identity \
+ -m "welcome
+
+We have now
+$alt" &&
+ git cat-file commit HEAD >commit &&
+ sed -e "1,/^\$/d" commit >actual &&
+ (
+ echo welcome &&
+ echo &&
+ echo We have now &&
+ echo $alt &&
+ echo &&
+ git var GIT_COMMITTER_IDENT >ident &&
+ sed -e "s/>.*/>/" -e "s/^/Signed-off-by: /" ident
+ ) >expected &&
+ test_cmp expected actual
+'
+
test_expect_success 'signoff respects trailer config' '
echo 5 >positive &&
diff --git a/t/t7502-commit-porcelain.sh b/t/t7502-commit-porcelain.sh
index 024cf3c81b18..6c1387c943ff 100755
--- a/t/t7502-commit-porcelain.sh
+++ b/t/t7502-commit-porcelain.sh
@@ -489,6 +489,26 @@ test_expect_success 'commit --trailer with -c and ":=#" as separators' '
test_cmp expected actual
'
+test_expect_success 'commit --trailer with -c and --own-identity' '
+ echo "fun" >>file1 &&
+ git add file1 &&
+ cat >expected <<-\EOF &&
+
+ Signed-off-by: C O Mitter <committer@xxxxxxxxxxx>
+ EOF
+ git -c trailer.signoff.key="Signed-off-by: " \
+ commit --trailer "signoff" --own-identity -m "abc" &&
+ git cat-file commit HEAD >commit.msg &&
+ sed -e "1,6d" commit.msg >actual &&
+ test_cmp expected actual
+'
+
+test_expect_success 'commit --own-identity without --trailer' '
+ echo "fun" >>file1 &&
+ git add file1 &&
+ test_must_fail git -c commit --own-identity -m "abc"
+'
+
test_expect_success 'multiple -m' '
>negative &&
--
gitgitgadget
