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

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

[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

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

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

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

[Arnout Vandecappelle]

On 08-09-15 15:22, 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>
> ---
>  docs/manual/contribute.txt | 9 +++++++++
>  1 file changed, 9 insertions(+)
> 
> diff --git a/docs/manual/contribute.txt b/docs/manual/contribute.txt
> index 40579f9..1ab8ef8 100644
> --- a/docs/manual/contribute.txt
> +++ b/docs/manual/contribute.txt
> @@ -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

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

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


> +
>  [[reporting-bugs]]
>  === Reporting issues/bugs or getting help
>  
> 


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

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

[Francesco Nwokeka]

On Tuesday 08 September 2015 15:46:36 Arnout Vandecappelle wrote:
> On 08-09-15 15:22, 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>
> > ---
> >  docs/manual/contribute.txt | 9 +++++++++
> >  1 file changed, 9 insertions(+)
> > 
> > diff --git a/docs/manual/contribute.txt b/docs/manual/contribute.txt
> > index 40579f9..1ab8ef8 100644
> > --- a/docs/manual/contribute.txt
> > +++ b/docs/manual/contribute.txt
> > @@ -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

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


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

Noted and updated


>  Regards,
>  Arnout
> 
> 
> > +
> >  [[reporting-bugs]]
> >  === Reporting issues/bugs or getting help
> >  
> > 
> 
> 
> 

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

[Arnout Vandecappelle]

On 08-09-15 16:57, Francesco Nwokeka wrote:
> On Tuesday 08 September 2015 15:46:36 Arnout Vandecappelle wrote:
>> On 08-09-15 15:22, 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>
>>> ---
>>>  docs/manual/contribute.txt | 9 +++++++++
>>>  1 file changed, 9 insertions(+)
>>>
>>> diff --git a/docs/manual/contribute.txt b/docs/manual/contribute.txt
>>> index 40579f9..1ab8ef8 100644
>>> --- a/docs/manual/contribute.txt
>>> +++ b/docs/manual/contribute.txt
>>> @@ -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
> 
> 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]
-- 
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

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

[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

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

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

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

diff --git a/docs/manual/contribute.txt b/docs/manual/contribute.txt
index 40579f9..e8707cc 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,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
 
-- 
2.5.1

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

[Arnout Vandecappelle]

On 08-09-15 17:28, 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
> 
> Signed-off-by: Francesco Nwokeka <francesco.nwokeka@gmail.com>
> ---
>  docs/manual/contribute.txt | 13 +++++++++++++
>  1 file changed, 13 insertions(+)
> 
> diff --git a/docs/manual/contribute.txt b/docs/manual/contribute.txt
> index 40579f9..e8707cc 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,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:

Acked-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>

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


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

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

[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

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(+)

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
 
-- 
2.5.1

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

[Fabio Porcedda]

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
-- 
Fabio Porcedda
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.busybox.net/pipermail/buildroot/attachments/20150915/97a9e518/attachment.html>

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

[Arnout Vandecappelle]

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


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

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

[Thomas Petazzoni]

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
-- 
Thomas Petazzoni, CTO, Free Electrons
Embedded Linux, Kernel and Android engineering
http://free-electrons.com