[dpdk-web] [PATCH] update patch submission process

[dpdk-web] [PATCH] update patch submission process

[Thomas Monjalon]

Add --cc-cmd devtools/get-maintainer.sh
Recommend threading based on the first patch or cover letter.
Add list of commit log tags.

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
 content/contribute/_index.md | 18 +++++++++++++-----
 1 file changed, 13 insertions(+), 5 deletions(-)

diff --git a/content/contribute/_index.md b/content/contribute/_index.md
index 5afc23c..e815b0e 100644
--- a/content/contribute/_index.md
+++ b/content/contribute/_index.md
@@ -57,6 +57,13 @@ The email title must begin with *[PATCH]* to distinguish it among discussions.
 There must be details in the commit log, explaining what was the problem and how it is fixed.\
 When fixing a regression, it is a good idea to reference the id of
 the commit which introduced the bug (see fixline alias below).
+Few tags are standardized:
+```
+Coverity issue:
+Bugzilla ID:
+Fixes:
+Cc: stable@dpdk.org
+```
 
 Before sending a patch, be sure that there is no licensing issue.
 The commit log must have a *Signed-off-by* line (*--signoff* option).
@@ -70,14 +77,14 @@ It is automatically or manually prepared in the right format by
 [git format-patch](http://www.kernel.org/pub/software/scm/git/docs/git-format-patch.html).
 Typical usage is:
 ```
-git send-email -1 --to dev@dpdk.org
+git send-email -1 --to dev@dpdk.org --cc-cmd devtools/get-maintainer.sh
 ```
 
 If a previous version of the patch has already been sent,
 a version number and changelog annotations are helpful:
 ```
-git send-email -1 -v2 --annotate --in-reply-to <Message-ID of the previous patch>
---to dev@dpdk.org --cc <everybody discussing the patch>
+git send-email -1 -v2 --annotate --in-reply-to <Message-ID of the first email>
+--to dev@dpdk.org --cc-cmd devtools/get-maintainer.sh --cc <everybody discussing the patch>
 ```
 
 Annotations take place after the 3 dashes and should explicit
@@ -88,11 +95,12 @@ The Message-ID can be found in the email header of the previous patch or in its
 
 In the case of a bug reported on the mailing list, the patch should be a reply to the bug report.
 
-An updated patchset should be a reply to the previous cover letter.
+An updated patchset should be a reply to the first cover letter.
 
 When sending several patches in a series, a cover letter may explain the global idea:
 ```
-git send-email -3 --to dev@dpdk.org --cover-letter --annotate
+git send-email -3 --to dev@dpdk.org --cc-cmd devtools/get-maintainer.sh
+--cover-letter --annotate
 ```
 
 Shallow threading (*--thread --no-chain-reply-to*) is preferred for patch series.
-- 
2.26.2

Re: [dpdk-web] [PATCH] update patch submission process

[Andrew Rybchenko]

On 6/30/20 11:58 AM, Thomas Monjalon wrote:
> Add --cc-cmd devtools/get-maintainer.sh
> Recommend threading based on the first patch or cover letter.
> Add list of commit log tags.
>
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>

Reviewed-by: Andrew Rybchenko <arybchenko@solarflare.com>

The information contained in this message is confidential and is intended for the addressee(s) only. If you have received this message in error, please notify the sender immediately and delete the message. Unless you are an addressee (or authorized to receive for an addressee), you may not use, copy or disclose to anyone this message or any information contained in this message. The unauthorized use, disclosure, copying or alteration of this message is strictly prohibited.

Re: [dpdk-web] [PATCH] update patch submission process

[Honnappa Nagarahalli]

> -----Original Message-----
> From: web <web-bounces@dpdk.org> On Behalf Of Thomas Monjalon
> Sent: Tuesday, June 30, 2020 3:58 AM
> To: web@dpdk.org
> Subject: [dpdk-web] [PATCH] update patch submission process
> 
> Add --cc-cmd devtools/get-maintainer.sh
> Recommend threading based on the first patch or cover letter.
> Add list of commit log tags.
> 
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> ---
>  content/contribute/_index.md | 18 +++++++++++++-----
>  1 file changed, 13 insertions(+), 5 deletions(-)
> 
> diff --git a/content/contribute/_index.md b/content/contribute/_index.md
> index 5afc23c..e815b0e 100644
> --- a/content/contribute/_index.md
> +++ b/content/contribute/_index.md
> @@ -57,6 +57,13 @@ The email title must begin with *[PATCH]* to
> distinguish it among discussions.
>  There must be details in the commit log, explaining what was the problem
> and how it is fixed.\  When fixing a regression, it is a good idea to reference
> the id of  the commit which introduced the bug (see fixline alias below).
I believe we are supposed to add the author of the commit also in 'Cc' tag. Is this correct?

> +Few tags are standardized:
> +```
> +Coverity issue:
> +Bugzilla ID:
> +Fixes:
> +Cc: stable@dpdk.org
> +```
> 
>  Before sending a patch, be sure that there is no licensing issue.
>  The commit log must have a *Signed-off-by* line (*--signoff* option).
> @@ -70,14 +77,14 @@ It is automatically or manually prepared in the right
> format by  [git format-
> patch](http://www.kernel.org/pub/software/scm/git/docs/git-format-
> patch.html).
>  Typical usage is:
>  ```
> -git send-email -1 --to dev@dpdk.org
> +git send-email -1 --to dev@dpdk.org --cc-cmd devtools/get-maintainer.sh
>  ```
> 
>  If a previous version of the patch has already been sent,  a version number
> and changelog annotations are helpful:
>  ```
> -git send-email -1 -v2 --annotate --in-reply-to <Message-ID of the previous
> patch> ---to dev@dpdk.org --cc <everybody discussing the patch>
> +git send-email -1 -v2 --annotate --in-reply-to <Message-ID of the first
> +email> --to dev@dpdk.org --cc-cmd devtools/get-maintainer.sh --cc
> +<everybody discussing the patch>
>  ```
> 
>  Annotations take place after the 3 dashes and should explicit @@ -88,11
> +95,12 @@ The Message-ID can be found in the email header of the previous
> patch or in its
> 
>  In the case of a bug reported on the mailing list, the patch should be a reply
> to the bug report.
> 
> -An updated patchset should be a reply to the previous cover letter.
> +An updated patchset should be a reply to the first cover letter.
> 
>  When sending several patches in a series, a cover letter may explain the
> global idea:
>  ```
> -git send-email -3 --to dev@dpdk.org --cover-letter --annotate
> +git send-email -3 --to dev@dpdk.org --cc-cmd devtools/get-maintainer.sh
> +--cover-letter --annotate
>  ```
> 
>  Shallow threading (*--thread --no-chain-reply-to*) is preferred for patch
> series.
> --
> 2.26.2

Re: [dpdk-web] [PATCH] update patch submission process

[Thomas Monjalon]

30/06/2020 17:49, Honnappa Nagarahalli:
> > --- a/content/contribute/_index.md
> > +++ b/content/contribute/_index.md
> > @@ -57,6 +57,13 @@ The email title must begin with *[PATCH]* to
> > distinguish it among discussions.
> >  There must be details in the commit log, explaining what was the problem
> > and how it is fixed.\  When fixing a regression, it is a good idea to reference
> > the id of  the commit which introduced the bug (see fixline alias below).
> 
> I believe we are supposed to add the author of the commit also in 'Cc' tag. Is this correct?

Yes
Should it be added in this short summary?
Any idea about a short wording?

Re: [dpdk-web] [PATCH] update patch submission process

[Honnappa Nagarahalli]

<snip>
> 30/06/2020 17:49, Honnappa Nagarahalli:
> > > --- a/content/contribute/_index.md
> > > +++ b/content/contribute/_index.md
> > > @@ -57,6 +57,13 @@ The email title must begin with *[PATCH]* to
> > > distinguish it among discussions.
> > >  There must be details in the commit log, explaining what was the
> > > problem and how it is fixed.\  When fixing a regression, it is a
> > > good idea to reference the id of  the commit which introduced the bug
> (see fixline alias below).
> >
> > I believe we are supposed to add the author of the commit also in 'Cc' tag. Is
> this correct?
> 
> Yes
> Should it be added in this short summary?
> Any idea about a short wording?
I think we can skip the wording. Instead add the following:
Cc: author@example.com

> 
>