# [PATCH] format-patch: add arbitrary email headers 5 messages from 2009-03-25 to 2009-03-26. Participants: Michael Hendricks, Junio C Hamano. Thread: https://gitlist.dev/t/18536 ## Michael Hendricks, 2009-03-25 15:58 Subject: [PATCH] format-patch: add arbitrary email headers Message-ID: <1237996712-61859-1-git-send-email-michael@ndrix.org> URL: https://gitlist.dev/e/1237996712-61859-1-git-send-email-michael%40ndrix.org ``` format-patch supports the format.headers configuration for adding arbitrary email headers to the patches it outputs. This patch adds support for a --header argument which makes the same feature available from the command line. This is useful when the content of custom email headers must change from branch to branch. This patch has been sponsored by Grant Street Group Signed-off-by: Michael Hendricks --- Documentation/git-format-patch.txt | 5 +++++ builtin-log.c | 2 ++ t/t4014-format-patch.sh | 15 +++++++++++++++ 3 files changed, 22 insertions(+), 0 deletions(-) diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt index c2eb5fa..e6fe7f3 100644 --- a/Documentation/git-format-patch.txt +++ b/Documentation/git-format-patch.txt @@ -161,6 +161,11 @@ if that is not set. Add a "Cc:" header to the email headers. This is in addition to any configured headers, and may be used multiple times. +--header=
:: + Add an arbitrary header to the email headers. This is in addition + to any configured headers, and may be used multiple times. + For example, --header="Organization: git-foo" + --cover-letter:: In addition to the patches, generate a cover letter file containing the shortlog and the overall diffstat. You can diff --git a/builtin-log.c b/builtin-log.c index c7a5772..35701a7 100644 --- a/builtin-log.c +++ b/builtin-log.c @@ -918,6 +918,8 @@ int cmd_format_patch(int argc, const char **argv, const char *prefix) cover_letter = 1; else if (!strcmp(argv[i], "--no-binary")) no_binary_diff = 1; + else if (!prefixcmp(argv[i], "--header=")) + add_header( argv[i] + 9 ); else argv[j++] = argv[i]; } diff --git a/t/t4014-format-patch.sh b/t/t4014-format-patch.sh index f187d15..5f8d9b4 100755 --- a/t/t4014-format-patch.sh +++ b/t/t4014-format-patch.sh @@ -128,6 +128,21 @@ test_expect_success 'additional command line cc' ' grep "^ *S. E. Cipient $" patch5 ' +test_expect_success 'command line headers' ' + + git config --unset-all format.headers && + git format-patch --header="Cc: R. E. Cipient " --stdout master..side | sed -e "/^$/q" >patch6 && + grep "^Cc: R. E. Cipient $" patch6 +' + +test_expect_success 'configuration headers and command line headers' ' + + git config --replace-all format.headers "Cc: R. E. Cipient " && + git format-patch --header="Cc: S. E. Cipient " --stdout master..side | sed -e "/^$/q" >patch7 && + grep "^Cc: R. E. Cipient ,$" patch7 && + grep "^ *S. E. Cipient $" patch7 +' + test_expect_success 'multiple files' ' rm -rf patches/ && -- 1.6.2.1.318.ged85d ``` ## Junio C Hamano, 2009-03-25 19:11 Subject: Re: [PATCH] format-patch: add arbitrary email headers Message-ID: <7v3ad11kqh.fsf@gitster.siamese.dyndns.org> URL: https://gitlist.dev/e/7v3ad11kqh.fsf%40gitster.siamese.dyndns.org In-Reply-To: <1237996712-61859-1-git-send-email-michael@ndrix.org> ``` Michael Hendricks writes: > format-patch supports the format.headers configuration for adding > arbitrary email headers to the patches it outputs. This patch adds > support for a --header argument which makes the same feature available > from the command line. This is useful when the content of custom > email headers must change from branch to branch. How should this interact with the configuration variable? Typically we allow command line options to override the matching config variable, so that people can say "here are the settings I ordinarily use" in the config file, and say "but I do not want the usual values to take effect for this particular invocation; please use these _instead_" with command line options. Note that the above question is "how should this interact"; not "how does this interact". I can see you chose to make this cumulative in your patch and the documentaiton. I am asking if that is what the users want, overriding is preferred, or perhaps another option to clear extra headers (say, "--no-extra-headers") is necessary to allow both. > diff --git a/builtin-log.c b/builtin-log.c > index c7a5772..35701a7 100644 > --- a/builtin-log.c > +++ b/builtin-log.c > @@ -918,6 +918,8 @@ int cmd_format_patch(int argc, const char **argv, const char *prefix) > cover_letter = 1; > else if (!strcmp(argv[i], "--no-binary")) > no_binary_diff = 1; > + else if (!prefixcmp(argv[i], "--header=")) > + add_header( argv[i] + 9 ); No extra SP immediately after ( and before ), please. ``` ## Michael Hendricks, 2009-03-26 16:42 Subject: Re: [PATCH] format-patch: add arbitrary email headers Message-ID: <20090326164212.GF29569@ginosko.ndrix.org> URL: https://gitlist.dev/e/20090326164212.GF29569%40ginosko.ndrix.org In-Reply-To: <7v3ad11kqh.fsf@gitster.siamese.dyndns.org> ``` On Wed, Mar 25, 2009 at 12:11:02PM -0700, Junio C Hamano wrote: > Michael Hendricks writes: > > > format-patch supports the format.headers configuration for adding > > arbitrary email headers to the patches it outputs. This patch adds > > support for a --header argument which makes the same feature available > > from the command line. This is useful when the content of custom > > email headers must change from branch to branch. > > How should this interact with the configuration variable? > > Typically we allow command line options to override the matching config > variable, so that people can say "here are the settings I ordinarily use" > in the config file, and say "but I do not want the usual values to take > effect for this particular invocation; please use these _instead_" with > command line options. > > Note that the above question is "how should this interact"; not "how does > this interact". I can see you chose to make this cumulative in your patch > and the documentaiton. > > I am asking if that is what the users want, overriding is preferred, or > perhaps another option to clear extra headers (say, "--no-extra-headers") > is necessary to allow both. In all the cases where I use custom headers on patch emails, I want the command line headers to be cumulative with the config headers. I only configure headers which are constant (such as "X-Project: project-name"). The ones that vary have no reasonable default value since they typically represent a bug tracking number or something similar. Perhaps --add-header is a better name for this argument. That name at least makes it clear that headers specified on the command line are cumulative. If someone has a use case for --no-extra-headers, they can add it later and --add-header retains the same meaning. Follow-up patch coming shortly. -- Michael ``` ## Michael Hendricks, 2009-03-26 16:51 Subject: [PATCH] format-patch: add arbitrary email headers Message-ID: <1238086265-71476-1-git-send-email-michael@ndrix.org> URL: https://gitlist.dev/e/1238086265-71476-1-git-send-email-michael%40ndrix.org In-Reply-To: <20090326164212.GF29569@ginosko.ndrix.org> ``` format-patch supports the format.headers configuration for adding arbitrary email headers to the patches it outputs. This patch adds support for an --add-header argument which makes the same feature available from the command line. This is useful when the content of custom email headers must change from branch to branch. This patch has been sponsored by Grant Street Group Signed-off-by: Michael Hendricks --- Documentation/git-format-patch.txt | 5 +++++ builtin-log.c | 2 ++ t/t4014-format-patch.sh | 15 +++++++++++++++ 3 files changed, 22 insertions(+), 0 deletions(-) diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt index c2eb5fa..51fd716 100644 --- a/Documentation/git-format-patch.txt +++ b/Documentation/git-format-patch.txt @@ -161,6 +161,11 @@ if that is not set. Add a "Cc:" header to the email headers. This is in addition to any configured headers, and may be used multiple times. +--add-header=
:: + Add an arbitrary header to the email headers. This is in addition + to any configured headers, and may be used multiple times. + For example, --add-header="Organization: git-foo" + --cover-letter:: In addition to the patches, generate a cover letter file containing the shortlog and the overall diffstat. You can diff --git a/builtin-log.c b/builtin-log.c index c7a5772..27bc0dc 100644 --- a/builtin-log.c +++ b/builtin-log.c @@ -918,6 +918,8 @@ int cmd_format_patch(int argc, const char **argv, const char *prefix) cover_letter = 1; else if (!strcmp(argv[i], "--no-binary")) no_binary_diff = 1; + else if (!prefixcmp(argv[i], "--add-header=")) + add_header(argv[i] + 13); else argv[j++] = argv[i]; } diff --git a/t/t4014-format-patch.sh b/t/t4014-format-patch.sh index f187d15..11061dd 100755 --- a/t/t4014-format-patch.sh +++ b/t/t4014-format-patch.sh @@ -128,6 +128,21 @@ test_expect_success 'additional command line cc' ' grep "^ *S. E. Cipient $" patch5 ' +test_expect_success 'command line headers' ' + + git config --unset-all format.headers && + git format-patch --add-header="Cc: R. E. Cipient " --stdout master..side | sed -e "/^$/q" >patch6 && + grep "^Cc: R. E. Cipient $" patch6 +' + +test_expect_success 'configuration headers and command line headers' ' + + git config --replace-all format.headers "Cc: R. E. Cipient " && + git format-patch --add-header="Cc: S. E. Cipient " --stdout master..side | sed -e "/^$/q" >patch7 && + grep "^Cc: R. E. Cipient ,$" patch7 && + grep "^ *S. E. Cipient $" patch7 +' + test_expect_success 'multiple files' ' rm -rf patches/ && -- 1.6.2.1.317.ga1cbc ``` ## Junio C Hamano, 2009-03-26 20:29 Subject: Re: [PATCH] format-patch: add arbitrary email headers Message-ID: <7viqlwm3ip.fsf@gitster.siamese.dyndns.org> URL: https://gitlist.dev/e/7viqlwm3ip.fsf%40gitster.siamese.dyndns.org In-Reply-To: <20090326164212.GF29569@ginosko.ndrix.org> ``` Michael Hendricks writes: > Perhaps --add-header is a better name for this argument. That name at > least makes it clear that headers specified on the command line are > cumulative. If someone has a use case for --no-extra-headers, they > can add it later and --add-header retains the same meaning. Sounds very sane. Thanks. ```