[dpdk-ci] [PATCH] doc: add dependency syntax to contributing guide

Ferruh Yigit ferruh.yigit at intel.com
Wed Jul 1 13:35:28 CEST 2020

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:

'Depends-on: series-NNNNN' OR 'Depends-on: patch-NNNNN'

Signed-off-by: Ferruh Yigit <ferruh.yigit at intel.com>
Cc: ci at 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 at 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 at example.com>
+     ---
+     Depends-on: series-10000
 Creating Patches

More information about the ci mailing list