Skip to contentSkip to conversation

docs/website: contribute.txt update with useful tips on patch versioning and patch submission

PATCH Superseded Francesco Nwokeka 4 participants 10 messages Sep 8, 2015 – Sep 19, 2015

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs/website: contribute.txt update with useful tips on patch versioning and patch submission

Added an alternative on patch versioning (the -v option) and added a tip on how to automatically mark a previous commit as superseded

---
 docs/manual/contribute.txt | 9 +++++++++
 1 file changed, 9 insertions(+)
docs/manual/contribute.txt +9 -0
index 40579f9..1ab8ef8 100644
@@ -298,6 +298,12 @@ $ git format-patch --subject-prefix "PATCH v4" \
     -M -s -o outgoing origin/master
 ---------------------
 
+or the +-v <n>+ flag (where <n> is the version number):
+
+---------------------
+$ git format-patch -v4 -M -s -o outgoing origin/master
+---------------------
+
 When you provide a new version of a patch, please mark the old one as
 superseded in http://patchwork.buildroot.org[patchwork]. You need to
 create an account on http://patchwork.buildroot.org[patchwork] to be
@@ -306,6 +312,9 @@ the status of patches you submitted yourself, which means the email
 address you register in http://patchwork.buildroot.org[patchwork] should
 match the one you use for sending patches to the mailing list.
 
+[NOTE]
+_You can also add the +--in-reply-to "<previous-version-id>"+ flag when submitting a patch to the mailing list (via git sendmail). The id of the mail to reply to can be found under the "Message Id" tag on the patchwork website. The advantage of *in-reply-to* is that patchwork will automatically mark the previous patch as superseded_
+
 [[reporting-bugs]]
 === Reporting issues/bugs or getting help
 
Signature · 1 line
2.5.1
#1 lore raw

PATCH 1/1 docs/website: contribute.txt update with useful tips on patch versioning and patch submission

Quoted 12 lines · Francesco Nwokeka

Added an alternative on patch versioning (the -v option) and added a tip on how to automatically mark a previous commit as superseded

---
 docs/manual/contribute.txt | 9 +++++++++
 1 file changed, 9 insertions(+)
docs/manual/contribute.txt +0 -0
index 40579f9..1ab8ef8 100644

docs/manual/contribute.txt $ git format-patch --subject-prefix "PATCH v4" \ · line 306

Quoted 9 lines
docs/manual/contribute.txt +6 -0
@@ -298,6 +298,12 @@ $ git format-patch --subject-prefix "PATCH v4" \
     -M -s -o outgoing origin/master
 ---------------------
 
+or the +-v <n>+ flag (where <n> is the version number):
+
+---------------------
+$ git format-patch -v4 -M -s -o outgoing origin/master
+---------------------
+

This option exists since git v1.8.1

docs/manual/contribute.txt the status of patches you submitted yourself, which means the email · line 315

Quoted 8 lines
docs/manual/contribute.txt +1 -0
 When you provide a new version of a patch, please mark the old one as
 superseded in http://patchwork.buildroot.org[patchwork]. You need to
 create an account on http://patchwork.buildroot.org[patchwork] to be
@@ -306,6 +312,9 @@ the status of patches you submitted yourself, which means the email
 address you register in http://patchwork.buildroot.org[patchwork] should
 match the one you use for sending patches to the mailing list.
 
+[NOTE]

I don't think this tag is needed.

docs/manual/contribute.txt the status of patches you submitted yourself, which means the email · line 316

Quoted 1 line
docs/manual/contribute.txt +1 -0
+_You can also add the +--in-reply-to "<previous-version-id>"+ flag when submitting a patch to the mailing list (via git sendmail). The id of the mail to reply to can be found under the "Message Id" tag on the patchwork website. The advantage of *in-reply-to* is that patchwork will automatically mark the previous patch as superseded_

Please split lines at 80 columns.

The italics is also not needed.

