From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on dcvr.yhbt.net X-Spam-Level: X-Spam-Status: No, score=-3.8 required=3.0 tests=AWL,BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,RCVD_IN_DNSWL_HI, SPF_HELO_PASS,SPF_PASS shortcircuit=no autolearn=ham autolearn_force=no version=3.4.2 Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by dcvr.yhbt.net (Postfix) with ESMTP id 9927F1F9FD for ; Mon, 15 Mar 2021 03:25:50 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229679AbhCODZP (ORCPT ); Sun, 14 Mar 2021 23:25:15 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:49318 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229607AbhCODYz (ORCPT ); Sun, 14 Mar 2021 23:24:55 -0400 Received: from mail-wm1-x330.google.com (mail-wm1-x330.google.com [IPv6:2a00:1450:4864:20::330]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 0E1FCC061574 for ; Sun, 14 Mar 2021 20:24:55 -0700 (PDT) Received: by mail-wm1-x330.google.com with SMTP id g20so7264465wmk.3 for ; Sun, 14 Mar 2021 20:24:54 -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=2y0lUcWDnREUTe/FILrkms+9FzKIgLn8eIZvRo0vqEQ=; b=Z64YA0m8TMkh+AVCN108+z7+2ipd1UaGpD3V54D1XNkafPcCtJEQi6Lvlw8m2NIZg/ uv2+GMX3H+OaeiHpxEDpLvn1OZ1yfFcG4oc6g8uCwKyGlO5e28nlsBnteWrvjbxoUb40 9x90oZehquNhr8RI+1k5fZduCoxlrK3fnxEZzCtohGt23aDcbc3ed/3L9xZ9MVZl8Dqi AbDfmF6bd6Kxuo7MECXjwpxrXALk/dB4/UvF1lcrqc7HXOHyYRMmp91hY1+dCJ+iHt5b PtRNrWPRcXjpwawztPn2RLPsH2idz7UvvWxcWI2kQFgY+wN5gBOpFyPZ5KkD3cXGBqYM cwDA== 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=2y0lUcWDnREUTe/FILrkms+9FzKIgLn8eIZvRo0vqEQ=; b=cXLBYWxrpSEeEbdNkqxarzNoODko+WwPBXnLH4eISZK1+80pKlvOBDOfPJbNn3ilBv Y1fedyOC9rljk0RQzkpSJ2NovMFrJ5wDRldyKg7Ka8gAUJih3Vlz4ZDONtxF37Zhs2k8 b6BxD5xW87SQXh/vMFysAn45XCDw/Ph1VoFBI2n7zKAlVtK9iA83CYldJapX5nX/X4GH EzubIZKwWyO1lEAsOy66q+UicXaQFDoKyXiYVsk+JTWlCrPUfz3oybq7gNT8JFqKSWIM ALf9D8PCNrn3Tq/UVZ8bGa7vMoaiVz6HWpXzOWS+lBy+p9jruFKG3/nnOzwX9L+zckqZ M7PQ== X-Gm-Message-State: AOAM531eF0sl8wjZzfjjkHPzeBcb+MM0VCBg7sjAZezQXcA5gNufc0xN rlJekpWwQu1Yl/fM2SyQoZtQyNEhvNA= X-Google-Smtp-Source: ABdhPJx9XDVnZy150900PPWZb6SUZL7nDKZy8XEWP0J/FukYeXkUwwNuo6FkdnwLTmuQQerzdHArFw== X-Received: by 2002:a7b:c096:: with SMTP id r22mr23923672wmh.102.1615778693798; Sun, 14 Mar 2021 20:24:53 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id c26sm17733854wrb.87.2021.03.14.20.24.53 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 14 Mar 2021 20:24:53 -0700 (PDT) Message-Id: In-Reply-To: References: From: "ZheNing Hu via GitGitGadget" Date: Mon, 15 Mar 2021 03:24:52 +0000 Subject: [PATCH v5] [GSOC] commit: add --trailer option Fcc: Sent Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit MIME-Version: 1.0 To: git@vger.kernel.org Cc: "Bradley M. Kuhn" , Junio C Hamano , Brandon Casey , Shourya Shukla , Christian Couder , Rafael Silva , ZheNing Hu , ZheNing Hu Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org 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 --- [GSOC] commit: add --trailer option Now maintainers or developers can also use commit --trailer="Signed-off-by:commiter" 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-v5 Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-901/adlternative/commit-with-multiple-signatures-v5 Pull-Request: https://github.com/gitgitgadget/git/pull/901 Range-diff vs v4: 1: dc507553ef4f ! 1: ca91accb2852 [GSOC] commit: add --trailer option @@ builtin/commit.c: static int config_commit_verbose = -1; /* unspecified */ 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; ++struct strvec trailer_args = STRVEC_INIT; +static const char *trailer; /* @@ builtin/commit.c: static struct strbuf message = STRBUF_INIT; +static int opt_pass_trailer(const struct option *opt, const char *arg, int unset) +{ + if (unset) { -+ strvec_clear(&run_trailer.args); ++ strvec_clear(&trailer_args); + return -1; + } -+ strvec_pushl(&run_trailer.args, "--trailer", arg, NULL); ++ strvec_pushl(&trailer_args, "--trailer", arg, NULL); + return 0; +} + @@ builtin/commit.c: static int prepare_to_commit(const char *index_file, const cha fclose(s->fp); -+ if (run_trailer.args.nr != 4) { ++ if (trailer_args.nr) { ++ strvec_pushl(&run_trailer.args, "interpret-trailers", ++ "--in-place", "--where=end", git_path_commit_editmsg(), NULL); ++ strvec_pushv(&run_trailer.args, trailer_args.v); + run_trailer.git_cmd = 1; -+ run_command(&run_trailer); -+ } else -+ strvec_clear(&run_trailer.args); ++ if (run_command(&run_trailer)) ++ strvec_clear(&run_trailer.args); ++ strvec_clear(&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 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")), -@@ builtin/commit.c: 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); ## t/t7502-commit-porcelain.sh ## @@ t/t7502-commit-porcelain.sh: test_expect_success 'sign off' ' Documentation/git-commit.txt | 9 ++++++++- builtin/commit.c | 24 ++++++++++++++++++++++++ t/t7502-commit-porcelain.sh | 20 ++++++++++++++++++++ 3 files changed, 52 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=] [--date=] [--cleanup=] [--[no-]status] [-i | -o] [--pathspec-from-file= [--pathspec-file-nul]] - [-S[]] [--] [...] + [-S[]] [--] [...] [(--trailer [(=|:)])...] DESCRIPTION ----------- @@ -166,6 +166,13 @@ 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" 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..24fccb561398 100644 --- a/builtin/commit.c +++ b/builtin/commit.c @@ -113,6 +113,9 @@ 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; +struct strvec trailer_args = STRVEC_INIT; +static const char *trailer; /* * The default commit message cleanup mode will remove the lines @@ -131,6 +134,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(&trailer_args); + return -1; + } + 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 +971,16 @@ static int prepare_to_commit(const char *index_file, const char *prefix, fclose(s->fp); + if (trailer_args.nr) { + strvec_pushl(&run_trailer.args, "interpret-trailers", + "--in-place", "--where=end", git_path_commit_editmsg(), NULL); + strvec_pushv(&run_trailer.args, trailer_args.v); + run_trailer.git_cmd = 1; + if (run_command(&run_trailer)) + strvec_clear(&run_trailer.args); + 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 +1530,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")), 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 " \ + --trailer "Helped-by:C O Mitter2 " \ + --trailer "Reported-by:C O Mitter3 " \ + --trailer "Mentored-by:C O Mitter4 " \ + -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 + Signed-off-by: C O Mitter1 + Helped-by: C O Mitter2 + Reported-by: C O Mitter3 + Mentored-by: C O Mitter4 + EOF + test_cmp expected actual +' + test_expect_success 'multiple -m' ' >negative && base-commit: 13d7ab6b5d7929825b626f050b62a11241ea4945 -- gitgitgadget