diff mbox

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

Message ID 1441727239-17284-1-git-send-email-francesco.nwokeka@gmail.com
State Accepted
Headers show

Commit Message

Francesco Nwokeka Sept. 8, 2015, 3:47 p.m. UTC
Added an alternative on patch versioning (the -v option) and added a tip on how to automatically mark a previous commit as superseded

Signed-off-by: Francesco Nwokeka <francesco.nwokeka@gmail.com>

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

Signed-off-by: Francesco Nwokeka <francesco.nwokeka@gmail.com>
---
 docs/manual/contribute.txt | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

Comments

Fabio Porcedda Sept. 15, 2015, 2:03 p.m. UTC | #1
On Tue, Sep 8, 2015 at 5:47 PM, Francesco Nwokeka <
francesco.nwokeka@gmail.com> wrote:

> Added an alternative on patch versioning (the -v option) and added a tip
> on how to automatically mark a previous commit as superseded
>
> Signed-off-by: Francesco Nwokeka <francesco.nwokeka@gmail.com>


<snip>

+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.
> +
>

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
Arnout Vandecappelle Sept. 15, 2015, 8:35 p.m. UTC | #2
On 15-09-15 16:03, Fabio Porcedda wrote:
> On Tue, Sep 8, 2015 at 5:47 PM, Francesco Nwokeka <francesco.nwokeka@gmail.com
> <mailto:francesco.nwokeka@gmail.com>> wrote:
[snip]
>     +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.
>     +
> 
> 
> 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
Thomas Petazzoni Sept. 19, 2015, 1:57 p.m. UTC | #3
Dear Francesco Nwokeka,

On Tue,  8 Sep 2015 17:47:19 +0200, Francesco Nwokeka wrote:
> Added an alternative on patch versioning (the -v option) and added a tip on how to automatically mark a previous commit as superseded
> 
> Signed-off-by: Francesco Nwokeka <francesco.nwokeka@gmail.com>
> 
> ---
> 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
diff mbox

Patch

diff --git a/docs/manual/contribute.txt b/docs/manual/contribute.txt
index 40579f9..4dae676 100644
--- a/docs/manual/contribute.txt
+++ b/docs/manual/contribute.txt
@@ -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