# Re: [PATCH] t4014-format-patch: Adjust git_version regex to better handle distro changes to DEF_VER 9 messages from 2016-10-10 to 2016-10-11. Participants: Josh Triplett, Jeremy Huddleston Sequoia, Jeff King, Junio C Hamano, Eric Wong. Thread: https://gitlist.dev/t/44266 ## Josh Triplett, 2016-10-10 03:04 Subject: Re: [PATCH] t4014-format-patch: Adjust git_version regex to better handle distro changes to DEF_VER Message-ID: URL: https://gitlist.dev/e/E0254A0C-8BEC-4B88-A352-BA075B49BFA7%40joshtriplett.org In-Reply-To: <20161010025323.9415-1-jeremyhu@apple.com> ``` On October 9, 2016 7:53:23 PM PDT, Jeremy Huddleston Sequoia wrote: >Regressed-in: 480871e09ed2e5275b4ba16b278681e5a8c122ae >Signed-off-by: Jeremy Huddleston Sequoia >CC: Josh Triplett >CC: Junio C Hamano Looks reasonable to me. Didn't realize git versions could have spaces. Reviewed-by: Josh Triplett > t/t4014-format-patch.sh | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > >diff --git a/t/t4014-format-patch.sh b/t/t4014-format-patch.sh >index 8d90a6e..33f6940 100755 >--- a/t/t4014-format-patch.sh >+++ b/t/t4014-format-patch.sh >@@ -754,7 +754,7 @@ test_expect_success 'format-patch >--ignore-if-in-upstream HEAD' ' > git format-patch --ignore-if-in-upstream HEAD > ' > >-git_version="$(git --version | sed "s/.* //")" >+git_version="$(git --version | sed "s/git version //")" > > signature() { > printf "%s\n%s\n\n" "-- " "${1:-$git_version}" ``` ## Jeremy Huddleston Sequoia, 2016-10-10 02:53 Subject: [PATCH] t4014-format-patch: Adjust git_version regex to better handle distro changes to DEF_VER Message-ID: <20161010025323.9415-1-jeremyhu@apple.com> URL: https://gitlist.dev/e/20161010025323.9415-1-jeremyhu%40apple.com ``` Regressed-in: 480871e09ed2e5275b4ba16b278681e5a8c122ae Signed-off-by: Jeremy Huddleston Sequoia CC: Josh Triplett CC: Junio C Hamano --- t/t4014-format-patch.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/t/t4014-format-patch.sh b/t/t4014-format-patch.sh index 8d90a6e..33f6940 100755 --- a/t/t4014-format-patch.sh +++ b/t/t4014-format-patch.sh @@ -754,7 +754,7 @@ test_expect_success 'format-patch --ignore-if-in-upstream HEAD' ' git format-patch --ignore-if-in-upstream HEAD ' -git_version="$(git --version | sed "s/.* //")" +git_version="$(git --version | sed "s/git version //")" signature() { printf "%s\n%s\n\n" "-- " "${1:-$git_version}" -- 2.10.1 (Apple Git-99) ``` ## Jeremy Huddleston Sequoia, 2016-10-10 04:08 Subject: Re: [PATCH] t4014-format-patch: Adjust git_version regex to better handle distro changes to DEF_VER Message-ID: URL: https://gitlist.dev/e/BC856B6F-B18F-41AF-BE60-973B8CFFC973%40apple.com In-Reply-To: ``` > On Oct 9, 2016, at 20:04, Josh Triplett wrote: > > On October 9, 2016 7:53:23 PM PDT, Jeremy Huddleston Sequoia wrote: >> Regressed-in: 480871e09ed2e5275b4ba16b278681e5a8c122ae >> Signed-off-by: Jeremy Huddleston Sequoia >> CC: Josh Triplett >> CC: Junio C Hamano > > Looks reasonable to me. Didn't realize git versions could have spaces. > Reviewed-by: Josh Triplett Thanks, Josh. If anyone feels strongly that they shouldn't, I'd be happy to change our DEF_VER patch to play nicer. cf https://github.com/jeremyhu/git/commit/f99905d0752d923e5ec61e14c675a300c6d04284 > >> t/t4014-format-patch.sh | 2 +- >> 1 file changed, 1 insertion(+), 1 deletion(-) >> >> diff --git a/t/t4014-format-patch.sh b/t/t4014-format-patch.sh >> index 8d90a6e..33f6940 100755 >> --- a/t/t4014-format-patch.sh >> +++ b/t/t4014-format-patch.sh >> @@ -754,7 +754,7 @@ test_expect_success 'format-patch >> --ignore-if-in-upstream HEAD' ' >> git format-patch --ignore-if-in-upstream HEAD >> ' >> >> -git_version="$(git --version | sed "s/.* //")" >> +git_version="$(git --version | sed "s/git version //")" >> >> signature() { >> printf "%s\n%s\n\n" "-- " "${1:-$git_version}" > > ``` ## Jeff King, 2016-10-10 13:10 Subject: Re: [PATCH] t4014-format-patch: Adjust git_version regex to better handle distro changes to DEF_VER Message-ID: <20161010131041.lpdh4a7nol24hsz2@sigill.intra.peff.net> URL: https://gitlist.dev/e/20161010131041.lpdh4a7nol24hsz2%40sigill.intra.peff.net In-Reply-To: <20161010025323.9415-1-jeremyhu@apple.com> ``` On Sun, Oct 09, 2016 at 07:53:23PM -0700, Jeremy Huddleston Sequoia wrote: > Subject: Re: [PATCH] t4014-format-patch: Adjust git_version regex to better > handle distro changes to DEF_VER > > Regressed-in: 480871e09ed2e5275b4ba16b278681e5a8c122ae > Signed-off-by: Jeremy Huddleston Sequoia I see there was a discussion elsewhere on the list about exactly what you are putting into DEF_VAR that causes the problem. Perhaps the commit message here would be a good place to mention that, why the current regex breaks it, and why your new version fixes not only it, but other possible values of DEF_VAR. -Peff ``` ## Jeremy Huddleston Sequoia, 2016-10-10 16:37 Subject: Re: [PATCH] t4014-format-patch: Adjust git_version regex to better handle distro changes to DEF_VER Message-ID: <9A250ABE-1B54-4AD4-8DB5-026CC4725AB9@apple.com> URL: https://gitlist.dev/e/9A250ABE-1B54-4AD4-8DB5-026CC4725AB9%40apple.com In-Reply-To: <20161010131041.lpdh4a7nol24hsz2@sigill.intra.peff.net> ``` > On Oct 10, 2016, at 06:10, Jeff King wrote: > > On Sun, Oct 09, 2016 at 07:53:23PM -0700, Jeremy Huddleston Sequoia wrote: > >> Subject: Re: [PATCH] t4014-format-patch: Adjust git_version regex to better >> handle distro changes to DEF_VER >> >> Regressed-in: 480871e09ed2e5275b4ba16b278681e5a8c122ae >> Signed-off-by: Jeremy Huddleston Sequoia > > I see there was a discussion elsewhere on the list about exactly what > you are putting into DEF_VAR that causes the problem. Perhaps the commit > message here would be a good place to mention that, why the current > regex breaks it, and why your new version fixes not only it, but other > possible values of DEF_VAR. Thanks, I've added this blurb: For example, git distributed with Apple's Xcode reports a version like: git version 2.9.3 (Apple Git-75) Apple started doing this to help customers distinguish between different versions of their packaged git which have the same base version (eg: with different patches applied). ``` ## Junio C Hamano, 2016-10-10 16:42 Subject: Re: [PATCH] t4014-format-patch: Adjust git_version regex to better handle distro changes to DEF_VER Message-ID: URL: https://gitlist.dev/e/xmqqpon8gnp3.fsf%40gitster.mtv.corp.google.com In-Reply-To: <20161010025323.9415-1-jeremyhu@apple.com> ``` Jeremy Huddleston Sequoia writes: > Regressed-in: 480871e09ed2e5275b4ba16b278681e5a8c122ae Please be considerate to future readers of "git log" to help them avoid mistakes earlier commits made that caused you troubles. This line by itself without any explanation of what was broken is quite useless as a commit message. What can the readers do? They'd go back and say "git show 480871e09" and then what? The test added or modified by the commit has been working quite well for others since it was made, so it is very likely the reader wouldn't be able to tell if anything is wrong in it. You would help if you said what is different in _your_ environment from others who have happily been running and passing this test for others to understand and learn from your fix. What is it? The "Adjust ... distro changes" in the title offers some hint but it could be more explicit. Please write something along this line instead. Subject: t4014: git --version can have SP in it 480871e09e ("format-patch: show base info before email signature", 2016-09-07) added a helper function to recreate the signature at the end of the e-mail, i.e. "-- " line followed by the version string of Git, using output from "git --version" and stripping everything before the last SP. Because the default Git version string looks like "git version 2.10.0-1-g480871e09e", this was mostly OK, but people can change this version string to arbitrary thing while compiling, which can break the assumption if they had SP in it. Notably, Apple ships modified Git with " (Apple Git-xx)" appended to its version number. Instead, come up with the version string by stripping the "git version " from the beginning. > Signed-off-by: Jeremy Huddleston Sequoia Good. > CC: Josh Triplett > CC: Junio C Hamano Please don't do this in your log message. These belong to your e-mail headers, not here. > --- > t/t4014-format-patch.sh | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/t/t4014-format-patch.sh b/t/t4014-format-patch.sh > index 8d90a6e..33f6940 100755 > --- a/t/t4014-format-patch.sh > +++ b/t/t4014-format-patch.sh > @@ -754,7 +754,7 @@ test_expect_success 'format-patch --ignore-if-in-upstream HEAD' ' > git format-patch --ignore-if-in-upstream HEAD > ' > > -git_version="$(git --version | sed "s/.* //")" > +git_version="$(git --version | sed "s/git version //")" Anchor the fixed prefix to the beginning, so that we can protect ourselves from another distro that would add "git version" in the middle of their arbitrary versioning scheme ;-). I.e. sed "s/^git version //" > > signature() { > printf "%s\n%s\n\n" "-- " "${1:-$git_version}" ``` ## Junio C Hamano, 2016-10-10 16:46 Subject: Re: [PATCH] t4014-format-patch: Adjust git_version regex to better handle distro changes to DEF_VER Message-ID: URL: https://gitlist.dev/e/xmqqh98kgnio.fsf%40gitster.mtv.corp.google.com In-Reply-To: <20161010131041.lpdh4a7nol24hsz2@sigill.intra.peff.net> ``` Jeff King writes: > On Sun, Oct 09, 2016 at 07:53:23PM -0700, Jeremy Huddleston Sequoia wrote: > >> Subject: Re: [PATCH] t4014-format-patch: Adjust git_version regex to better >> handle distro changes to DEF_VER >> >> Regressed-in: 480871e09ed2e5275b4ba16b278681e5a8c122ae >> Signed-off-by: Jeremy Huddleston Sequoia > > I see there was a discussion elsewhere on the list about exactly what > you are putting into DEF_VAR that causes the problem. Perhaps the commit > message here would be a good place to mention that, why the current > regex breaks it, and why your new version fixes not only it, but other > possible values of DEF_VAR. Ah, should have known that you'd already be helping with this. Thanks. ``` ## Jeremy Huddleston Sequoia, 2016-10-10 17:01 Subject: Re: [PATCH] t4014-format-patch: Adjust git_version regex to better handle distro changes to DEF_VER Message-ID: URL: https://gitlist.dev/e/A7BDC661-317E-49C1-A8B1-534A0DC26501%40apple.com In-Reply-To: ``` > On Oct 10, 2016, at 09:42, Junio C Hamano wrote: > > Jeremy Huddleston Sequoia writes: > >> Regressed-in: 480871e09ed2e5275b4ba16b278681e5a8c122ae > > Please be considerate to future readers of "git log" to help them > avoid mistakes earlier commits made that caused you troubles. > > This line by itself without any explanation of what was broken is > quite useless as a commit message. What can the readers do? They'd > go back and say "git show 480871e09" and then what? The test added > or modified by the commit has been working quite well for others > since it was made, so it is very likely the reader wouldn't be able > to tell if anything is wrong in it. > > You would help if you said what is different in _your_ environment > from others who have happily been running and passing this test for > others to understand and learn from your fix. What is it? > > The "Adjust ... distro changes" in the title offers some hint but it > could be more explicit. Please write something along this line > instead. > > Subject: t4014: git --version can have SP in it > > 480871e09e ("format-patch: show base info before email > signature", 2016-09-07) added a helper function to recreate the > signature at the end of the e-mail, i.e. "-- " line followed by > the version string of Git, using output from "git --version" and > stripping everything before the last SP. > > Because the default Git version string looks like "git version > 2.10.0-1-g480871e09e", this was mostly OK, but people can change > this version string to arbitrary thing while compiling, which > can break the assumption if they had SP in it. Notably, Apple > ships modified Git with " (Apple Git-xx)" appended to its > version number. > > Instead, come up with the version string by stripping the "git > version " from the beginning. Ok, I'll add that explanation to the commit message, thanks. > >> Signed-off-by: Jeremy Huddleston Sequoia > > Good. > >> CC: Josh Triplett >> CC: Junio C Hamano > > Please don't do this in your log message. These belong to your > e-mail headers, not here. Sorry, we do that consistently on other projects during the review process, so git send-email picks them up and adds them automatically for each patch being sent out. It's quite useful, actually. > >> --- >> t/t4014-format-patch.sh | 2 +- >> 1 file changed, 1 insertion(+), 1 deletion(-) >> >> diff --git a/t/t4014-format-patch.sh b/t/t4014-format-patch.sh >> index 8d90a6e..33f6940 100755 >> --- a/t/t4014-format-patch.sh >> +++ b/t/t4014-format-patch.sh >> @@ -754,7 +754,7 @@ test_expect_success 'format-patch --ignore-if-in-upstream HEAD' ' >> git format-patch --ignore-if-in-upstream HEAD >> ' >> >> -git_version="$(git --version | sed "s/.* //")" >> +git_version="$(git --version | sed "s/git version //")" > > Anchor the fixed prefix to the beginning, so that we can protect > ourselves from another distro that would add "git version" in the > middle of their arbitrary versioning scheme ;-). I.e. > > sed "s/^git version //" Ok. > >> >> signature() { >> printf "%s\n%s\n\n" "-- " "${1:-$git_version}" ``` ## Eric Wong, 2016-10-11 20:06 Subject: Re: [PATCH] t4014-format-patch: Adjust git_version regex to better handle distro changes to DEF_VER Message-ID: <20161011200604.GA21967@starla> URL: https://gitlist.dev/e/20161011200604.GA21967%40starla In-Reply-To: ``` Junio C Hamano wrote: > Jeremy Huddleston Sequoia writes: > > > CC: Josh Triplett > > CC: Junio C Hamano > > Please don't do this in your log message. These belong to your > e-mail headers, not here. Fwiw, I prefer having these trailers. It makes it easier to maintain the Cc: list through multiple iterations/authors and is also common practice on LKML. ```