Re: [PATCH v10 1/3] [GSOC] commit: add --trailer option

[ZheNing Hu <adlternative@gmail.com>]

Đoàn Trần Công Danh <congdanhqx@gmail.com> 于2021年3月19日周五 上午12:29写道：
>
> On 2021-03-18 11:15:54+0000, ZheNing Hu via GitGitGadget <gitgitgadget@gmail.com> wrote:
> > From: ZheNing Hu <adlternative@gmail.com>
> >
> > 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 <token>[(=|:)<value>]` option to pass
> > other trailers to `interpret-trailers` and insert them into commit
> > messages.
> >
> > Signed-off-by: ZheNing Hu <adlternative@gmail.com>
> > ---
> >  Documentation/git-commit.txt |  10 +-
> >  builtin/commit.c             |  23 +++
> >  t/t7502-commit-porcelain.sh  | 336 +++++++++++++++++++++++++++++++++++
> >  3 files changed, 368 insertions(+), 1 deletion(-)
> >
> > diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
> > index 17150fa7eabe..c5de981cd40d 100644
> > --- a/Documentation/git-commit.txt
> > +++ b/Documentation/git-commit.txt
> > @@ -14,7 +14,7 @@ SYNOPSIS
> >          [--allow-empty-message] [--no-verify] [-e] [--author=<author>]
> >          [--date=<date>] [--cleanup=<mode>] [--[no-]status]
> >          [-i | -o] [--pathspec-from-file=<file> [--pathspec-file-nul]]
> > -        [-S[<keyid>]] [--] [<pathspec>...]
> > +        [-S[<keyid>]] [--] [<pathspec>...] [(--trailer <token>[(=|:)<value>])...]
>
> Please move all options before non-option arguments.
> In other words, please move --trailer before [--].
>
> This form implies that there are no way to specify pathspec "--trailer"

Thanks, I didn't pay attention to this little detail before.

>
> >
> >  DESCRIPTION
> >  -----------
> > @@ -166,6 +166,14 @@ The `-m` option is mutually exclusive with `-c`, `-C`, and `-F`.
> >
> >  include::signoff-option.txt[]
> >
> > +--trailer <token>[(=|:)<value>]::
> > +     Specify a (<token>, <value>) pair that should be applied as a
> > +     trailer. (e.g. `git commit --trailer "Signed-off-by:C O Mitter \
> > +     <committer@example.com>" --trailer "Helped-by:C O Mitter \
> > +     <committer@example.com>"` will add the "Signed-off-by" trailer
> > +     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.
> >  -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..7a79aae48f43 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,19 @@ 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 tailers to --trailers"));
>
> s/tailers/trailers/ perhap?
> Also we usually not put {} around single statement.
>

OK.

> > +             }
> > +             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 +1529,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..6df71fa00bcb 100755
> > --- a/t/t7502-commit-porcelain.sh
> > +++ b/t/t7502-commit-porcelain.sh
> > @@ -154,6 +154,342 @@ test_expect_success 'sign off' '
> >
> >  '
> >
> > +test_expect_success 'commit --trailer without -c' '
> > +     echo "fun" >>file &&
> > +     git add file &&
> > +     cat >expected <<-\EOF &&
> > +
> > +     Signed-off-by: C O Mitter <committer@example.com>
> > +     Signed-off-by: C1 E1
> > +     Helped-by: C2 E2
> > +     Reported-by: C3 E3
> > +     Mentored-by: C4 E4
> > +     EOF
> > +     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" &&
>
> It's documented that we're supporting --trailer <token>[(=|:)<value>]
> However, only --trailer <token>:<value> is tested.
> I think it's better to have
>
>         --trailer "Helped-by=C2 E2" --trailer "Reported-by"
>

In fact, I want to test in `test_expect_success'commit --trailer with
-c and "=" as separators'`,
but some changes are needed.

>
> --
> Danh

-- 
ZheNing Hu