<previous-version-id> should be <message-id>.

--in-reply-to is an option of format-patch, so there's no need to mention the
(via git sendmail) (which is anyway wrong, since it's git send-email).

Regards,
Arnout

Quoted 5 lines
docs/manual/contribute.txt +1 -0
+
 [[reporting-bugs]]
 === Reporting issues/bugs or getting help
 
Signature · 6 lines
Arnout Vandecappelle                          arnout at mind be
Senior Embedded Software Architect            +32-16-286500
Essensium/Mind                                http://www.mind.be
G.Geenslaan 9, 3001 Leuven, Belgium           BE 872 984 063 RPR Leuven
LinkedIn profile: http://www.linkedin.com/in/arnoutvandecappelle
GPG fingerprint:  7493 020B C7E3 8618 8DEC 222C 82EB F404 F9AC 0DDF
#2 lore raw

PATCH 1/1 docs/website: contribute.txt update with useful tips on patch versioning and patch submission

Quoted 16 lines · On Tuesday 08 September 2015 15:46:36 Arnout Vandecappelle wrote:
Quoted 15 lines · Francesco Nwokeka

Added an alternative on patch versioning (the -v option) and added a tip on how to automatically mark a previous commit as superseded

---
 docs/manual/contribute.txt | 9 +++++++++
 1 file changed, 9 insertions(+)
docs/manual/contribute.txt +0 -0
index 40579f9..1ab8ef8 100644
@@ -298,6 +298,12 @@ $ git format-patch --subject-prefix "PATCH v4" \
     -M -s -o outgoing origin/master
 ---------------------
 
Quoted 8 lines

docs/manual/contribute.txt $ git format-patch --subject-prefix "PATCH v4" \ · line 306

Quoted 6 lines
docs/manual/contribute.txt +6 -0
+or the +-v <n>+ flag (where <n> is the version number):
+
+---------------------
+$ git format-patch -v4 -M -s -o outgoing origin/master
+---------------------
+

This option exists since git v1.8.1

Am I to specify the git version on the documentation or was it just a "fyi" statement?

Quoted 13 lines

docs/manual/contribute.txt the status of patches you submitted yourself, which means the email · line 315

Quoted 8 lines
docs/manual/contribute.txt +1 -0
 When you provide a new version of a patch, please mark the old one as
 superseded in http://patchwork.buildroot.org[patchwork]. You need to
 create an account on http://patchwork.buildroot.org[patchwork] to be
@@ -306,6 +312,9 @@ the status of patches you submitted yourself, which means the email
 address you register in http://patchwork.buildroot.org[patchwork] should
 match the one you use for sending patches to the mailing list.
 
+[NOTE]

I don't think this tag is needed.

docs/manual/contribute.txt the status of patches you submitted yourself, which means the email · line 316

Quoted 1 line
docs/manual/contribute.txt +1 -0
+_You can also add the +--in-reply-to "<previous-version-id>"+ flag when submitting a patch to the mailing list (via git sendmail). The id of the mail to reply to can be found under the "Message Id" tag on the patchwork website. The advantage of *in-reply-to* is that patchwork will automatically mark the previous patch as superseded_
Quoted 8 lines

Please split lines at 80 columns.

The italics is also not needed.

<previous-version-id> should be <message-id>.

--in-reply-to is an option of format-patch, so there's no need to mention the
(via git sendmail) (which is anyway wrong, since it's git send-email).

Noted and updated

Quoted 12 lines

Regards,
Arnout

Quoted 5 lines
docs/manual/contribute.txt +1 -0
+
 [[reporting-bugs]]
 === Reporting issues/bugs or getting help
 
#3 lore raw

PATCH 1/1 docs/website: contribute.txt update with useful tips on patch versioning and patch submission

Quoted 26 lines · Francesco Nwokeka
Quoted 16 lines · On Tuesday 08 September 2015 15:46:36 Arnout Vandecappelle wrote:
Quoted 15 lines · Francesco Nwokeka

Added an alternative on patch versioning (the -v option) and added a tip on how to automatically mark a previous commit as superseded

---
 docs/manual/contribute.txt | 9 +++++++++
 1 file changed, 9 insertions(+)
docs/manual/contribute.txt +0 -0
index 40579f9..1ab8ef8 100644
@@ -298,6 +298,12 @@ $ git format-patch --subject-prefix "PATCH v4" \
     -M -s -o outgoing origin/master
 ---------------------
 
Quoted 8 lines

docs/manual/contribute.txt $ git format-patch --subject-prefix "PATCH v4" \ · line 306

Quoted 6 lines
docs/manual/contribute.txt +6 -0
+or the +-v <n>+ flag (where <n> is the version number):
+
+---------------------
+$ git format-patch -v4 -M -s -o outgoing origin/master
+---------------------
+

This option exists since git v1.8.1

Quoted 1 line

Am I to specify the git version on the documentation or was it just a "fyi" statement?

Yes, it should be mentioned in the documentation, otherwise people will try the
-v option and wonder why it doesn't work.

Regards,
Arnout

[snip]

Signature · 6 lines
Arnout Vandecappelle      arnout dot vandecappelle at essensium dot com
Senior Embedded Software Architect . . . . . . +32-478-010353 (mobile)
Essensium, Mind division . . . . . . . . . . . . . . http://www.mind.be
G.Geenslaan 9, 3001 Leuven, Belgium . . . . . BE 872 984 063 RPR Leuven
LinkedIn profile: http://www.linkedin.com/in/arnoutvandecappelle
GPG fingerprint:  7493 020B C7E3 8618 8DEC 222C 82EB F404 F9AC 0DDF
#4 lore raw

PATCH v2 1/1 docs/website: contribute.txt update with useful tips on patch versioning and patch submission

In reply to Francesco Nwokeka

Added an alternative on patch versioning (the -v option) and added a tip on how to automatically mark a previous commit as superseded

---
v1 -> v2: adjusted previous patch with observations from mailing list

---
 docs/manual/contribute.txt | 13 +++++++++++++
 1 file changed, 13 insertions(+)
docs/manual/contribute.txt +13 -0
index 40579f9..e8707cc 100644
@@ -298,6 +298,13 @@ $ git format-patch --subject-prefix "PATCH v4" \
     -M -s -o outgoing origin/master
 ---------------------
 
+Since git version 1.8.1, you can also use +-v <n>+ (where <n> is the
+version number):
+
+---------------------
+$ git format-patch -v4 -M -s -o outgoing origin/master
+---------------------
+
 When you provide a new version of a patch, please mark the old one as
 superseded in http://patchwork.buildroot.org[patchwork]. You need to
 create an account on http://patchwork.buildroot.org[patchwork] to be
@@ -306,6 +313,12 @@ the status of patches you submitted yourself, which means the email
 address you register in http://patchwork.buildroot.org[patchwork] should
 match the one you use for sending patches to the mailing list.
 
+You can also add the +--in-reply-to <message-id>+ flag when
+submitting a patch to the mailing list. The id of the mail
+to reply to can be found under the "Message Id" tag on the patchwork website.
+The advantage of *in-reply-to* is that patchwork will automatically mark the
+previous patch as superseded.
+
 [[reporting-bugs]]
 === Reporting issues/bugs or getting help
 
Signature · 1 line
2.5.1
#5 lore raw

PATCH v2 1/1 docs/website: contribute.txt update with useful tips on patch versioning and patch submission

Quoted 31 lines · Francesco Nwokeka

Added an alternative on patch versioning (the -v option) and added a tip on how to automatically mark a previous commit as superseded

---
v1 -> v2: adjusted previous patch with observations from mailing list

---
 docs/manual/contribute.txt | 13 +++++++++++++
 1 file changed, 13 insertions(+)
docs/manual/contribute.txt +7 -0
index 40579f9..e8707cc 100644
@@ -298,6 +298,13 @@ $ git format-patch --subject-prefix "PATCH v4" \
     -M -s -o outgoing origin/master
 ---------------------
 
+Since git version 1.8.1, you can also use +-v <n>+ (where <n> is the
+version number):
+
+---------------------
+$ git format-patch -v4 -M -s -o outgoing origin/master
+---------------------
+
 When you provide a new version of a patch, please mark the old one as
 superseded in http://patchwork.buildroot.org[patchwork]. You need to
 create an account on http://patchwork.buildroot.org[patchwork] to be

docs/manual/contribute.txt the status of patches you submitted yourself, which means the email · line 318

Quoted 6 lines
docs/manual/contribute.txt +3 -0
@@ -306,6 +313,12 @@ the status of patches you submitted yourself, which means the email
 address you register in http://patchwork.buildroot.org[patchwork] should
 match the one you use for sending patches to the mailing list.
 
+You can also add the +--in-reply-to <message-id>+ flag when
+submitting a patch to the mailing list. The id of the mail
+to reply to can be found under the "Message Id" tag on the patchwork website.

Minor nit: in other places we always use
http://patchwork.buildroot.org[patchwork] instead of 'the patchwork website'.

Otherwise, looks good to me:

Quoted 7 lines
docs/manual/contribute.txt +3 -0
+The advantage of *in-reply-to* is that patchwork will automatically mark the
+previous patch as superseded.
+
 [[reporting-bugs]]
 === Reporting issues/bugs or getting help
 
Signature · 6 lines
Arnout Vandecappelle                          arnout at mind be
Senior Embedded Software Architect            +32-16-286500
Essensium/Mind                                http://www.mind.be
G.Geenslaan 9, 3001 Leuven, Belgium           BE 872 984 063 RPR Leuven
LinkedIn profile: http://www.linkedin.com/in/arnoutvandecappelle
GPG fingerprint:  7493 020B C7E3 8618 8DEC 222C 82EB F404 F9AC 0DDF
#6 lore raw

PATCH v3 1/1 docs/website: contribute.txt update with useful tips on patch versioning and patch submission

In reply to Francesco Nwokeka

Added an alternative on patch versioning (the -v option) and added a tip on how to automatically mark a previous commit as superseded

---
v1 -> v2: adjusted previous patch with observations from mailing list v2 -> v3: Replaced "the patchwork website" with a link to the project website

---
 docs/manual/contribute.txt | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
docs/manual/contribute.txt +14 -0
index 40579f9..4dae676 100644
@@ -298,6 +298,13 @@ $ git format-patch --subject-prefix "PATCH v4" \
     -M -s -o outgoing origin/master
 ---------------------
 
+Since git version 1.8.1, you can also use +-v <n>+ (where <n> is the
+version number):
+
+---------------------
+$ git format-patch -v4 -M -s -o outgoing origin/master
+---------------------
+
 When you provide a new version of a patch, please mark the old one as
 superseded in http://patchwork.buildroot.org[patchwork]. You need to
 create an account on http://patchwork.buildroot.org[patchwork] to be
@@ -306,6 +313,13 @@ the status of patches you submitted yourself, which means the email
 address you register in http://patchwork.buildroot.org[patchwork] should
 match the one you use for sending patches to the mailing list.
 
+You can also add the +--in-reply-to <message-id>+ flag when
+submitting a patch to the mailing list. The id of the mail
+to reply to can be found under the "Message Id" tag on
+http://patchwork.buildroot.org[patchwork].
+The advantage of *in-reply-to* is that patchwork will automatically mark the
+previous patch as superseded.
+
 [[reporting-bugs]]
 === Reporting issues/bugs or getting help
 
Signature · 1 line
2.5.1
#7 lore raw

PATCH v3 1/1 docs/website: contribute.txt update with useful tips on patch versioning and patch submission

Quoted 4 lines · Francesco Nwokeka

Added an alternative on patch versioning (the -v option) and added a tip on how to automatically mark a previous commit as superseded

<snip>

+You can also add the +--in-reply-to <message-id>+ flag when

docs/manual/contribute.txt the status of patches you submitted yourself, which means the email · line 322

Quoted 8 lines
docs/manual/contribute.txt +4 -0
+submitting a patch to the mailing list. The id of the mail
+to reply to can be found under the "Message Id" tag on
+http://patchwork.buildroot.org[patchwork].
+The advantage of *in-reply-to* is that patchwork will automatically mark

the

docs/manual/contribute.txt +2 -0
+previous patch as superseded.
+

I've sent the "[PATCH v2] barebox: bump to version 2015.09.0"(
http://lists.busybox.net/pipermail/buildroot/2015-September/139495.html)
using the --in-reply-to option of format-patch, but patchwork didn't make the v1 as superseded, I've done something wrong?

v2: http://patchwork.ozlabs.org/patch/517503/
v1: http://patchwork.ozlabs.org/patch/517494/

Best regards

Signature · 4 lines
Fabio Porcedda
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.busybox.net/pipermail/buildroot/attachments/20150915/97a9e518/attachment.html>
#8 lore raw

PATCH v3 1/1 docs/website: contribute.txt update with useful tips on patch versioning and patch submission

Quoted 2 lines · Fabio Porcedda

On Tue, Sep 8, 2015 at 5:47 PM, Francesco Nwokeka <[email protected] <mailto:[email protected]>> wrote:

[snip]

Quoted 9 lines

+You can also add the +--in-reply-to <message-id>+ flag when +submitting a patch to the mailing list. The id of the mail
+to reply to can be found under the "Message Id" tag on +http://patchwork.buildroot.org[patchwork].
+The advantage of *in-reply-to* is that patchwork will automatically mark the +previous patch as superseded.
+

Quoted 7 lines

I've sent the "[PATCH v2] barebox: bump to version 2015.09.0"(http://lists.busybox.net/pipermail/buildroot/2015-September/139495.html) using the --in-reply-to option of format-patch, but patchwork didn't make the v1 as superseded, I've done something wrong?

v2: http://patchwork.ozlabs.org/patch/517503/
v1: http://patchwork.ozlabs.org/patch/517494/

Weird, that normally should work, I've checked the headers and they look OK...
Patchwork isn't perfect about making the link but with in-reply-to I've not seen it go wrong yet.

I've now manually marked the v1 as superseded.

Regards,
Arnout

Signature · 6 lines
Arnout Vandecappelle                          arnout at mind be
Senior Embedded Software Architect            +32-16-286500
Essensium/Mind                                http://www.mind.be
G.Geenslaan 9, 3001 Leuven, Belgium           BE 872 984 063 RPR Leuven
LinkedIn profile: http://www.linkedin.com/in/arnoutvandecappelle
GPG fingerprint:  7493 020B C7E3 8618 8DEC 222C 82EB F404 F9AC 0DDF
#9 lore raw

PATCH v3 1/1 docs/website: contribute.txt update with useful tips on patch versioning and patch submission

In reply to Francesco Nwokeka

Dear Francesco Nwokeka,

Quoted 7 lines · Francesco Nwokeka

Added an alternative on patch versioning (the -v option) and added a tip on how to automatically mark a previous commit as superseded

---
v1 -> v2: adjusted previous patch with observations from mailing list v2 -> v3: Replaced "the patchwork website" with a link to the project website

Applied after doing some minor tweaks (commit title too long, and minor rewording about in-reply-to).

Thanks!

Thomas

Signature · 3 lines
Thomas Petazzoni, CTO, Free Electrons
Embedded Linux, Kernel and Android engineering
http://free-electrons.com