From patchwork Sun Mar 21 08:58:53 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: ZheNing Hu X-Patchwork-Id: 12152935 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-12.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id A7219C433DB for ; Sun, 21 Mar 2021 08:59:51 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 809AA61932 for ; Sun, 21 Mar 2021 08:59:51 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230008AbhCUI7N (ORCPT ); Sun, 21 Mar 2021 04:59:13 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:35324 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229883AbhCUI66 (ORCPT ); Sun, 21 Mar 2021 04:58:58 -0400 Received: from mail-wr1-x435.google.com (mail-wr1-x435.google.com [IPv6:2a00:1450:4864:20::435]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 429B1C061574 for ; Sun, 21 Mar 2021 01:58:58 -0700 (PDT) Received: by mail-wr1-x435.google.com with SMTP id x16so13463110wrn.4 for ; Sun, 21 Mar 2021 01:58:58 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=message-id:in-reply-to:references:from:date:subject:fcc :content-transfer-encoding:mime-version:to:cc; bh=pvIZVxVoxgZLRQGOMV+gC6jnzSY3yK6WsNbKqr3zImY=; b=Z3tTPwYYp/b23dcLFub3Q6bspE0AV+pqdpwXgxkKlvypK6V4VClbGaBeTE4U5m31Kw RLBb1TQFKlgSQRViaLICXeajmHRiy3zPKkp59TF3iZ8ySFwdugw/YYhKWPHc1AgEdVp1 OVODmwMt0tF1wK6tD15gyXp1And/mytIDxRAMpteF5ytcx88Z5uGowQRtdtnrMDaujD/ QKXXxzh39SqZjpuMfBB9B9knxG1CpxyOhN9CWJgb3ZVyAgvi53EdDKWdhdbSdmtysLSD VnYEiPsFN6YuFwrtIfZvQtsrvDNDK2cAgtyn7mOM9K6NrxA8eAYsu6EjNaYjqSA2G5lB s0OQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:message-id:in-reply-to:references:from:date :subject:fcc:content-transfer-encoding:mime-version:to:cc; bh=pvIZVxVoxgZLRQGOMV+gC6jnzSY3yK6WsNbKqr3zImY=; b=uSHc8M0E9DodVM7yWRtl0gu00EwCQD2AkpuODTXZcg1tk/3mOt2zZz4d4YbhxDIB2n ljtBAjIcx0aqzPGUVvHinBdvvWOZKDOmf0/r1RuEtmwrOk8s/UroULhKu7k5f4w/iFcd myv9ouXYnJjylx3uru9nIA/8/xPu5KFBojfqTtQfbHNE9GdvE5VdnGsgteB5XT4KteBm uyZ3MLPqDEhweb4gfPaP0WZ3cWWDstBsnuZ6qmM3Hfx3mlYPaYRNLUfd2ShET8MnwyMs wlorT/Ediwo+M+IPXr9D/x9gdfmCmqN8mwyq8oKkRGvk/GWObgvOk+5TqwqgsFkaCAJD 2sXA== X-Gm-Message-State: AOAM530qf9ZFiVOGqqoPbic4CaF1lmnWfQYoUInNraY6tpN+m9VMKDhX 7TXsEdRcj7TA/LSdPIArRuELPunB4FU= X-Google-Smtp-Source: ABdhPJwyALTzx0ERQ17KSzdoEL4TGbCWFLX6qLjAdYVDyRkn4nc1/Xn6dkM5mNcwoTmg6dy3ml9pPw== X-Received: by 2002:a05:6000:23c:: with SMTP id l28mr13211117wrz.251.1616317136910; Sun, 21 Mar 2021 01:58:56 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id b12sm5225631wrf.39.2021.03.21.01.58.56 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 21 Mar 2021 01:58:56 -0700 (PDT) Message-Id: <2378e3b4c1ae2a38b6cf7d11eea16c5d3c55da74.1616317134.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Sun, 21 Mar 2021 08:58:53 +0000 Subject: [PATCH v2 1/2] [GSOC] commit: add --trailer option Fcc: Sent MIME-Version: 1.0 To: git@vger.kernel.org Cc: "Bradley M. Kuhn" , Junio C Hamano , Brandon Casey , Shourya Shukla , Christian Couder , Rafael Silva , =?utf-8?b?xJBvw6BuIFRy4bqnbiBD?= =?utf-8?b?w7RuZw==?= Danh , Jeff King , =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsA==?= Bjarmason , ZheNing Hu , ZheNing Hu Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: ZheNing Hu From: ZheNing Hu 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 [(=|:)]` option to pass other trailers to `interpret-trailers` and insert them into commit messages. Signed-off-by: ZheNing Hu --- Documentation/git-commit.txt | 14 +- builtin/commit.c | 22 +++ t/t7502-commit-porcelain.sh | 291 +++++++++++++++++++++++++++++++++++ 3 files changed, 326 insertions(+), 1 deletion(-) diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index 17150fa7eabe..3fe7ef33cb07 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -14,7 +14,8 @@ SYNOPSIS [--allow-empty-message] [--no-verify] [-e] [--author=] [--date=] [--cleanup=] [--[no-]status] [-i | -o] [--pathspec-from-file= [--pathspec-file-nul]] - [-S[]] [--] [...] + [(--trailer [(=|:)])...] [-S[]] + [--] [...] DESCRIPTION ----------- @@ -166,6 +167,17 @@ The `-m` option is mutually exclusive with `-c`, `-C`, and `-F`. include::signoff-option.txt[] +--trailer [(=|:)]:: + Specify a (, ) pair that should be applied as a + trailer. (e.g. `git commit --trailer "Signed-off-by:C O Mitter \ + " --trailer "Helped-by:C O Mitter \ + "` will add the "Signed-off-by" trailer + and the "Helped-by" trailer to the commit message.) + The `trailer.*` configuration variables + (linkgit:git-interpret-trailers[1]) can be used to define if + a duplicated trailer is omitted, where in the run of trailers + each trailer would appear, and other 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 739110c5a7f6..4b06672bd07d 100644 --- a/builtin/commit.c +++ b/builtin/commit.c @@ -113,6 +113,7 @@ 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; +static struct strvec trailer_args = STRVEC_INIT; /* * The default commit message cleanup mode will remove the lines @@ -131,6 +132,14 @@ 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) +{ + BUG_ON_OPT_NEG(unset); + + strvec_pushl(&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 +967,18 @@ static int prepare_to_commit(const char *index_file, const char *prefix, fclose(s->fp); + if (trailer_args.nr) { + struct child_process run_trailer = CHILD_PROCESS_INIT; + + strvec_pushl(&run_trailer.args, "interpret-trailers", + "--in-place", git_path_commit_editmsg(), NULL); + strvec_pushv(&run_trailer.args, trailer_args.v); + run_trailer.git_cmd = 1; + if (run_command(&run_trailer)) + die(_("unable to pass trailers to --trailers")); + strvec_clear(&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 +1528,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_F(0, "trailer", NULL, N_("trailer"), N_("add custom trailer(s)"), PARSE_OPT_NONEG, 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")), diff --git a/t/t7502-commit-porcelain.sh b/t/t7502-commit-porcelain.sh index 6396897cc818..74b1602c0ce6 100755 --- a/t/t7502-commit-porcelain.sh +++ b/t/t7502-commit-porcelain.sh @@ -38,6 +38,16 @@ check_summary_oneline() { test_cmp exp act } +trailer_commit_base () { + echo "fun" >>file && + git add file && + git commit -s --trailer "Signed-off-by=C1 E1 " \ + --trailer "Helped-by:C2 E2 " \ + --trailer "Reported-by=C3 E3" \ + --trailer "Mentored-by:C4 E4" \ + -m "hello" +} + test_expect_success 'output summary format' ' echo new >file1 && @@ -154,6 +164,287 @@ test_expect_success 'sign off' ' ' +test_expect_success 'commit --trailer with "="' ' + trailer_commit_base && + cat >expected <<-\EOF && + hello + + Signed-off-by: C O Mitter + Signed-off-by: C1 E1 + Helped-by: C2 E2 + Reported-by: C3 E3 + Mentored-by: C4 E4 + EOF + git cat-file commit HEAD >commit.msg && + sed -e "1,/^\$/d" commit.msg >actual && + test_cmp expected actual +' + +test_expect_success 'commit --trailer with -c and "replace" as ifexists' ' + trailer_commit_base && + cat >expected <<-\EOF && + hello + + Signed-off-by: C O Mitter + Signed-off-by: C1 E1 + Reported-by: C3 E3 + Mentored-by: C4 E4 + Helped-by: C3 E3 + EOF + git -c trailer.ifexists="replace" \ + commit --trailer "Mentored-by: C4 E4" \ + --trailer "Helped-by: C3 E3" \ + --amend && + git cat-file commit HEAD >commit.msg && + sed -e "1,/^\$/d" commit.msg >actual && + test_cmp expected actual +' + +test_expect_success 'commit --trailer with -c and "add" as ifexists' ' + trailer_commit_base && + cat >expected <<-\EOF && + hello + + Signed-off-by: C O Mitter + Signed-off-by: C1 E1 + Helped-by: C2 E2 + Reported-by: C3 E3 + Mentored-by: C4 E4 + Reported-by: C3 E3 + Mentored-by: C4 E4 + EOF + git -c trailer.ifexists="add" \ + commit --trailer "Reported-by: C3 E3" \ + --trailer "Mentored-by: C4 E4" \ + --amend && + git cat-file commit HEAD >commit.msg && + sed -e "1,/^\$/d" commit.msg >actual && + test_cmp expected actual +' + +test_expect_success 'commit --trailer with -c and "donothing" as ifexists' ' + trailer_commit_base && + cat >expected <<-\EOF && + hello + + Signed-off-by: C O Mitter + Signed-off-by: C1 E1 + Helped-by: C2 E2 + Reported-by: C3 E3 + Mentored-by: C4 E4 + Reviewed-by: C6 E6 + EOF + git -c trailer.ifexists="donothing" \ + commit --trailer "Mentored-by: C5 E5" \ + --trailer "Reviewed-by: C6 E6" \ + --amend && + git cat-file commit HEAD >commit.msg && + sed -e "1,/^\$/d" commit.msg >actual && + test_cmp expected actual +' + +test_expect_success 'commit --trailer with -c and "addIfDifferent" as ifexists' ' + trailer_commit_base && + cat >expected <<-\EOF && + hello + + Signed-off-by: C O Mitter + Signed-off-by: C1 E1 + Helped-by: C2 E2 + Reported-by: C3 E3 + Mentored-by: C4 E4 + Mentored-by: C5 E5 + EOF + git -c trailer.ifexists="addIfDifferent" \ + commit --trailer "Reported-by: C3 E3" \ + --trailer "Mentored-by: C5 E5" \ + --amend && + git cat-file commit HEAD >commit.msg && + sed -e "1,/^\$/d" commit.msg >actual && + test_cmp expected actual +' + +test_expect_success 'commit --trailer with -c and "addIfDifferentNeighbor" as ifexists' ' + trailer_commit_base && + cat >expected <<-\EOF && + hello + + Signed-off-by: C O Mitter + Signed-off-by: C1 E1 + Helped-by: C2 E2 + Reported-by: C3 E3 + Mentored-by: C4 E4 + Reported-by: C3 E3 + EOF + git -c trailer.ifexists="addIfDifferentNeighbor" \ + commit --trailer "Mentored-by: C4 E4" \ + --trailer "Reported-by: C3 E3" \ + --amend && + git cat-file commit HEAD >commit.msg && + sed -e "1,/^\$/d" commit.msg >actual && + test_cmp expected actual +' + +test_expect_success 'commit --trailer with -c and "end" as where' ' + trailer_commit_base && + cat >expected <<-\EOF && + hello + + Signed-off-by: C O Mitter + Signed-off-by: C1 E1 + Helped-by: C2 E2 + Reported-by: C3 E3 + Mentored-by: C4 E4 + Reported-by: C3 E3 + Mentored-by: C4 E4 + EOF + git -c trailer.where="end" \ + commit --trailer "Reported-by: C3 E3" \ + --trailer "Mentored-by: C4 E4" \ + --amend && + git cat-file commit HEAD >commit.msg && + sed -e "1,/^\$/d" commit.msg >actual && + test_cmp expected actual +' + +test_expect_success 'commit --trailer with -c and "start" as where' ' + trailer_commit_base && + cat >expected <<-\EOF && + hello + + Signed-off-by: C1 E1 + Signed-off-by: C O Mitter + Signed-off-by: C1 E1 + Helped-by: C2 E2 + Reported-by: C3 E3 + Mentored-by: C4 E4 + EOF + git -c trailer.where="start" \ + commit --trailer "Signed-off-by: C O Mitter " \ + --trailer "Signed-off-by: C1 E1" \ + --amend && + git cat-file commit HEAD >commit.msg && + sed -e "1,/^\$/d" commit.msg >actual && + test_cmp expected actual +' + +test_expect_success 'commit --trailer with -c and "after" as where' ' + trailer_commit_base && + cat >expected <<-\EOF && + hello + + Signed-off-by: C O Mitter + Signed-off-by: C1 E1 + Helped-by: C2 E2 + Reported-by: C3 E3 + Mentored-by: C4 E4 + Mentored-by: C5 E5 + EOF + git -c trailer.where="after" \ + commit --trailer "Mentored-by: C4 E4" \ + --trailer "Mentored-by: C5 E5" \ + --amend && + git cat-file commit HEAD >commit.msg && + sed -e "1,/^\$/d" commit.msg >actual && + test_cmp expected actual +' + +test_expect_success 'commit --trailer with -c and "before" as where' ' + trailer_commit_base && + cat >expected <<-\EOF && + hello + + Signed-off-by: C O Mitter + Signed-off-by: C1 E1 + Helped-by: C2 E2 + Reported-by: C3 E3 + Mentored-by: C2 E2 + Mentored-by: C3 E3 + Mentored-by: C4 E4 + EOF + git -c trailer.where="before" \ + commit --trailer "Mentored-by: C3 E3" \ + --trailer "Mentored-by: C2 E2" \ + --amend && + git cat-file commit HEAD >commit.msg && + sed -e "1,/^\$/d" commit.msg >actual && + test_cmp expected actual +' + +test_expect_success 'commit --trailer with -c and "donothing" as ifmissing' ' + trailer_commit_base && + cat >expected <<-\EOF && + hello + + Signed-off-by: C O Mitter + Signed-off-by: C1 E1 + Helped-by: C2 E2 + Reported-by: C3 E3 + Mentored-by: C4 E4 + Helped-by: C5 E5 + EOF + git -c trailer.ifmissing="donothing" \ + commit --trailer "Helped-by: C5 E5" \ + --trailer "Based-by: C6 E6" \ + --amend && + git cat-file commit HEAD >commit.msg && + sed -e "1,/^\$/d" commit.msg >actual && + test_cmp expected actual +' + +test_expect_success 'commit --trailer with -c and "add" as ifmissing' ' + trailer_commit_base && + cat >expected <<-\EOF && + hello + + Signed-off-by: C O Mitter + Signed-off-by: C1 E1 + Helped-by: C2 E2 + Reported-by: C3 E3 + Mentored-by: C4 E4 + Helped-by: C5 E5 + Based-by: C6 E6 + EOF + git -c trailer.ifmissing="add" \ + commit --trailer "Helped-by: C5 E5" \ + --trailer "Based-by: C6 E6" \ + --amend && + git cat-file commit HEAD >commit.msg && + sed -e "1,/^\$/d" commit.msg >actual && + test_cmp expected actual +' + +test_expect_success 'commit --trailer with -c ack.key ' ' + echo "fun" >>file1 && + git add file1 && + cat >expected <<-\EOF && + hello + + Acked-by: Peff + EOF + git -c trailer.ack.key="Acked-by" \ + commit --trailer "ack = Peff" -m "hello" && + git cat-file commit HEAD >commit.msg && + sed -e "1,/^\$/d" commit.msg >actual && + test_cmp expected actual +' + +test_expect_success 'commit --trailer with -c and ":=#" as separators' ' + echo "fun" >>file1 && + git add file1 && + cat >expected <<-\EOF && + I hate bug + + Bug #42 + EOF + git -c trailer.separators=":=#" \ + -c trailer.bug.key="Bug #" \ + commit --trailer "bug = 42" -m "I hate bug" && + git cat-file commit HEAD >commit.msg && + sed -e "1,/^\$/d" commit.msg >actual && + test_cmp expected actual +' + test_expect_success 'multiple -m' ' >negative && From patchwork Sun Mar 21 08:58:54 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: ZheNing Hu X-Patchwork-Id: 12152933 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-12.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 90645C433C1 for ; Sun, 21 Mar 2021 08:59:51 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 558D461930 for ; Sun, 21 Mar 2021 08:59:51 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229996AbhCUI7N (ORCPT ); Sun, 21 Mar 2021 04:59:13 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:35326 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229901AbhCUI67 (ORCPT ); Sun, 21 Mar 2021 04:58:59 -0400 Received: from mail-wr1-x430.google.com (mail-wr1-x430.google.com [IPv6:2a00:1450:4864:20::430]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id B5CD3C061762 for ; Sun, 21 Mar 2021 01:58:58 -0700 (PDT) Received: by mail-wr1-x430.google.com with SMTP id 61so13444811wrm.12 for ; Sun, 21 Mar 2021 01:58:58 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=message-id:in-reply-to:references:from:date:subject:fcc :content-transfer-encoding:mime-version:to:cc; bh=XV+6WLkOn05a8uhswC+WThR2PIVf47WbU96Bo3Y6SIw=; b=ALDstTI2ObCUurzLJ/miGYDn+JaReroWHSQ2D/XjJubqHw52lbospZ8XkLSXVieRbN fY6cEgUCZ7OuMvlVRN0st0o8gLx26R4idRBmmB1V/KjDtns+PVmH+jk37SjH/sP+0GCU hZrfY9j9JJ+YFkDs9ERIhj0ftM7omgrbxFGZuYuFKBRHPVua6DUNbLvAFPUNH6bCaRV4 T+7Lb7Tlr2OMlD0GmKYUfmleyhHm9ckQtGkJCdeLq9cn8pXUQa9c3OwjFPTe/A10lFxe /4dg8HCE/rUHG2DoPX2uewXv2T3n+VvOAbDWTYea5Fzu/iFeXV5/PSEWoAaCghSIDKcd ohVg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:message-id:in-reply-to:references:from:date :subject:fcc:content-transfer-encoding:mime-version:to:cc; bh=XV+6WLkOn05a8uhswC+WThR2PIVf47WbU96Bo3Y6SIw=; b=iBIaocEWqo7wLZJj1SEaBwdMlEnui6T4PaYHpfeS7f960o4XZTpoZImPHrGOoJECDB YB2BWsU/IwJ95RQT73WT9el+HHYEMrs2RHiIxnjmPPKkeXD5QhdIukQiQcclExhED51T pPV1xRE2iNb/aK/dzhSyofB0Ea8qt0cjWsLOdVwZc+Sm6LMyh4EQagmGQy69B1btAdFe OnSEq/qXR30qMZV0CVuQeMpzwoowwQ/jfMHnd4C1e+VKM6JnWl6J2RzRpo2A2a9DzEV3 oD+f+W4wBi7XmM6o/S1Iczw515e8LeEyRmQVpptjYWhlgrp5awHNVt4rtZtG/s+1ZNr9 Flkw== X-Gm-Message-State: AOAM531vXn3xqQ1T0N0W764I+k3ZID0PPHrhptHlCsMV/4kv6fEE2Tji 5UVsfYhpPnpqVJZO8SK7N09GqnbosD8= X-Google-Smtp-Source: ABdhPJxBcRDXgj0Oe0w5Vwox/r8gfqCb9NhXGQbcmcqCpNu7ry7gR2yP1QV/n4J7/Ae3QXw4Osq0GA== X-Received: by 2002:a05:6000:1b0f:: with SMTP id f15mr12898592wrz.171.1616317137494; Sun, 21 Mar 2021 01:58:57 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id j20sm12485270wmp.30.2021.03.21.01.58.57 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 21 Mar 2021 01:58:57 -0700 (PDT) Message-Id: <8b8b236a4ffb81a8c6be3f320b878cea1d0f9d7a.1616317135.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Sun, 21 Mar 2021 08:58:54 +0000 Subject: [PATCH v2 2/2] [GSOC] interpret-trailer: easy parse trailer value Fcc: Sent MIME-Version: 1.0 To: git@vger.kernel.org Cc: "Bradley M. Kuhn" , Junio C Hamano , Brandon Casey , Shourya Shukla , Christian Couder , Rafael Silva , =?utf-8?b?xJBvw6BuIFRy4bqnbiBD?= =?utf-8?b?w7RuZw==?= Danh , Jeff King , =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsA==?= Bjarmason , ZheNing Hu , ZheNing Hu Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: ZheNing Hu From: ZheNing Hu The original `-trailer` adding some trailers like "Signed-off-by:C O " is often too verbose and error-prone. Now add the syntax parse for the value of `--trailer`: e.g. "Signed-off-by:@Junio", git will fuzzy search in the commit history to find the latest one commit which matches `--author=Junio`, and get the "author " pair `Junio C Hamano ` as the value of `--trailer`, it will be a easy way to add trailers. git commit --trailer` can also benefit from this. Signed-off-by: ZheNing Hu Helped-by: Junio C Hamano Helped-by: Jeff King Signed-off-by: Linus Torvalds --- Documentation/git-interpret-trailers.txt | 23 ++++++++++++++++ builtin/commit.c | 33 ----------------------- commit.c | 34 ++++++++++++++++++++++++ commit.h | 10 +++++++ t/t7502-commit-porcelain.sh | 28 +++++++++++++++++++ t/t7513-interpret-trailers.sh | 23 ++++++++++++++++ trailer.c | 13 ++++++++- 7 files changed, 130 insertions(+), 34 deletions(-) diff --git a/Documentation/git-interpret-trailers.txt b/Documentation/git-interpret-trailers.txt index 96ec6499f001..33e76f2a58fb 100644 --- a/Documentation/git-interpret-trailers.txt +++ b/Documentation/git-interpret-trailers.txt @@ -69,6 +69,29 @@ Note that 'trailers' do not follow and are not intended to follow many rules for RFC 822 headers. For example they do not follow the encoding rules and probably many other rules. +Support to replace the value in the form of `@nickname`, provided that the +commit with nickname as the author can be found in the your repository's git +log. For example, in git's source code repository you can use commands: + +`git log --author="Junio" --pretty="%an <%ae>" | sort |uniq ` + +to find Junio's "name " pair: + +Junio C Hamano +Junio C Hamano +Junio C Hamano +Junio C Hamano +... + +If you want to add a `Helped-by` trailer with Junio "name " pair, +you can use: + +`git commit --trailers "Helped-by:@Junio"` + +to insert the trailer to your commit messages: + +Helped-by: Junio C Hamano + OPTIONS ------- --in-place:: diff --git a/builtin/commit.c b/builtin/commit.c index 4b06672bd07d..58c020e3cfbf 100644 --- a/builtin/commit.c +++ b/builtin/commit.c @@ -1043,39 +1043,6 @@ static int prepare_to_commit(const char *index_file, const char *prefix, return 1; } -static const char *find_author_by_nickname(const char *name) -{ - struct rev_info revs; - struct commit *commit; - struct strbuf buf = STRBUF_INIT; - struct string_list mailmap = STRING_LIST_INIT_NODUP; - const char *av[20]; - int ac = 0; - - repo_init_revisions(the_repository, &revs, NULL); - strbuf_addf(&buf, "--author=%s", name); - av[++ac] = "--all"; - av[++ac] = "-i"; - av[++ac] = buf.buf; - av[++ac] = NULL; - setup_revisions(ac, av, &revs, NULL); - revs.mailmap = &mailmap; - read_mailmap(revs.mailmap); - - if (prepare_revision_walk(&revs)) - die(_("revision walk setup failed")); - commit = get_revision(&revs); - if (commit) { - struct pretty_print_context ctx = {0}; - ctx.date_mode.type = DATE_NORMAL; - strbuf_release(&buf); - format_commit_message(commit, "%aN <%aE>", &buf, &ctx); - clear_mailmap(&mailmap); - return strbuf_detach(&buf, NULL); - } - die(_("--author '%s' is not 'Name ' and matches no existing author"), name); -} - static void handle_ignored_arg(struct wt_status *s) { if (!ignored_arg) diff --git a/commit.c b/commit.c index 6ccd774841c6..e1aad52d2c4f 100644 --- a/commit.c +++ b/commit.c @@ -21,6 +21,7 @@ #include "commit-reach.h" #include "run-command.h" #include "shallow.h" +#include "mailmap.h" static struct commit_extra_header *read_commit_extra_header_lines(const char *buf, size_t len, const char **); @@ -1703,3 +1704,36 @@ int run_commit_hook(int editor_is_used, const char *index_file, return ret; } + +const char *find_author_by_nickname(const char *name) +{ + struct rev_info revs; + struct commit *commit; + struct strbuf buf = STRBUF_INIT; + struct string_list mailmap = STRING_LIST_INIT_NODUP; + const char *av[20]; + int ac = 0; + + repo_init_revisions(the_repository, &revs, NULL); + strbuf_addf(&buf, "--author=%s", name); + av[++ac] = "--all"; + av[++ac] = "-i"; + av[++ac] = buf.buf; + av[++ac] = NULL; + setup_revisions(ac, av, &revs, NULL); + revs.mailmap = &mailmap; + read_mailmap(revs.mailmap); + + if (prepare_revision_walk(&revs)) + die(_("revision walk setup failed")); + commit = get_revision(&revs); + if (commit) { + struct pretty_print_context ctx = {0}; + ctx.date_mode.type = DATE_NORMAL; + strbuf_release(&buf); + format_commit_message(commit, "%aN <%aE>", &buf, &ctx); + clear_mailmap(&mailmap); + return strbuf_detach(&buf, NULL); + } + die(_("--author '%s' is not 'Name ' and matches no existing author"), name); +} diff --git a/commit.h b/commit.h index 49c0f503964e..cb9f7cd13f09 100644 --- a/commit.h +++ b/commit.h @@ -370,5 +370,15 @@ int parse_buffer_signed_by_header(const char *buffer, struct strbuf *payload, struct strbuf *signature, const struct git_hash_algo *algop); +/* + * Calling `find_author_by_nickname` to find the "author " pair + * in the most recent commit which matches "--author=name". + * + * Note that `find_author_by_nickname` is not reusable, because it haven't + * reset flags for parsed objects. The only safe way to use `find_author_by_nickname` + * (without rewriting the revision traversal machinery) is to spawn a + * subprocess and do find_author_by_nickname() in it. + */ +const char *find_author_by_nickname(const char *name); #endif /* COMMIT_H */ diff --git a/t/t7502-commit-porcelain.sh b/t/t7502-commit-porcelain.sh index 74b1602c0ce6..143690e2833c 100755 --- a/t/t7502-commit-porcelain.sh +++ b/t/t7502-commit-porcelain.sh @@ -445,6 +445,34 @@ test_expect_success 'commit --trailer with -c and ":=#" as separators' ' test_cmp expected actual ' + +test_expect_success 'commit --trailer parse @nickname' ' + echo "I love git" >file1 && + git add file1 && + git commit -m "yly" --author="batman " && + echo "I love git" >file2 && + git add file2 && + git commit -m "yly" --author="jocker " && + echo "I love git" >file3 && + git add file3 && + git commit -m "yly" \ + --trailer "Reviewed-by:@bat" \ + --trailer "Signed-off-by:@jock" \ + --trailer "Helped-by:@email1" \ + --trailer "Mentored-by:@email2" && + git cat-file commit HEAD >commit.msg && + sed -e "1,/^\$/d" commit.msg >actual && + cat >expected <<-\EOF && + yly + + Reviewed-by: batman + Signed-off-by: jocker + Helped-by: batman + Mentored-by: jocker + EOF + test_cmp expected actual +' + test_expect_success 'multiple -m' ' >negative && diff --git a/t/t7513-interpret-trailers.sh b/t/t7513-interpret-trailers.sh index 6602790b5f4c..f2f1ae3b2faf 100755 --- a/t/t7513-interpret-trailers.sh +++ b/t/t7513-interpret-trailers.sh @@ -63,6 +63,29 @@ test_expect_success 'without config' ' test_cmp expected actual ' +test_expect_success 'trailer parse @nickname' ' + echo "I love git" >file1 && + git add file1 && + git commit -m "yly" --author="batman " && + echo "I love git" >file2 && + git add file2 && + git commit -m "yly" --author="jocker " && + git interpret-trailers \ + --trailer "Reviewed-by:@bat" \ + --trailer "Signed-off-by:@jock" \ + --trailer "Helped-by:@email1" \ + --trailer "Mentored-by:@email2" \ + empty >actual && + cat >expected <<-\EOF && + + Reviewed-by: batman + Signed-off-by: jocker + Helped-by: batman + Mentored-by: jocker + EOF + test_cmp expected actual +' + test_expect_success 'without config in another order' ' sed -e "s/ Z\$/ /" >expected <<-\EOF && diff --git a/trailer.c b/trailer.c index 249ed618ed8e..21f367e7b761 100644 --- a/trailer.c +++ b/trailer.c @@ -6,6 +6,7 @@ #include "tempfile.h" #include "trailer.h" #include "list.h" +#include "revision.h" /* * Copyright (c) 2013, 2014 Christian Couder */ @@ -633,11 +634,21 @@ static void parse_trailer(struct strbuf *tok, struct strbuf *val, struct arg_item *item; size_t tok_len; struct list_head *pos; + const char *ae = NULL; if (separator_pos != -1) { strbuf_add(tok, trailer, separator_pos); strbuf_trim(tok); - strbuf_addstr(val, trailer + separator_pos + 1); + if (trailer[separator_pos + 1] == '@') { + ae = find_author_by_nickname(trailer + separator_pos + 2); + reset_revision_walk(); + if (ae) { + strbuf_addstr(val, ae); + free((char*)ae); + } else + strbuf_addstr(val, trailer + separator_pos + 1); + } else + strbuf_addstr(val, trailer + separator_pos + 1); strbuf_trim(val); } else { strbuf_addstr(tok, trailer);