[dpdk-web] [PATCH] update patch submission process
Thomas Monjalon
thomas at monjalon.net
Tue Jun 30 10:58:02 CEST 2020
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 at 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 at 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 at dpdk.org
+git send-email -1 --to dev at 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 at dpdk.org --cc <everybody discussing the patch>
+git send-email -1 -v2 --annotate --in-reply-to <Message-ID of the first email>
+--to dev at 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 at dpdk.org --cover-letter --annotate
+git send-email -3 --to dev at 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
More information about the web
mailing list