From patchwork Sat Mar 20 14:41:38 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: ZheNing Hu X-Patchwork-Id: 12152517 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.7 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,URIBL_BLOCKED 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 A3071C433E0 for ; Sat, 20 Mar 2021 14:42:47 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 6A2B861978 for ; Sat, 20 Mar 2021 14:42:47 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229990AbhCTOmQ (ORCPT ); Sat, 20 Mar 2021 10:42:16 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:55900 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229945AbhCTOln (ORCPT ); Sat, 20 Mar 2021 10:41:43 -0400 Received: from mail-wm1-x32c.google.com (mail-wm1-x32c.google.com [IPv6:2a00:1450:4864:20::32c]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id AB59DC061763 for ; Sat, 20 Mar 2021 07:41:42 -0700 (PDT) Received: by mail-wm1-x32c.google.com with SMTP id 12so6964817wmf.5 for ; Sat, 20 Mar 2021 07:41:42 -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=vZt/+t9l9oG+sR6gIJ8aQSNoUZ4uRp47zepH4JSEPOc=; b=mKh9IpuBHrmEqagRokQX6xWRhX2DB8e2pj946zftQkq5xNwxK6emd0muDGKKGVWbes 6siur1YwMQ+2OLRfaX3IwR43pboOAsXfQHYZ11jnoZlgHfy46KMD5r10LGYm3s9yGTv7 qGKB3k7nLfzAG2x4BVAtRUh1jHCwVvw9CElB2dpGKgVkPoT1wHo9RqulWlGIAfcDxNrb rFQ2pwZ6EXPuHaWRG23KXEfuDjfcupbKn1UjqLbpasH0zLdVeEIsnX1S/SIWaMzprLKD JG8rpOD63Jmq9QBhdLYJGKpGs3/6m586POHUK1VO46HpbMQaVsQUcBJevp9UZV/We648 4YqA== 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=vZt/+t9l9oG+sR6gIJ8aQSNoUZ4uRp47zepH4JSEPOc=; b=WnXF+HZQUhiuuEHz95Shs/pHC9GGP4iLkCQsrvfPz/79D4h6nDGNlD84bPfPmrnpKR CC9XIZq2cpAer1AA84vgfTFEtafpKAaJyH3jEGCN2tzw1EjtYiPM2qi259pAemuczwkU kEQ9nUyeGMkqW8tquhR4ASPV+YG5IUgL1Yy5Mdes8veWnpY9BsbwiV8Sqb7b3XoTb9g7 4sTBXqeyIY3HVxMSMesp5z9iorVa+zhQHZLp+fWfv0zOo3ldERYzGr4Aafjxp2YzLCKA 9fyTjA30zeWcNV+juxcX/RovfXoaH57voKofT+I3bmL6Qy4ay8PWBMHagML+FqaiTliQ 1oyA== X-Gm-Message-State: AOAM532Th18GCIStENoFdzQ3Kx9XNCBITTNIBNMSWz6UHulvqMRO0JYp DMCP2igXDxdEu1iNULukUXmuHND9unY= X-Google-Smtp-Source: ABdhPJzZOt8c5RjUik0Msgp5R7ft4hjEyHN5q6zLRHbHDhRxeAFuo5XbYA08xgSUSuPbUnrhibnVzw== X-Received: by 2002:a1c:f20e:: with SMTP id s14mr8190072wmc.100.1616251301435; Sat, 20 Mar 2021 07:41:41 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id v13sm14725798wrt.45.2021.03.20.07.41.41 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 20 Mar 2021 07:41:41 -0700 (PDT) Message-Id: In-Reply-To: References: Date: Sat, 20 Mar 2021 14:41:38 +0000 Subject: [PATCH 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 --- Documentation/git-interpret-trailers.txt | 23 ++++++++++++++++ builtin/commit.c | 33 ----------------------- commit.c | 34 ++++++++++++++++++++++++ commit.h | 2 ++ t/t7502-commit-porcelain.sh | 28 +++++++++++++++++++ t/t7513-interpret-trailers.sh | 23 ++++++++++++++++ trailer.c | 13 ++++++++- 7 files changed, 122 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..970a73ccd5be 100644 --- a/commit.h +++ b/commit.h @@ -371,4 +371,6 @@ int parse_buffer_signed_by_header(const char *buffer, struct strbuf *signature, const struct git_hash_algo *algop); +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);