From: Ferruh Yigit <ferruh.yigit@intel.com>
To: John McNamara <john.mcnamara@intel.com>,
Marko Kovacevic <marko.kovacevic@intel.com>
Cc: dev@dpdk.org, Ferruh Yigit <ferruh.yigit@intel.com>, ci@dpdk.org
Subject: [dpdk-dev] [PATCH] doc: add dependency syntax to contributing guide
Date: Wed, 1 Jul 2020 12:35:28 +0100 [thread overview]
Message-ID: <20200701113528.303605-1-ferruh.yigit@intel.com> (raw)
To help managing patch dependencies, both for maintainers or automation
tasks, document a syntax for commit logs or cover letters to express
their dependencies.
Using the syntax proposed in Bugzilla ID 210:
[https://bugs.dpdk.org/show_bug.cgi?id=210]
'Depends-on: series-NNNNN' OR 'Depends-on: patch-NNNNN'
Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
---
Cc: ci@dpdk.org
---
doc/guides/contributing/patches.rst | 21 +++++++++++++++++++++
1 file changed, 21 insertions(+)
diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index 1c6a04100..54dbb0508 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -339,6 +339,27 @@ In the commit message body the Cc: stable@dpdk.org should be inserted as follows
For further information on stable contribution you can go to
:doc:`Stable Contribution Guide <stable>`.
+Patch Dependencies
+~~~~~~~~~~~~~~~~~~
+
+Sometimes a patch or patchset can depend on another one.
+To help the maintainers and automation tasks, please document this dependency in commit log or cover letter with the following syntax::
+
+ Depends-on: series-NNNNN
+
+ OR
+
+ Depends-on: patch-NNNNN
+
+Where ``NNNNN`` is patchwork ID for patch or series::
+
+ doc: fix some parameter description
+
+ Update the docs, fixing description of some parameter.
+
+ Signed-off-by: Alex Smith <alex.smith@example.com>
+ ---
+ Depends-on: series-10000
Creating Patches
----------------
--
2.25.4
next reply other threads:[~2020-07-01 11:35 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-07-01 11:35 Ferruh Yigit [this message]
2020-07-01 11:59 ` [dpdk-dev] [dpdk-ci] [PATCH] doc: add dependency syntax to contributing guide Thomas Monjalon
2020-07-02 16:13 ` Ferruh Yigit
2020-07-03 9:01 ` Thomas Monjalon
2020-07-03 9:03 ` Ferruh Yigit
2020-07-03 9:53 ` [dpdk-dev] [PATCH v2] " Ferruh Yigit
2020-07-06 15:09 ` [dpdk-dev] [dpdk-ci] " Aaron Conole
2020-07-06 15:12 ` Thomas Monjalon
2020-07-06 18:02 ` Aaron Conole
2020-07-30 23:13 ` [dpdk-dev] " Thomas Monjalon
Reply instructions:
You may reply publicly 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=20200701113528.303605-1-ferruh.yigit@intel.com \
--to=ferruh.yigit@intel.com \
--cc=ci@dpdk.org \
--cc=dev@dpdk.org \
--cc=john.mcnamara@intel.com \
--cc=marko.kovacevic@intel.com \
/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
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.