[dpdk-web] [PATCH 1/3] move up contribution guidelines link

[dpdk-web] [PATCH 1/3] move up contribution guidelines link

[Nelio Laranjeiro]

Too many people consider this section as a main reference whereas it is
only a snippet of the fully detailed contribution guides.  Moving it to the
beginning of the section should help newbies to read it instead of applying
a bash of command lines which rarely ends well.

Signed-off-by: Nelio Laranjeiro <nelio.laranjeiro@6wind.com>
---
 dev.html | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/dev.html b/dev.html
index cb65f51..2261aa1 100644
--- a/dev.html
+++ b/dev.html
@@ -57,6 +57,10 @@
 	<p>Focus is on next version in git <em>HEAD</em>. There is no maintenance of previous versions.
 
 	<h3 id="send">Contribute by sending patches</h3>
+	<p><b>Following lines are a snippet of
+	<a href="/doc/guides/contributing/patches.html">contribution guidelines</a>,
+	consult it for more details.</b>
+
 	<p>Patches should be sent and reviewed via the <a href="/ml/archives/dev">mailing list</a>.
 	Be sure <a href="/ml/listinfo/dev">to be registered</a>.
 	<p>To prepare a patch, it must be saved with
@@ -105,8 +109,6 @@
 	smtpencryption = ssl
 [alias]
 	fixline = log -1 --abbrev=12 --format='Fixes: %h (\"%s\")'</pre>
-	<p>The built-in documentation have more details about the
-	<a href="/doc/guides/contributing/patches.html">contribution guidelines</a>.
 
 	<h3 id="review">Contribute by testing or reviewing patches</h3>
 	<p>Patches are applied in the git repository when it becomes clear that
-- 
2.1.4

[dpdk-web] [PATCH 2/3] add alternative to send another patch version

[Nelio Laranjeiro]

Some versions of git send-emails does not have -v option, adding it on this
page helps user memory to work around this using git format-patch.

Signed-off-by: Nelio Laranjeiro <nelio.laranjeiro@6wind.com>
---
 dev.html | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/dev.html b/dev.html
index 2261aa1..bee2640 100644
--- a/dev.html
+++ b/dev.html
@@ -89,6 +89,12 @@
 	a version number and changelog annotations are helpful:
 	<pre>git send-email -1 -v2 --annotate --in-reply-to &lt;Message-ID of the previous patch&gt;
 --to dev@dpdk.org --cc &lt;everybody discussing the patch&gt;</pre>
+	<p>Another possibility is to use git format-patch:
+	<pre>git format-patch -1 --subject-prefix="PATCH v2"
+--in-reply-to &lt;Message-ID of the previous patch&gt;</pre>
+	<p>Then use send email:
+	<pre>git send-email --to dev@dpdk.org --cc &lt;everybody discussing
+the patch&gt; &lt;patch files&gt;</pre>
 	<p>Annotations take place after the 3 dashes and should explicit
 	what has changed since the previous version.
 	<p>In the case of a bug reported on the mailing list, the patch should be a reply to the bug report.
-- 
2.1.4

[dpdk-web] [PATCH 3/3] inform where Message ID can be found

[Nelio Laranjeiro]

Some people does not have the possibility to display Email Headers in their
client,  for them it is faster to get it from the patchwork.

Signed-off-by: Nelio Laranjeiro <nelio.laranjeiro@6wind.com>
---
 dev.html | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/dev.html b/dev.html
index bee2640..9bca15c 100644
--- a/dev.html
+++ b/dev.html
@@ -97,6 +97,8 @@
 the patch&gt; &lt;patch files&gt;</pre>
 	<p>Annotations take place after the 3 dashes and should explicit
 	what has changed since the previous version.
