From: "ZheNing Hu via GitGitGadget" <gitgitgadget@gmail.com>
To: git@vger.kernel.org
Cc: "Bradley M. Kuhn" <bkuhn@sfconservancy.org>,
Junio C Hamano <gitster@pobox.com>,
Brandon Casey <drafnel@gmail.com>,
Shourya Shukla <periperidip@gmail.com>,
Christian Couder <christian.couder@gmail.com>,
Rafael Silva <rafaeloliveira.cs@gmail.com>,
ZheNing Hu <adlternative@gmail.com>,
ZheNing Hu <adlternative@gmail.com>
Subject: [PATCH v10 3/3] commit: add own-identity option
Date: Thu, 18 Mar 2021 11:15:56 +0000 [thread overview]
Message-ID: <2dfcc20f0e9faa1aa08aa524127ffef44bd98182.1616066157.git.gitgitgadget@gmail.com> (raw)
In-Reply-To: <pull.901.v10.git.1616066156.gitgitgadget@gmail.com>
From: ZheNing Hu <adlternative@gmail.com>
Use the newly added option `--own-identity` in `interpret-trailers`,
implement new commit option `--own-identity` to allow those trailers
with no value add the user’s own identity. 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@example.com>`;
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@gmail.com>
---
Documentation/git-commit.txt | 15 +++++
builtin/commit.c | 8 +++
t/t7501-commit-basic-functionality.sh | 91 +++++++++++++++++++++++++++
t/t7502-commit-porcelain.sh | 20 ++++++
4 files changed, 134 insertions(+)
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index c5de981cd40d..393c424e8184 100644
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -174,6 +174,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@example.com>
+ Helped-by: C O Mitter <committer@example.com>
+ "
+ 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 7a79aae48f43..0310c187ec07 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)) {
@@ -1530,6 +1533,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")),
@@ -1606,6 +1611,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@example.com>" &&
+ 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 6df71fa00bcb..1628a1c1e7d6 100755
--- a/t/t7502-commit-porcelain.sh
+++ b/t/t7502-commit-porcelain.sh
@@ -490,6 +490,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@example.com>
+ 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
next prev parent reply other threads:[~2021-03-18 11:17 UTC|newest]
Thread overview: 84+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-03-11 7:16 [PATCH] [GSOC] commit: provides multiple common signatures ZheNing Hu via GitGitGadget
2021-03-11 15:03 ` Shourya Shukla
2021-03-12 11:41 ` ZheNing Hu
2021-03-11 17:28 ` Junio C Hamano
2021-03-12 12:01 ` ZheNing Hu
2021-03-12 13:22 ` ZheNing Hu
2021-03-12 15:54 ` [PATCH v2] [GSOC] commit: add trailer command ZheNing Hu via GitGitGadget
2021-03-14 4:19 ` Christian Couder
2021-03-14 7:09 ` ZheNing Hu
2021-03-14 22:45 ` Junio C Hamano
2021-03-14 13:02 ` [PATCH v3] [GSOC] commit: add --trailer option ZheNing Hu via GitGitGadget
2021-03-14 13:10 ` Rafael Silva
2021-03-14 14:13 ` ZheNing Hu
2021-03-14 15:58 ` [PATCH v4] " ZheNing Hu via GitGitGadget
2021-03-14 23:52 ` Junio C Hamano
2021-03-15 1:27 ` ZheNing Hu
2021-03-15 4:42 ` Junio C Hamano
2021-03-15 5:14 ` ZheNing Hu
2021-03-15 3:24 ` [PATCH v5] " ZheNing Hu via GitGitGadget
2021-03-15 5:33 ` Christian Couder
2021-03-15 5:41 ` Christian Couder
2021-03-15 5:46 ` ZheNing Hu
2021-03-15 6:35 ` [PATCH v6] " ZheNing Hu via GitGitGadget
2021-03-15 8:02 ` Christian Couder
2021-03-15 8:21 ` ZheNing Hu
2021-03-15 9:08 ` [PATCH v7] " ZheNing Hu via GitGitGadget
2021-03-15 10:00 ` Christian Couder
2021-03-15 10:14 ` Christian Couder
2021-03-15 11:32 ` ZheNing Hu
2021-03-16 5:37 ` Christian Couder
2021-03-16 8:35 ` ZheNing Hu
2021-03-15 13:07 ` [PATCH v8 0/2] " ZheNing Hu via GitGitGadget
2021-03-15 13:07 ` [PATCH v8 1/2] " ZheNing Hu via GitGitGadget
2021-03-16 12:52 ` Ævar Arnfjörð Bjarmason
2021-03-17 2:01 ` ZheNing Hu
2021-03-17 8:08 ` Ævar Arnfjörð Bjarmason
2021-03-17 13:54 ` ZheNing Hu
2021-03-15 13:07 ` [PATCH v8 2/2] interpret_trailers: for three options parse add warning ZheNing Hu via GitGitGadget
2021-03-16 5:53 ` Christian Couder
2021-03-16 9:11 ` ZheNing Hu
2021-03-16 10:39 ` [PATCH v9] [GSOC] commit: add --trailer option ZheNing Hu via GitGitGadget
2021-03-17 5:26 ` Shourya Shukla
2021-03-17 6:06 ` ZheNing Hu
2021-03-18 11:15 ` [PATCH v10 0/3] " ZheNing Hu via GitGitGadget
2021-03-18 11:15 ` [PATCH v10 1/3] " ZheNing Hu via GitGitGadget
2021-03-18 16:29 ` Đoàn Trần Công Danh
2021-03-19 7:56 ` ZheNing Hu
2021-03-18 11:15 ` [PATCH v10 2/3] interpret-trailers: add own-identity option ZheNing Hu via GitGitGadget
2021-03-18 16:45 ` Đoàn Trần Công Danh
2021-03-19 8:04 ` ZheNing Hu
2021-03-18 19:20 ` Junio C Hamano
2021-03-19 9:33 ` ZheNing Hu
2021-03-19 15:36 ` Junio C Hamano
2021-03-20 2:54 ` ZheNing Hu
2021-03-20 5:06 ` Jeff King
2021-03-20 5:50 ` Junio C Hamano
2021-03-20 6:16 ` ZheNing Hu
2021-03-20 6:38 ` ZheNing Hu
2021-03-20 6:53 ` Junio C Hamano
2021-03-20 8:43 ` ZheNing Hu
2021-03-18 11:15 ` ZheNing Hu via GitGitGadget [this message]
2021-03-18 13:47 ` [PATCH v10 0/3] [GSOC] commit: add --trailer option Christian Couder
2021-03-18 15:27 ` ZheNing Hu
2021-03-19 12:05 ` [PATCH v11] " ZheNing Hu via GitGitGadget
2021-03-19 17:48 ` Junio C Hamano
2021-03-20 13:41 ` [PATCH v12] " ZheNing Hu via GitGitGadget
2021-03-22 4:24 ` [PATCH v13] " ZheNing Hu via GitGitGadget
2021-03-22 7:43 ` Christian Couder
2021-03-22 10:23 ` ZheNing Hu
2021-03-22 21:34 ` Christian Couder
2021-03-23 6:11 ` ZheNing Hu
2021-03-23 6:19 ` Junio C Hamano
2021-03-23 7:57 ` Christian Couder
2021-03-23 17:11 ` Junio C Hamano
2021-03-24 5:21 ` ZheNing Hu
2021-03-23 10:35 ` ZheNing Hu
2021-03-23 12:41 ` Christian Couder
2021-03-23 17:12 ` Junio C Hamano
2021-03-24 5:25 ` ZheNing Hu
2021-03-22 21:55 ` Christian Couder
2021-03-23 6:29 ` ZheNing Hu
2021-03-23 13:55 ` [PATCH v14] " ZheNing Hu via GitGitGadget
2021-03-15 4:38 ` [PATCH v4] " Junio C Hamano
2021-03-15 5:11 ` ZheNing Hu
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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=2dfcc20f0e9faa1aa08aa524127ffef44bd98182.1616066157.git.gitgitgadget@gmail.com \
--to=gitgitgadget@gmail.com \
--cc=adlternative@gmail.com \
--cc=bkuhn@sfconservancy.org \
--cc=christian.couder@gmail.com \
--cc=drafnel@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=periperidip@gmail.com \
--cc=rafaeloliveira.cs@gmail.com \
/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.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
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 read-only IMAP folder(s) and NNTP newsgroup(s).