[PATCH] docs/devel: remove incorrect claim about git send-email

[PATCH] docs/devel: remove incorrect claim about git send-email

[Linus Heckemann]

While it's unclear to me what git send-email actually does with the
-v2 parameter (it is not documented, but also not rejected), it does
not add a v2 tag to the email's subject, which is what led to the
mishap in [1].

[1]: https://lists.nongnu.org/archive/html/qemu-devel/2022-09/msg00679.html
---
 docs/devel/submitting-a-patch.rst | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/docs/devel/submitting-a-patch.rst b/docs/devel/submitting-a-patch.rst
index fec33ce148..be2c428b93 100644
--- a/docs/devel/submitting-a-patch.rst
+++ b/docs/devel/submitting-a-patch.rst
@@ -456,8 +456,7 @@ patch need not say "v1", just [PATCH] is sufficient.) For patch series,
 the version applies to the whole series -- even if you only change one
 patch, you resend the entire series and mark it as "v2". Don't try to
 track versions of different patches in the series separately.  `git
-format-patch <http://git-scm.com/docs/git-format-patch>`__ and `git
-send-email <http://git-scm.com/docs/git-send-email>`__ both understand
+format-patch <http://git-scm.com/docs/git-format-patch>`__ understands
 the ``-v2`` option to make this easier. Send each new revision as a new
 top-level thread, rather than burying it in-reply-to an earlier
 revision, as many reviewers are not looking inside deep threads for new
-- 
2.36.2

Re: [PATCH] docs/devel: remove incorrect claim about git send-email

[Alyssa Ross]

[-- Attachment #1: Type: text/plain, Size: 467 bytes --]

Linus Heckemann <git@sphalerite.org> writes:

> While it's unclear to me what git send-email actually does with the
> -v2 parameter (it is not documented, but also not rejected), it does
> not add a v2 tag to the email's subject, which is what led to the
> mishap in [1].
>
> [1]: https://lists.nongnu.org/archive/html/qemu-devel/2022-09/msg00679.html

It does for me!

Tested with:

       git send-email -v2 --to hi@alyssa.is HEAD~

X-Mailer: git-send-email 2.37.1

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]

Re: [PATCH] docs/devel: remove incorrect claim about git send-email

[Alyssa Ross]

[-- Attachment #1: Type: text/plain, Size: 717 bytes --]

Alyssa Ross <hi@alyssa.is> writes:

> Linus Heckemann <git@sphalerite.org> writes:
>
>> While it's unclear to me what git send-email actually does with the
>> -v2 parameter (it is not documented, but also not rejected), it does
>> not add a v2 tag to the email's subject, which is what led to the
>> mishap in [1].
>>
>> [1]: https://lists.nongnu.org/archive/html/qemu-devel/2022-09/msg00679.html
>
> It does for me!
>
> Tested with:
>
>        git send-email -v2 --to hi@alyssa.is HEAD~
>
> X-Mailer: git-send-email 2.37.1

I wouldn't be surprised if it only adds it when it's generating the
patch though.  Did you perhaps run git format-patch first to generate a
patch file, and then use git send-email to send it?

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]

Re: [PATCH] docs/devel: remove incorrect claim about git send-email

[Linus Heckemann]

Alyssa Ross <hi@alyssa.is> writes:

> Alyssa Ross <hi@alyssa.is> writes:
>
>> Linus Heckemann <git@sphalerite.org> writes:
>>
>>> While it's unclear to me what git send-email actually does with the
>>> -v2 parameter (it is not documented, but also not rejected), it does
>>> not add a v2 tag to the email's subject, which is what led to the
>>> mishap in [1].
>>>
>>> [1]: https://lists.nongnu.org/archive/html/qemu-devel/2022-09/msg00679.html
>>
>> It does for me!
>>
>> Tested with:
>>
>>        git send-email -v2 --to hi@alyssa.is HEAD~
>>
>> X-Mailer: git-send-email 2.37.1
>
> I wouldn't be surprised if it only adds it when it's generating the
> patch though.  Did you perhaps run git format-patch first to generate a
> patch file, and then use git send-email to send it?

Yes! I didn't realise that git send-email can be used without the
intermediate format-patch step. I guess it's a git bug that git
send-email will silently ignore -v when used with a patch file. I'll
have a look at fixing that.

Re: [PATCH] docs/devel: remove incorrect claim about git send-email

[Alyssa Ross]

[-- Attachment #1: Type: text/plain, Size: 1230 bytes --]

Linus Heckemann <git@sphalerite.org> writes:

> Alyssa Ross <hi@alyssa.is> writes:
>
>> Alyssa Ross <hi@alyssa.is> writes:
>>
>>> Linus Heckemann <git@sphalerite.org> writes:
>>>
>>>> While it's unclear to me what git send-email actually does with the
>>>> -v2 parameter (it is not documented, but also not rejected), it does
>>>> not add a v2 tag to the email's subject, which is what led to the
>>>> mishap in [1].
>>>>
>>>> [1]: https://lists.nongnu.org/archive/html/qemu-devel/2022-09/msg00679.html
>>>
>>> It does for me!
>>>
>>> Tested with:
>>>
>>>        git send-email -v2 --to hi@alyssa.is HEAD~
>>>
>>> X-Mailer: git-send-email 2.37.1
>>
>> I wouldn't be surprised if it only adds it when it's generating the
>> patch though.  Did you perhaps run git format-patch first to generate a
>> patch file, and then use git send-email to send it?
>
> Yes! I didn't realise that git send-email can be used without the
> intermediate format-patch step. I guess it's a git bug that git
> send-email will silently ignore -v when used with a patch file. I'll
> have a look at fixing that.

Yeah, that sounds like the best way to go.  I think it'll swallow /any/
format-patch options when used that way.  Would be nice if it warned.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]