If a user wishes to keep track of whom to Cc: on individual patchsets, they must manually keep track of each recipient and fill it in with the `--cc` option on git-format-patch each time. However, on the Git mailing list, Cc:'s are typically never dropped. As a result, it would be nice to have a method to keep track of recipients on a per-branch basis.
Currently, git-format-patch gets its To: headers from the `--to` options and the `format.to` config variable. The Cc: header is derived similarly. In addition to the above, read To: and Cc: headers from `format.<branch-name>.to` and `format.<branch-name>.cc` so that users can have branch-specific configuration options. Signed-off-by: Denton Liu <[email protected]> --- Documentation/config/format.txt | 7 +- Documentation/git-format-patch.txt | 10 +-- builtin/log.c | 63 +++++++++++++++-- t/t3200-branch.sh | 4 ++ t/t4014-format-patch.sh | 108 +++++++++++++++++++++++------ 5 files changed, 162 insertions(+), 30 deletions(-) diff --git a/Documentation/config/format.txt b/Documentation/config/format.txt index 7d2b3b7331..d387451573 100644 --- a/Documentation/config/format.txt +++ b/Documentation/config/format.txt @@ -28,9 +28,12 @@ format.headers:: format.to:: format.cc:: +format.<branch-name>.to:: +format.<branch-name>.cc:: Additional recipients to include in a patch to be submitted - by mail. See the --to and --cc options in - linkgit:git-format-patch[1]. + by mail. For the <branch-name> options, the recipients are only + included if patches are generated for the given <branch-name>. + See the --to and --cc options in linkgit:git-format-patch[1]. format.subjectPrefix:: The default for format-patch is to output files with the '[PATCH]' diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt index a43f317877..4e826010f6 100644 --- a/Documentation/git-format-patch.txt +++ b/Documentation/git-format-patch.txt @@ -199,7 +199,7 @@ will want to ensure that threading is disabled for `git send-email`. Add a `To:` header to the email headers. This is in addition to any configured headers, and may be used multiple times. The emails given will be used along with any emails given by - `format.to` configurations. + `format.to` and `format.<branch-name>.to` configurations. The negated form `--no-to` discards all `To:` headers added so far (from config or command line). @@ -207,7 +207,7 @@ will want to ensure that threading is disabled for `git send-email`. Add a `Cc:` header to the email headers. This is in addition to any configured headers, and may be used multiple times. The emails given will be used along with any emails given by - `format.cc` configurations. + `format.cc` and `format.<branch-name>.cc` configurations. The negated form `--no-cc` discards all `Cc:` headers added so far (from config or command line). @@ -335,7 +335,7 @@ CONFIGURATION ------------- You can specify extra mail header lines to be added to each message, defaults for the subject prefix and file suffix, number patches when -outputting more than one patch, add "To" or "Cc:" headers, configure +outputting more than one patch, add "To:" or "Cc:" headers, configure attachments, and sign off patches with configuration variables. ------------ @@ -352,11 +352,13 @@ attachments, and sign off patches with configuration variables. ------------ In addition, for a specific branch, you can specify a custom cover -letter subject. +letter subject, and add additional "To:" or "Cc:" headers. ------------ [format "branch-name"] coverSubject = "subject for branch-name only" + to = <email> + cc = <email> ------------ DISCUSSION diff --git a/builtin/log.c b/builtin/log.c index f66a65fe84..e1d793577d 100644 --- a/builtin/log.c +++ b/builtin/log.c @@ -738,6 +738,8 @@ static char *default_attach = NULL; static struct string_list extra_hdr = STRING_LIST_INIT_NODUP; static struct string_list extra_to = STRING_LIST_INIT_NODUP; static struct string_list extra_cc = STRING_LIST_INIT_NODUP; +int to_cleared; +int cc_cleared; static void add_header(const char *value) { @@ -1045,6 +1047,55 @@ static int read_branch_subject(struct strbuf *buf, const char *branch_name) return 0; } +static void add_branch_headers(struct rev_info *rev, const char *branch_name) +{ + struct strbuf buf = STRBUF_INIT; + const struct string_list *values; + + if (!branch_name) + branch_name = find_branch_name(rev); + + if (!branch_name || !*branch_name) + return; + + /* + * HACK: We only use branch-specific recipients iff the list has not + * been cleared by an earlier --no-{to,cc} option on the command-line. + * + * When we get format.{to,cc} options, they can be cleared by + * --no-{to,cc} options since the `git_config` call comes before the + * `parse_options` call. + * + * However, in the case of branch.<name>.{to,cc}, this function needs + * to be called after `setup_revisions`, which must be called after + * `parse_options`. However, in order for the --no-{to,cc} logic to + * clear the extra_{to,cc} string_list, this function should actually + * be called _before_ `parse_options`. As a result, we have a circular + * dependency. + * + * The {to,cc}_cleared flag lets us workaround this by just no + * including branch-specific recipients iff --no-{to,cc} has been + * specified on the command-line. + */ + + if (!to_cleared) { + strbuf_addf(&buf, "format.%s.to", branch_name); + values = git_config_get_value_multi(buf.buf); + if (values) + string_list_append_all(&extra_to, values); + } + + if (!cc_cleared) { + strbuf_reset(&buf); + strbuf_addf(&buf, "format.%s.cc", branch_name); + values = git_config_get_value_multi(buf.buf); + if (values) + string_list_append_all(&extra_cc, values); + } + + strbuf_release(&buf); +} + static void make_cover_letter(struct rev_info *rev, int use_stdout, struct commit *origin, int nr, struct commit **list, @@ -1304,18 +1355,20 @@ static int header_callback(const struct option *opt, const char *arg, int unset) static int to_callback(const struct option *opt, const char *arg, int unset) { - if (unset) + if (unset) { + to_cleared = 1; string_list_clear(&extra_to, 0); - else + } else string_list_append(&extra_to, arg); return 0; } static int cc_callback(const struct option *opt, const char *arg, int unset) { - if (unset) + if (unset) { + cc_cleared = 1; string_list_clear(&extra_cc, 0); - else + } else string_list_append(&extra_cc, arg); return 0; } @@ -1782,6 +1835,8 @@ int cmd_format_patch(int argc, const char **argv, const char *prefix) } } + add_branch_headers(&rev, branch_name); + for (i = 0; i < extra_hdr.nr; i++) { strbuf_addstr(&buf, extra_hdr.items[i].string); strbuf_addch(&buf, '\n'); diff --git a/t/t3200-branch.sh b/t/t3200-branch.sh index dad23f7d4c..9ae3da888e 100755 --- a/t/t3200-branch.sh +++ b/t/t3200-branch.sh @@ -783,10 +783,14 @@ test_expect_success 'test tracking setup via --track but deeper' ' test_expect_success 'test deleting branch deletes branch config' ' git config format.my7.coverSubject "cover subject" && + git config format.my7.to "To Me <[email protected]>" && + git config format.my7.cc "Cc Me <[email protected]>" && git branch -d my7 && test -z "$(git config branch.my7.remote)" && test -z "$(git config branch.my7.merge)" && test -z "$(git config format.my7.coverSubject)" + test -z "$(git config format.my7.to)" && + test -z "$(git config format.my7.cc)" ' test_expect_success 'test deleting branch without config' ' diff --git a/t/t4014-format-patch.sh b/t/t4014-format-patch.sh index 9d11992e10..9c527510c3 100755 --- a/t/t4014-format-patch.sh +++ b/t/t4014-format-patch.sh @@ -234,6 +234,65 @@ test_expect_failure 'configuration To: header (rfc2047)' ' grep "^To: =?UTF-8?q?R=20=C3=84=20Cipient?= <[email protected]>\$" hdrs9 ' +test_expect_success 'branch-specific configuration To: header (ascii)' ' + + test_unconfig format.to && + git config format.side.to "R E Cipient <[email protected]>" && + git format-patch --stdout master..side >patch10 && + sed -e "/^\$/q" patch10 >hdrs10 && + grep "^To: R E Cipient <[email protected]>\$" hdrs10 +' + +test_expect_failure 'branch-specific configuration To: header (rfc822)' ' + + git config format.side.to "R. E. Cipient <[email protected]>" && + git format-patch --stdout master..side >patch10 && + sed -e "/^\$/q" patch10 >hdrs10 && + grep "^To: \"R. E. Cipient\" <[email protected]>\$" hdrs10 +' + +test_expect_failure 'branch-specific configuration To: header (rfc2047)' ' + + git config format.side.to "R Ä Cipient <[email protected]>" && + git format-patch --stdout master..side >patch10 && + sed -e "/^\$/q" patch10 >hdrs10 && + grep "^To: =?UTF-8?q?R=20=C3=84=20Cipient?= <[email protected]>\$" hdrs10 +' + +test_expect_success 'all recipients included from all sources' ' + + git config format.to "Format To1 <[email protected]>" && + git config --add format.to "Format To2 <[email protected]>" && + git config format.cc "Format Cc1 <[email protected]>" && + git config --add format.cc "Format Cc2 <[email protected]>" && + git config format.side.to "Branch To1 <[email protected]>" && + git config --add format.side.to "Branch To2 <[email protected]>" && + git config format.side.cc "Branch Cc1 <[email protected]>" && + git config --add format.side.cc "Branch Cc2 <[email protected]>" && + cat <<-\EOF >expect && + To: Format To1 <[email protected]>, + Format To2 <[email protected]>, + Command-line To1 <[email protected]>, + Command-line To2 <[email protected]>, + Branch To1 <[email protected]>, + Branch To2 <[email protected]> + Cc: Format Cc1 <[email protected]>, + Format Cc2 <[email protected]>, + Command-line Cc1 <[email protected]>, + Command-line Cc2 <[email protected]>, + Branch Cc1 <[email protected]>, + Branch Cc2 <[email protected]> + + EOF + git format-patch --stdout \ + --to="Command-line To1 <[email protected]>" \ + --to="Command-line To2 <[email protected]>" \ + --cc="Command-line Cc1 <[email protected]>" \ + --cc="Command-line Cc2 <[email protected]>" \ + master..side | sed -ne "/^To:/,/^$/p;/^$/q" >patch10 && + test_cmp expect patch10 +' + # check_patch <patch>: Verify that <patch> looks like a half-sane # patch email to avoid a false positive with !grep check_patch () { @@ -286,42 +345,51 @@ test_expect_success '--no-to overrides config.to' ' git config --replace-all format.to \ "R E Cipient <[email protected]>" && - git format-patch --no-to --stdout master..side >patch10 && - sed -e "/^\$/q" patch10 >hdrs10 && - check_patch hdrs10 && - ! grep "^To: R E Cipient <[email protected]>\$" hdrs10 + git config --replace-all format.side.to \ + "B R Anch <[email protected]>" && + git format-patch --no-to --stdout master..side >patch11 && + sed -e "/^\$/q" patch11 >hdrs11 && + check_patch hdrs11 && + ! grep "R E Cipient <[email protected]>" hdrs11 && + ! grep "B R Anch <[email protected]>" hdrs11 ' test_expect_success '--no-to and --to replaces config.to' ' git config --replace-all format.to \ "Someone <[email protected]>" && + git config --replace-all format.side.to \ + "B R Anch2 <[email protected]>" && git format-patch --no-to --to="Someone Else <[email protected]>" \ - --stdout master..side >patch11 && - sed -e "/^\$/q" patch11 >hdrs11 && - check_patch hdrs11 && - ! grep "^To: Someone <[email protected]>\$" hdrs11 && - grep "^To: Someone Else <[email protected]>\$" hdrs11 + --stdout master..side >patch12 && + sed -e "/^\$/q" patch12 >hdrs12 && + check_patch hdrs12 && + ! grep "Someone <[email protected]>" hdrs12 && + ! grep "B R Anch2 <[email protected]>" hdrs12 && + grep "^To: Someone Else <[email protected]>\$" hdrs12 ' test_expect_success '--no-cc overrides config.cc' ' git config --replace-all format.cc \ "C E Cipient <[email protected]>" && - git format-patch --no-cc --stdout master..side >patch12 && - sed -e "/^\$/q" patch12 >hdrs12 && - check_patch hdrs12 && - ! grep "^Cc: C E Cipient <[email protected]>\$" hdrs12 + git config --replace-all format.side.cc \ + "B R Anch3 <[email protected]>" && + git format-patch --no-cc --stdout master..side >patch13 && + sed -e "/^\$/q" patch13 >hdrs13 && + check_patch hdrs13 && + ! grep "C E Cipient <[email protected]>" hdrs13 && + ! grep "B R Anch3 <[email protected]>" hdrs13 ' test_expect_success '--no-add-header overrides config.headers' ' git config --replace-all format.headers \ "Header1: B E Cipient <[email protected]>" && - git format-patch --no-add-header --stdout master..side >patch13 && - sed -e "/^\$/q" patch13 >hdrs13 && - check_patch hdrs13 && - ! grep "^Header1: B E Cipient <[email protected]>\$" hdrs13 + git format-patch --no-add-header --stdout master..side >patch14 && + sed -e "/^\$/q" patch14 >hdrs14 && + check_patch hdrs14 && + ! grep "^Header1: B E Cipient <[email protected]>\$" hdrs14 ' test_expect_success 'multiple files' ' @@ -963,7 +1031,7 @@ test_expect_success 'format-patch wraps extremely long subject (ascii)' ' git add file && git commit -m "$M512" && git format-patch --stdout -1 >patch && - sed -n "/^Subject/p; /^ /p; /^$/q" <patch >subject && + sed -n "/^Subject/p; /^ /p; /^Header1:/q" <patch >subject && test_cmp expect subject ' @@ -1002,7 +1070,7 @@ test_expect_success 'format-patch wraps extremely long subject (rfc2047)' ' git add file && git commit -m "$M512" && git format-patch --stdout -1 >patch && - sed -n "/^Subject/p; /^ /p; /^$/q" <patch >subject && + sed -n "/^Subject/p; /^ /p; /^Header1:/q" <patch >subject && test_cmp expect subject ' @@ -1011,7 +1079,7 @@ check_author() { git add file && GIT_AUTHOR_NAME=$1 git commit -m author-check && git format-patch --stdout -1 >patch && - sed -n "/^From: /p; /^ /p; /^$/q" <patch >actual && + sed -n "/^From: /p; /^ /p; /^Date:/q" <patch >actual && test_cmp expect actual } -- 2.21.0.1049.geb646f7864
