GNU bug report logs - #59523
[PATCH] doc: contributing: Note '-v REVISION' bug in 'git send-email'.

Previous Next

Package: guix-patches;

Reported by: "(" <paren <at> disroot.org>

Date: Wed, 23 Nov 2022 19:08:02 UTC

Severity: normal

Tags: patch

Done: Maxim Cournoyer <maxim.cournoyer <at> gmail.com>

Bug is archived. No further changes may be made.

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 59523 in the body.
You can then email your comments to 59523 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

View this report as an mbox folder, status mbox, maintainer mbox


Report forwarded to guix-patches <at> gnu.org:
bug#59523; Package guix-patches. (Wed, 23 Nov 2022 19:08:02 GMT) Full text and rfc822 format available.

Acknowledgement sent to "(" <paren <at> disroot.org>:
New bug report received and forwarded. Copy sent to guix-patches <at> gnu.org. (Wed, 23 Nov 2022 19:08:02 GMT) Full text and rfc822 format available.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: "(" <paren <at> disroot.org>
To: guix-patches <at> gnu.org
Cc: "\(" <paren <at> disroot.org>
Subject: [PATCH] doc: contributing: Note '-v REVISION' bug in 'git send-email'.
Date: Wed, 23 Nov 2022 19:07:10 +0000
* doc/contributing.texi ("Submitting Patches")["Sending a Patch Series"]:
Note that a bug in 'git send-email' means '-v REVISION' (with a
space) will not work.
---
Heya Guix,

