DPDK website maintenance
 help / color / Atom feed
From: Thomas Monjalon <thomas@monjalon.net>
To: web@dpdk.org
Subject: [dpdk-web] [PATCH] update patch submission process
Date: Tue, 30 Jun 2020 10:58:02 +0200
Message-ID: <20200630085802.1035628-1-thomas@monjalon.net> (raw)

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


             reply index

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-06-30  8:58 Thomas Monjalon [this message]
2020-06-30  9:03 ` Andrew Rybchenko
2020-06-30 15:49 ` Honnappa Nagarahalli
2020-06-30 16:19   ` Thomas Monjalon
2020-06-30 17:39     ` Honnappa Nagarahalli

Reply instructions:

You may reply publically to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200630085802.1035628-1-thomas@monjalon.net \
    --to=thomas@monjalon.net \
    --cc=web@dpdk.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

DPDK website maintenance

Archives are clonable:
	git clone --mirror http://inbox.dpdk.org/web/0 web/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 web web/ http://inbox.dpdk.org/web \
		web@dpdk.org
	public-inbox-index web


Newsgroup available over NNTP:
	nntp://inbox.dpdk.org/inbox.dpdk.web


AGPL code for this site: git clone https://public-inbox.org/ public-inbox