From b84d01393679d0e09d6fd198e771f2d1f5563986 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Mon, 29 Aug 2022 14:38:35 -0700 Subject: [PATCH 1/3] pretty: separate out the logic to decide the use of in-body from When pretty-printing the log message for a given commit in the e-mail format (e.g. "git format-patch"), we add an in-body "From:" header when the author identity of the commit is different from the identity of the person whose identity appears in the header of the e-mail (the latter is passed with them "--from" option). Split out the logic into a helper function, as we would want to extend the condition further. Signed-off-by: Junio C Hamano --- pretty.c | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/pretty.c b/pretty.c index 6d819103fb..cf418a6b20 100644 --- a/pretty.c +++ b/pretty.c @@ -477,6 +477,14 @@ end: } } +static int use_in_body_from(const struct pretty_print_context *pp, + const struct ident_split *ident) +{ + if (ident_cmp(pp->from_ident, ident)) + return 1; + return 0; +} + void pp_user_info(struct pretty_print_context *pp, const char *what, struct strbuf *sb, const char *line, const char *encoding) @@ -503,7 +511,7 @@ void pp_user_info(struct pretty_print_context *pp, map_user(pp->mailmap, &mailbuf, &maillen, &namebuf, &namelen); if (cmit_fmt_is_mail(pp->fmt)) { - if (pp->from_ident && ident_cmp(pp->from_ident, &ident)) { + if (pp->from_ident && use_in_body_from(pp, &ident)) { struct strbuf buf = STRBUF_INIT; strbuf_addstr(&buf, "From: "); From 34bc1b1045af6ad813f4de662a453b3c77ba65a7 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Mon, 29 Aug 2022 14:38:36 -0700 Subject: [PATCH 2/3] format-patch: allow forcing the use of in-body From: header Users may be authoring and committing their commits under the same e-mail address they use to send their patches from, in which case they shouldn't need to use the in-body From: line in their outgoing e-mails. At the receiving end, "git am" will use the address on the "From:" header of the incoming e-mail and all should be well. Some mailing lists, however, mangle the From: address from what the original sender had; in such a situation, the user may want to add the in-body "From:" header even for their own patches. "git format-patch --[no-]force-in-body-from" was invented for such users. Signed-off-by: Junio C Hamano --- Documentation/git-format-patch.txt | 9 +++++++++ builtin/log.c | 5 +++++ pretty.c | 2 ++ revision.h | 1 + t/t4014-format-patch.sh | 13 +++++++++++++ 5 files changed, 30 insertions(+) diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt index be797d7a28..7c7f244e57 100644 --- a/Documentation/git-format-patch.txt +++ b/Documentation/git-format-patch.txt @@ -275,6 +275,15 @@ header). Note also that `git send-email` already handles this transformation for you, and this option should not be used if you are feeding the result to `git send-email`. +--[no-]force-in-body-from:: + With the e-mail sender specified via the `--from` option, by + default, an in-body "From:" to identify the real author of + the commit is added at the top of the commit log message if + the sender is different from the author. With this option, + the in-body "From:" is added even when the sender and the + author have the same name and address, which may help if the + mailing list software mangles the sender's identity. + --add-header=
:: Add an arbitrary header to the email headers. This is in addition to any configured headers, and may be used multiple times. diff --git a/builtin/log.c b/builtin/log.c index 9b937d59b8..78ccd37bd9 100644 --- a/builtin/log.c +++ b/builtin/log.c @@ -52,6 +52,7 @@ static int default_encode_email_headers = 1; static int decoration_style; static int decoration_given; static int use_mailmap_config = 1; +static unsigned int force_in_body_from; static const char *fmt_patch_subject_prefix = "PATCH"; static int fmt_patch_name_max = FORMAT_PATCH_NAME_MAX_DEFAULT; static const char *fmt_pretty; @@ -1897,6 +1898,8 @@ int cmd_format_patch(int argc, const char **argv, const char *prefix) N_("show changes against in cover letter or single patch")), OPT_INTEGER(0, "creation-factor", &creation_factor, N_("percentage by which creation is weighted")), + OPT_BOOL(0, "force-in-body-from", &force_in_body_from, + N_("show in-body From: even if identical to the e-mail header")), OPT_END() }; @@ -1940,6 +1943,8 @@ int cmd_format_patch(int argc, const char **argv, const char *prefix) PARSE_OPT_KEEP_ARGV0 | PARSE_OPT_KEEP_UNKNOWN | PARSE_OPT_KEEP_DASHDASH); + rev.force_in_body_from = force_in_body_from; + /* Make sure "0000-$sub.patch" gives non-negative length for $sub */ if (fmt_patch_name_max <= strlen("0000-") + strlen(fmt_patch_suffix)) fmt_patch_name_max = strlen("0000-") + strlen(fmt_patch_suffix); diff --git a/pretty.c b/pretty.c index cf418a6b20..b7553e3fe0 100644 --- a/pretty.c +++ b/pretty.c @@ -480,6 +480,8 @@ end: static int use_in_body_from(const struct pretty_print_context *pp, const struct ident_split *ident) { + if (pp->rev && pp->rev->force_in_body_from) + return 1; if (ident_cmp(pp->from_ident, ident)) return 1; return 0; diff --git a/revision.h b/revision.h index bb91e7ed91..6e346a60ab 100644 --- a/revision.h +++ b/revision.h @@ -221,6 +221,7 @@ struct rev_info { missing_newline:1, date_mode_explicit:1, preserve_subject:1, + force_in_body_from:1, encode_email_headers:1, include_header:1; unsigned int disable_stdin:1; diff --git a/t/t4014-format-patch.sh b/t/t4014-format-patch.sh index fbec8ad2ef..347f7f7f35 100755 --- a/t/t4014-format-patch.sh +++ b/t/t4014-format-patch.sh @@ -1400,6 +1400,19 @@ test_expect_success '--from omits redundant in-body header' ' test_cmp expect patch.head ' +test_expect_success 'with --force-in-body-from, redundant in-body from is kept' ' + git format-patch --force-in-body-from \ + -1 --stdout --from="A U Thor " >patch && + cat >expect <<-\EOF && + From: A U Thor + + From: A U Thor + + EOF + sed -ne "/^From:/p; /^$/p; /^---$/q" patch >patch.head && + test_cmp expect patch.head +' + test_expect_success 'in-body headers trigger content encoding' ' test_env GIT_AUTHOR_NAME="éxötìc" test_commit exotic && test_when_finished "git reset --hard HEAD^" && From d5fc07df688ace8c5a32f66b358ebd55cdaf4d28 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Mon, 29 Aug 2022 14:38:37 -0700 Subject: [PATCH 3/3] format-patch: learn format.forceInBodyFrom configuration variable As the need to use the "--force-in-body-from" option primarily is tied to which mailing list the mails go to (and get their From: address mangled), it is likely that a user who needs to use this option once to interact with their upstream project needs to use it for all patches they send out. Add a configuration variable, suitable for setting in the local configuration file per repository, for this. Signed-off-by: Junio C Hamano --- Documentation/config/format.txt | 4 ++++ Documentation/git-format-patch.txt | 2 ++ builtin/log.c | 4 ++++ t/t4014-format-patch.sh | 24 ++++++++++++++++++++++++ 4 files changed, 34 insertions(+) diff --git a/Documentation/config/format.txt b/Documentation/config/format.txt index fdbc06a4d2..c7303d8d9f 100644 --- a/Documentation/config/format.txt +++ b/Documentation/config/format.txt @@ -15,6 +15,10 @@ format.from:: different. If set to a non-boolean value, format-patch uses that value instead of your committer identity. Defaults to false. +format.forceInBodyFrom:: + Provides the default value for the `--[no-]force-in-body-from` + option to format-patch. Defaults to false. + format.numbered:: A boolean which can enable or disable sequence numbers in patch subjects. It defaults to "auto" which enables it only if there diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt index 7c7f244e57..dfcc7da4c2 100644 --- a/Documentation/git-format-patch.txt +++ b/Documentation/git-format-patch.txt @@ -283,6 +283,8 @@ feeding the result to `git send-email`. the in-body "From:" is added even when the sender and the author have the same name and address, which may help if the mailing list software mangles the sender's identity. + Defaults to the value of the `format.forceInBodyFrom` + configuration variable. --add-header=
:: Add an arbitrary header to the email headers. This is in addition diff --git a/builtin/log.c b/builtin/log.c index 78ccd37bd9..776bc9afdb 100644 --- a/builtin/log.c +++ b/builtin/log.c @@ -1007,6 +1007,10 @@ static int git_format_config(const char *var, const char *value, void *cb) from = NULL; return 0; } + if (!strcmp(var, "format.forceinbodyfrom")) { + force_in_body_from = git_config_bool(var, value); + return 0; + } if (!strcmp(var, "format.notes")) { int b = git_parse_maybe_bool(value); if (b < 0) diff --git a/t/t4014-format-patch.sh b/t/t4014-format-patch.sh index 347f7f7f35..ad5c029279 100755 --- a/t/t4014-format-patch.sh +++ b/t/t4014-format-patch.sh @@ -1413,6 +1413,30 @@ test_expect_success 'with --force-in-body-from, redundant in-body from is kept' test_cmp expect patch.head ' +test_expect_success 'format.forceInBodyFrom, equivalent to --force-in-body-from' ' + git -c format.forceInBodyFrom=yes format-patch \ + -1 --stdout --from="A U Thor " >patch && + cat >expect <<-\EOF && + From: A U Thor + + From: A U Thor + + EOF + sed -ne "/^From:/p; /^$/p; /^---$/q" patch >patch.head && + test_cmp expect patch.head +' + +test_expect_success 'format.forceInBodyFrom, equivalent to --force-in-body-from' ' + git -c format.forceInBodyFrom=yes format-patch --no-force-in-body-from \ + -1 --stdout --from="A U Thor " >patch && + cat >expect <<-\EOF && + From: A U Thor + + EOF + sed -ne "/^From:/p; /^$/p; /^---$/q" patch >patch.head && + test_cmp expect patch.head +' + test_expect_success 'in-body headers trigger content encoding' ' test_env GIT_AUTHOR_NAME="éxötìc" test_commit exotic && test_when_finished "git reset --hard HEAD^" &&