+	<p>Message ID can be found in previous sent email header or in the
+	<a href="http://dpdk.org/dev/patchwork/patch/7646/">patchwork patch</a> itself.
 	<p>In the case of a bug reported on the mailing list, the patch should be a reply to the bug report.
 	<p>An updated patchset should be a reply to the previous cover letter.
 	<p>When sending a patch serie, a cover letter may explain the global idea:
-- 
2.1.4

Re: [dpdk-web] [PATCH 1/3] move up contribution guidelines link

[Thomas Monjalon]

2016-07-27 14:15, Nelio Laranjeiro:
> Too many people consider this section as a main reference whereas it is
> only a snippet of the fully detailed contribution guides.  Moving it to the
> beginning of the section should help newbies to read it instead of applying
> a bash of command lines which rarely ends well.

Not so rarely :)

> +	<p><b>Following lines are a snippet of
> +	<a href="/doc/guides/contributing/patches.html">contribution guidelines</a>,
> +	consult it for more details.</b>

The last line "consult it for more details" is confusing and can be removed.

Re: [dpdk-web] [PATCH 2/3] add alternative to send another patch version

[Thomas Monjalon]

2016-07-27 14:15, Nelio Laranjeiro:
> Some versions of git send-emails does not have -v option, adding it on this
> page helps user memory to work around this using git format-patch.

Not sure we must give every details on this page.
As stated in patch 1, it is just a snippet of the guidelines.
I would be more in favor of removing some lines from this page.
The goal is to show that it can be simple (in some cases) to
send a small patch.

Re: [dpdk-web] [PATCH 3/3] inform where Message ID can be found

[Thomas Monjalon]

2016-07-27 14:15, Nelio Laranjeiro:
> Some people does not have the possibility to display Email Headers in their
> client,  for them it is faster to get it from the patchwork.

Yes

> +	<p>Message ID can be found in previous sent email header or in the
> +	<a href="http://dpdk.org/dev/patchwork/patch/7646/">patchwork patch</a> itself.

I suggest
The Message ID can be found in the email header of the previous patch or in its
patchwork page.

Re: [dpdk-web] [PATCH 1/3] move up contribution guidelines link

[Nélio Laranjeiro]

On Wed, Jul 27, 2016 at 03:01:09PM +0200, Thomas Monjalon wrote:
> 2016-07-27 14:15, Nelio Laranjeiro:
> > Too many people consider this section as a main reference whereas it is
> > only a snippet of the fully detailed contribution guides.  Moving it to the
> > beginning of the section should help newbies to read it instead of applying
> > a bash of command lines which rarely ends well.
> 
> Not so rarely :)

For myself, it was :)

I will change it in v2 for less.

> 
> > +	<p><b>Following lines are a snippet of
> > +	<a href="/doc/guides/contributing/patches.html">contribution guidelines</a>,
> > +	consult it for more details.</b>
> 
> The last line "consult it for more details" is confusing and can be removed.

Right.

-- 
Nélio Laranjeiro
6WIND

Re: [dpdk-web] [PATCH 2/3] add alternative to send another patch version

[Nélio Laranjeiro]

On Wed, Jul 27, 2016 at 03:03:29PM +0200, Thomas Monjalon wrote:
> 2016-07-27 14:15, Nelio Laranjeiro:
> > Some versions of git send-emails does not have -v option, adding it on this
> > page helps user memory to work around this using git format-patch.
> 
> Not sure we must give every details on this page.
> As stated in patch 1, it is just a snippet of the guidelines.
> I would be more in favor of removing some lines from this page.
> The goal is to show that it can be simple (in some cases) to
> send a small patch.

I agree, I remove this one in v2.

-- 
Nélio Laranjeiro
6WIND

Re: [dpdk-web] [PATCH 3/3] inform where Message ID can be found

[Nélio Laranjeiro]