Turns out that due to a bug in ``git send-email'', using ``-v 2'' with
a space between the flag and the argument won't work. If you try it, it'll
print a confusing error message, so this patch updates the manual to note
this and remove the space in an example that uses it.

  -- (

 doc/contributing.texi | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/doc/contributing.texi b/doc/contributing.texi
index 40ae33ecac..913c7cf436 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -1462,10 +1462,16 @@ address and the @option{-v} flag with @command{git send-email}.
 
 @example
 $ git commit -a
-$ git send-email -1 -a --base=auto -v @var{REVISION} \
+$ git send-email -1 -a --base=auto -v <at> var{REVISION} \
       --to=@var{ISSUE_NUMBER}@@debbugs.gnu.org
 @end example
 
+@quotation Note
+Due to an apparent bug in @command{git send-email},
+@option{-v @var{REVISION}} (with the space) will not work; you
+@emph{must} use @option{-v <at> var{REVISION}}.
+@end quotation
+
 You can find out @var{ISSUE_NUMBER} either by searching on the mumi
 interface at @url{issues.guix.gnu.org} for the name of your patch or
 reading the acknowledgement email sent automatically by Debbugs in

base-commit: d33ed58169edc027cfb6c256ecabde87e59918ed
-- 
2.38.1





Information forwarded to guix-patches <at> gnu.org:
bug#59523; Package guix-patches. (Wed, 23 Nov 2022 19:30:02 GMT) Full text and rfc822 format available.

Message #8 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Tobias Geerinckx-Rice <me <at> tobias.gr>
To: "(" <paren <at> disroot.org>
Cc: 59523 <at> debbugs.gnu.org, guix-patches <at> gnu.org
Subject: Re: [bug#59523] [PATCH] doc: contributing: Note '-v REVISION' bug
 in 'git send-email'.
Date: Wed, 23 Nov 2022 20:30:11 +0100
[Message part 1 (text/plain, inline)]
"( via Guix-patches" via 写道:
> Turns out that due to a bug in ``git send-email'', using ``-v 
> 2''

Has this been reported upstream?

Kind regards,

T G-R
[signature.asc (application/pgp-signature, inline)]

Information forwarded to guix-patches <at> gnu.org:
bug#59523; Package guix-patches. (Wed, 23 Nov 2022 19:30:03 GMT) Full text and rfc822 format available.

Information forwarded to guix-patches <at> gnu.org:
bug#59523; Package guix-patches. (Wed, 23 Nov 2022 20:51:02 GMT) Full text and rfc822 format available.

Message #14 received at submit <at> debbugs.gnu.org (full text, mbox):

From: zimoun <zimon.toutoune <at> gmail.com>
To: "( via Guix-patches via" <guix-patches <at> gnu.org>, 59523 <at> debbugs.gnu.org
Cc: "\(" <paren <at> disroot.org>
Subject: Re: [bug#59523] [PATCH] doc: contributing: Note '-v REVISION' bug
 in 'git send-email'.
Date: Wed, 23 Nov 2022 21:47:50 +0100
Hi,

On Wed, 23 Nov 2022 at 19:07, "\( via Guix-patches" via <guix-patches <at> gnu.org> wrote:

> Turns out that due to a bug in ``git send-email'', using ``-v 2'' with
> a space between the flag and the argument won't work. If you try it, it'll
> print a confusing error message, so this patch updates the manual to note
> this and remove the space in an example that uses it.

Arf clunky Git CLI. :-)  The git-format-patch manual says:

       -v <n>, --reroll-count=<n>

so the space is allowed and it seems to work.  The git-send-email
manual says,

       git send-email [<options>] <format-patch options>

and indeed,

--8<---------------cut here---------------start------------->8---
$ git send-email -1 -v 2 --to=trash <at> trash.com
fatal: ambiguous argument '2': unknown revision or path not in the working tree.
Use '--' to separate paths from revisions, like this:
'git <command> [<revision>...] -- [<file>...]'
format-patch -o /tmp/bin67IOTaX -1 2: command returned error: 128
--8<---------------cut here---------------end--------------->8---

But it works without the space.  Arf, Git CLI…


Cheers,
simon




Information forwarded to guix-patches <at> gnu.org:
bug#59523; Package guix-patches. (Wed, 23 Nov 2022 20:51:03 GMT) Full text and rfc822 format available.

Information forwarded to guix-patches <at> gnu.org:
bug#59523; Package guix-patches. (Wed, 23 Nov 2022 22:32:02 GMT) Full text and rfc822 format available.

Message #20 received at submit <at> debbugs.gnu.org (full text, mbox):

From: "(" <paren <at> disroot.org>
To: "Tobias Geerinckx-Rice" <me <at> tobias.gr>
Cc: 59523 <at> debbugs.gnu.org, guix-patches <at> gnu.org
Subject: Re: [bug#59523] [PATCH] doc: contributing: Note '-v REVISION' bug
 in 'git send-email'.
Date: Wed, 23 Nov 2022 22:31:02 +0000
On Wed Nov 23, 2022 at 7:30 PM GMT, Tobias Geerinckx-Rice wrote:
> Has this been reported upstream?

Not afaik. The person who originally noticed this said they had
considered reporting it but it looked like a pain to report. I'll
have a look myself in a moment.

    -- (




Information forwarded to guix-patches <at> gnu.org:
bug#59523; Package guix-patches. (Wed, 23 Nov 2022 22:32:03 GMT) Full text and rfc822 format available.

Information forwarded to guix-patches <at> gnu.org:
bug#59523; Package guix-patches. (Thu, 24 Nov 2022 02:05:01 GMT) Full text and rfc822 format available.

Message #26 received at 59523 <at> debbugs.gnu.org (full text, mbox):

From: Kyle Meyer <kyle <at> kyleam.com>
To: "(" <paren <at> disroot.org>, Tobias Geerinckx-Rice <me <at> tobias.gr>
Cc: 59523 <at> debbugs.gnu.org
Subject: Re: [bug#59523] [PATCH] doc: contributing: Note '-v REVISION' bug
 in 'git send-email'.
Date: Wed, 23 Nov 2022 21:04:46 -0500
"\( via Guix-patches" via writes:

> On Wed Nov 23, 2022 at 7:30 PM GMT, Tobias Geerinckx-Rice wrote:
>> Has this been reported upstream?
>
> Not afaik. The person who originally noticed this said they had
> considered reporting it but it looked like a pain to report. I'll
> have a look myself in a moment.

I've just sent a patch:

  https://lore.kernel.org/git/20221124020056.242185-1-kyle <at> kyleam.com




Information forwarded to guix-patches <at> gnu.org:
bug#59523; Package guix-patches. (Sat, 26 Nov 2022 11:55:02 GMT) Full text and rfc822 format available.

Message #29 received at 59523 <at> debbugs.gnu.org (full text, mbox):

From: "(" <paren <at> disroot.org>
To: 59523 <at> debbugs.gnu.org
Cc: "\(" <paren <at> disroot.org>
Subject: [PATCH v2 2/3] doc: contributing: Fix incorrect guix-patches address.
Date: Sat, 26 Nov 2022 11:54:25 +0000
* doc/contributing.texi ("Submitting Patches")
["Sending a Patch Series"]<"Multiple Patches">: Correct
'guix-patches <at> debbugs.gnu.org' to 'guix-patches <at> gnu.org'.
---
 doc/contributing.texi | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/contributing.texi b/doc/contributing.texi
index 913c7cf436..d2c1d69f69 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -1515,7 +1515,7 @@ that we can send the rest of the patches to.
 
 @example
 $ git send-email outgoing/0000-cover-letter.patch -a \
-      --to=guix-patches@@debbugs.gnu.org \
+      --to=guix-patches@@gnu.org \
       $(etc/teams.scm cc-members ...)
 $ rm outgoing/0000-cover-letter.patch # we don't want to resend it!
 @end example
-- 
2.38.1





Information forwarded to guix-patches <at> gnu.org:
bug#59523; Package guix-patches. (Sat, 26 Nov 2022 11:55:02 GMT) Full text and rfc822 format available.

Message #32 received at 59523 <at> debbugs.gnu.org (full text, mbox):

From: "(" <paren <at> disroot.org>
To: 59523 <at> debbugs.gnu.org
Cc: "\(" <paren <at> disroot.org>
Subject: [PATCH v2 1/3] doc: contributing: Note '-v REVISION' bug in 'git
 send-email'.
Date: Sat, 26 Nov 2022 11:54:24 +0000
* doc/contributing.texi ("Submitting Patches")["Sending a Patch Series"]:
Note that a bug in 'git send-email' means '-v REVISION' (with a
space) will not work.
---
 doc/contributing.texi | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/doc/contributing.texi b/doc/contributing.texi
index 40ae33ecac..913c7cf436 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -1462,10 +1462,16 @@ address and the @option{-v} flag with @command{git send-email}.
 
 @example
 $ git commit -a
-$ git send-email -1 -a --base=auto -v @var{REVISION} \
+$ git send-email -1 -a --base=auto -v <at> var{REVISION} \
       --to=@var{ISSUE_NUMBER}@@debbugs.gnu.org
 @end example
 
+@quotation Note
+Due to an apparent bug in @command{git send-email},
+@option{-v @var{REVISION}} (with the space) will not work; you
+@emph{must} use @option{-v <at> var{REVISION}}.
+@end quotation
+
 You can find out @var{ISSUE_NUMBER} either by searching on the mumi
 interface at @url{issues.guix.gnu.org} for the name of your patch or
 reading the acknowledgement email sent automatically by Debbugs in

base-commit: d33ed58169edc027cfb6c256ecabde87e59918ed
-- 
2.38.1





Information forwarded to guix-patches <at> gnu.org:
bug#59523; Package guix-patches. (Sat, 26 Nov 2022 11:55:03 GMT) Full text and rfc822 format available.

Message #35 received at 59523 <at> debbugs.gnu.org (full text, mbox):

From: "(" <paren <at> disroot.org>
To: 59523 <at> debbugs.gnu.org
Cc: "\(" <paren <at> disroot.org>
Subject: [PATCH v2 3/3] doc: contributing: Recommend --base=origin/master.
Date: Sat, 26 Nov 2022 11:54:26 +0000
* doc/contributing.texi ("Submitting Patches")
["Sending a Patch Series"]: Recommend --base=origin/master instead
of --base=auto.
---
 doc/contributing.texi | 19 +++++++++++--------
 1 file changed, 11 insertions(+), 8 deletions(-)

diff --git a/doc/contributing.texi b/doc/contributing.texi
index d2c1d69f69..edbdf2fded 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -1428,7 +1428,8 @@ open it in your @var{EDITOR} or @var{VISUAL} for editing, and send it to
 the Guix mailing list to be reviewed and merged:
 
 @example
-$ git send-email -1 -a --base=auto --to=guix-patches@@gnu.org
+$ git send-email -1 -a --base=origin/master \
+      --to=guix-patches@@gnu.org
 @end example
 
 @quotation Tip
@@ -1439,7 +1440,7 @@ other than the @code{master} branch of
 @url{https://git.savannah.gnu.org/cgit/guix.git}.
 
 @example
-git send-email -1 -a --base=auto \
+git send-email -1 -a --base=origin/master \
     --subject-prefix='PATCH core-updates' \
     --to=guix-patches@@gnu.org
 @end example
@@ -1450,9 +1451,11 @@ message.  You may ``annotate'' the patch with explanatory text by adding
 it under this line.  If you do not wish to annotate the email, you may
 drop the @option{-a} flag (which is short for @option{--annotate}).
 
-The @option{--base=auto} flag automatically adds a note at the bottom
-of the patch of the commit it was based on, making it easier for
-maintainers to rebase and merge your patch.
+The @option{--base=origin/master} flag automatically adds a note at the
+bottom of the patch of the commit hash of @code{origin/master}, making it
+easier for maintainers to rebase and merge your patch.  Of course, if
+your patchset is based on, say, @code{core-updates}, you need to use
+@option{--base=origin/core-updates}.
 
 If you need to send a revised patch, don't resend it like this or send
 a ``fix'' patch to be applied on top of the last one; instead, use
@@ -1462,7 +1465,7 @@ address and the @option{-v} flag with @command{git send-email}.
 
 @example
 $ git commit -a
-$ git send-email -1 -a --base=auto -v <at> var{REVISION} \
+$ git send-email -1 -a --base=origin/master -v <at> var{REVISION} \
       --to=@var{ISSUE_NUMBER}@@debbugs.gnu.org
 @end example
 
@@ -1506,7 +1509,7 @@ with @command{git format-patch}.
 
 @example
 $ git format-patch -@var{NUMBER_COMMITS} -o outgoing \
-      --cover-letter --base=auto
+      --cover-letter --base=origin/master
 @end example
 
 We can now send @emph{just} the cover letter to the
@@ -1540,7 +1543,7 @@ the patchset.
 
 @example
 $ git send-email -@var{NUMBER_COMMITS} \
-      -v <at> var{REVISION} --base=auto \
+      -v <at> var{REVISION} --base=origin/master \
       --to @var{ISSUE_NUMBER}@@debbugs.gnu.org
 @end example
 
-- 
2.38.1





Information forwarded to guix-patches <at> gnu.org:
bug#59523; Package guix-patches. (Fri, 02 Dec 2022 16:10:02 GMT) Full text and rfc822 format available.

Message #38 received at submit <at> debbugs.gnu.org (full text, mbox):

From: zimoun <zimon.toutoune <at> gmail.com>
To: "( via Guix-patches via" <guix-patches <at> gnu.org>, 59523 <at> debbugs.gnu.org
Cc: "\(" <paren <at> disroot.org>
Subject: Re: [bug#59523] [PATCH v2 1/3] doc: contributing: Note '-v
 REVISION' bug in 'git send-email'.
Date: Fri, 02 Dec 2022 17:09:12 +0100
Hi,

On Sat, 26 Nov 2022 at 11:54, "\( via Guix-patches" via <guix-patches <at> gnu.org> wrote:
> * doc/contributing.texi ("Submitting Patches")["Sending a Patch Series"]:
> Note that a bug in 'git send-email' means '-v REVISION' (with a
> space) will not work.

This patch and all the 2 others LGTM.

Cheers,
simon




Information forwarded to guix-patches <at> gnu.org:
bug#59523; Package guix-patches. (Fri, 02 Dec 2022 16:10:03 GMT) Full text and rfc822 format available.

Information forwarded to guix-patches <at> gnu.org:
bug#59523; Package guix-patches. (Wed, 11 Jan 2023 10:59:02 GMT) Full text and rfc822 format available.

Message #44 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Christopher Baines <mail <at> cbaines.net>
To: "(" <paren <at> disroot.org>
Cc: 59523 <at> debbugs.gnu.org, guix-patches <at> gnu.org
Subject: Re: [bug#59523] [PATCH v2 1/3] doc: contributing: Note '-v
 REVISION' bug in 'git send-email'.
Date: Wed, 11 Jan 2023 10:57:59 +0000
[Message part 1 (text/plain, inline)]
"( via Guix-patches" via <guix-patches <at> gnu.org> writes:

> * doc/contributing.texi ("Submitting Patches")["Sending a Patch Series"]:
> Note that a bug in 'git send-email' means '-v REVISION' (with a
> space) will not work.
> ---
>  doc/contributing.texi | 8 +++++++-
>  1 file changed, 7 insertions(+), 1 deletion(-)

I've pushed this to master now as
09cd488c973c2ea27cfa2224489aca317f596341.

Thanks,

Chris
[signature.asc (application/pgp-signature, inline)]

Information forwarded to guix-patches <at> gnu.org:
bug#59523; Package guix-patches. (Wed, 11 Jan 2023 10:59:02 GMT) Full text and rfc822 format available.

Information forwarded to guix-patches <at> gnu.org:
bug#59523; Package guix-patches. (Wed, 11 Jan 2023 11:00:02 GMT) Full text and rfc822 format available.

Message #50 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Christopher Baines <mail <at> cbaines.net>
To: "(" <paren <at> disroot.org>
Cc: 59523 <at> debbugs.gnu.org, guix-patches <at> gnu.org
Subject: Re: [bug#59523] [PATCH v2 3/3] doc: contributing: Recommend
 --base=origin/master.
Date: Wed, 11 Jan 2023 10:58:25 +0000
[Message part 1 (text/plain, inline)]
"( via Guix-patches" via <guix-patches <at> gnu.org> writes:

> * doc/contributing.texi ("Submitting Patches")
> ["Sending a Patch Series"]: Recommend --base=origin/master instead
> of --base=auto.
> ---
>  doc/contributing.texi | 19 +++++++++++--------
>  1 file changed, 11 insertions(+), 8 deletions(-)

I think this is the last patch associated with this bug that hasn't been
merged.

I did have a look at it, but the commit message is missing the reasoning
for the change, what's the intent behind changing the recommendation?

Chris
[signature.asc (application/pgp-signature, inline)]

Information forwarded to guix-patches <at> gnu.org:
bug#59523; Package guix-patches. (Wed, 11 Jan 2023 11:00:03 GMT) Full text and rfc822 format available.

Information forwarded to guix-patches <at> gnu.org:
bug#59523; Package guix-patches. (Wed, 11 Jan 2023 17:07:02 GMT) Full text and rfc822 format available.

Message #56 received at submit <at> debbugs.gnu.org (full text, mbox):

From: "(" <paren <at> disroot.org>
To: "Christopher Baines" <mail <at> cbaines.net>
Cc: 59523 <at> debbugs.gnu.org, guix-patches <at> gnu.org
Subject: Re: [bug#59523] [PATCH v2 3/3] doc: contributing: Recommend
 --base=origin/master.
Date: Wed, 11 Jan 2023 17:05:52 +0000
[Message part 1 (text/plain, inline)]
On Wed Jan 11, 2023 at 10:58 AM GMT, Christopher Baines wrote:
> I did have a look at it, but the commit message is missing the reasoning
> for the change, what's the intent behind changing the recommendation?

It's because with --base=auto, you need to git branch --set-upstream=<branch> first.
You might as well just use --base=origin/master instead...

    -- (
[signature.asc (application/pgp-signature, inline)]

Information forwarded to guix-patches <at> gnu.org:
bug#59523; Package guix-patches. (Wed, 11 Jan 2023 17:07:02 GMT) Full text and rfc822 format available.

Information forwarded to guix-patches <at> gnu.org:
bug#59523; Package guix-patches. (Mon, 13 Mar 2023 23:45:02 GMT) Full text and rfc822 format available.

Message #62 received at 59523 <at> debbugs.gnu.org (full text, mbox):

From: Kyle Meyer <kyle <at> kyleam.com>
To: "(" <paren <at> disroot.org>
Cc: 59523 <at> debbugs.gnu.org, Tobias Geerinckx-Rice <me <at> tobias.gr>
Subject: Re: [bug#59523] [PATCH] doc: contributing: Note '-v REVISION' bug
 in 'git send-email'.
Date: Mon, 13 Mar 2023 19:43:55 -0400
Kyle Meyer writes:

> I've just sent a patch:
>
>   https://lore.kernel.org/git/20221124020056.242185-1-kyle <at> kyleam.com

Just to close the loop here: that landed in Git v2.40.0.




Information forwarded to guix-patches <at> gnu.org:
bug#59523; Package guix-patches. (Tue, 21 Mar 2023 12:36:02 GMT) Full text and rfc822 format available.

Message #65 received at 59523 <at> debbugs.gnu.org (full text, mbox):

From: Maxim Cournoyer <maxim.cournoyer <at> gmail.com>
To: Kyle Meyer <kyle <at> kyleam.com>
Cc: "\(" <paren <at> disroot.org>, Tobias Geerinckx-Rice <me <at> tobias.gr>,
 59523 <at> debbugs.gnu.org
Subject: Re: bug#59523: [PATCH] doc: contributing: Note '-v REVISION' bug in
 'git send-email'.
Date: Tue, 21 Mar 2023 08:34:53 -0400
Hi,

Kyle Meyer <kyle <at> kyleam.com> writes:

> Kyle Meyer writes:
>
>> I've just sent a patch:
>>
>>   https://lore.kernel.org/git/20221124020056.242185-1-kyle <at> kyleam.com
>
> Just to close the loop here: that landed in Git v2.40.0.

Awesome.  We're now at 2.39, so it seems we can just wait a bit to get
2.40 and then close this issue.

-- 
Thanks,
Maxim




Reply sent to Maxim Cournoyer <maxim.cournoyer <at> gmail.com>:
You have taken responsibility. (Tue, 21 Mar 2023 12:42:02 GMT) Full text and rfc822 format available.

Notification sent to "(" <paren <at> disroot.org>:
bug acknowledged by developer. (Tue, 21 Mar 2023 12:42:02 GMT) Full text and rfc822 format available.

Message #70 received at 59523-done <at> debbugs.gnu.org (full text, mbox):

From: Maxim Cournoyer <maxim.cournoyer <at> gmail.com>
To: Christopher Baines <mail <at> cbaines.net>
Cc: "\(" <paren <at> disroot.org>, 59523-done <at> debbugs.gnu.org
Subject: Re: bug#59523: [PATCH] doc: contributing: Note '-v REVISION' bug in
 'git send-email'.
Date: Tue, 21 Mar 2023 08:41:47 -0400
Hi,

Christopher Baines <mail <at> cbaines.net> writes:

> "( via Guix-patches" via <guix-patches <at> gnu.org> writes:
>
>> * doc/contributing.texi ("Submitting Patches")["Sending a Patch Series"]:
>> Note that a bug in 'git send-email' means '-v REVISION' (with a
>> space) will not work.
>> ---
>>  doc/contributing.texi | 8 +++++++-
>>  1 file changed, 7 insertions(+), 1 deletion(-)
>
> I've pushed this to master now as
> 09cd488c973c2ea27cfa2224489aca317f596341.

OK! Don't forget to revert when git 2.40 lands in master, as it includes
a fix.

-- 
Thanks,
Maxim




bug archived. Request was from Debbugs Internal Request <help-debbugs <at> gnu.org> to internal_control <at> debbugs.gnu.org. (Wed, 19 Apr 2023 11:24:09 GMT) Full text and rfc822 format available.

This bug report was last modified 344 days ago.

Previous Next


GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.