On Wed, Jul 27, 2016 at 03:22:23PM +0200, Thomas Monjalon wrote:
> 2016-07-27 14:15, Nelio Laranjeiro:
> > Some people does not have the possibility to display Email Headers in their
> > client,  for them it is faster to get it from the patchwork.
> 
> Yes
> 
> > +	<p>Message ID can be found in previous sent email header or in the
> > +	<a href="http://dpdk.org/dev/patchwork/patch/7646/">patchwork patch</a> itself.
> 
> I suggest
> The Message ID can be found in the email header of the previous patch or in its
> patchwork page.
> 

Agreed.

I update and send a v2.

Thank you.

-- 
Nélio Laranjeiro
6WIND

[dpdk-web] [PATCH v2 1/2] move up contribution guidelines link

[Nelio Laranjeiro]

Too many people consider this section as a main reference whereas it is
only a snippet of the fully detailed contribution guides.  Moving it to the
beginning of the section should help newbies to read it instead of applying
a bash of command lines which may fail.

Signed-off-by: Nelio Laranjeiro <nelio.laranjeiro@6wind.com>
---
 dev.html | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/dev.html b/dev.html
index cb65f51..9a01ab5 100644
--- a/dev.html
+++ b/dev.html
@@ -57,6 +57,9 @@
 	<p>Focus is on next version in git <em>HEAD</em>. There is no maintenance of previous versions.
 
 	<h3 id="send">Contribute by sending patches</h3>
+	<p><b>Following lines are a snippet of
+	<a href="/doc/guides/contributing/patches.html">contribution guidelines</a>.</b>
+
 	<p>Patches should be sent and reviewed via the <a href="/ml/archives/dev">mailing list</a>.
 	Be sure <a href="/ml/listinfo/dev">to be registered</a>.
 	<p>To prepare a patch, it must be saved with
@@ -105,8 +108,6 @@
 	smtpencryption = ssl
 [alias]
 	fixline = log -1 --abbrev=12 --format='Fixes: %h (\"%s\")'</pre>
-	<p>The built-in documentation have more details about the
-	<a href="/doc/guides/contributing/patches.html">contribution guidelines</a>.
 
 	<h3 id="review">Contribute by testing or reviewing patches</h3>
 	<p>Patches are applied in the git repository when it becomes clear that
-- 
2.1.4

[dpdk-web] [PATCH v2 2/2] inform where Message ID can be found

[Nelio Laranjeiro]

Some people does not have the possibility to display Email Headers in their
client,  for them it is faster to get it from the patchwork.

Signed-off-by: Nelio Laranjeiro <nelio.laranjeiro@6wind.com>
---
 dev.html | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/dev.html b/dev.html
index 9a01ab5..63cb9f0 100644
--- a/dev.html
+++ b/dev.html
@@ -90,6 +90,8 @@
 --to dev@dpdk.org --cc &lt;everybody discussing the patch&gt;</pre>
 	<p>Annotations take place after the 3 dashes and should explicit
 	what has changed since the previous version.
+	<p>The Message ID can be found in the email header of the previous patch or in its
+	<a href="http://dpdk.org/patch/14470">patchwork page</a>.
 	<p>In the case of a bug reported on the mailing list, the patch should be a reply to the bug report.
 	<p>An updated patchset should be a reply to the previous cover letter.
 	<p>When sending a patch serie, a cover letter may explain the global idea:
-- 
2.1.4

Re: [dpdk-web] [PATCH v2 1/2] move up contribution guidelines link

[Thomas Monjalon]

Series applied, thanks Nelio

Re: [dpdk-web] [PATCH v2 1/2] move up contribution guidelines link

[Mcnamara, John]

> -----Original Message-----
> From: web [mailto:web-bounces@dpdk.org] On Behalf Of Thomas Monjalon
> Sent: Wednesday, July 27, 2016 2:49 PM
> To: Nelio Laranjeiro <nelio.laranjeiro@6wind.com>
> Cc: web@dpdk.org
> Subject: Re: [dpdk-web] [PATCH v2 1/2] move up contribution guidelines
> link
> 
> Series applied, thanks Nelio

Thanks for that, it is a nice improvement.