DPDK patches and discussions
 help / color / mirror / Atom feed
* [dpdk-dev] [PATCH] doc: add dependency syntax to contributing guide
@ 2020-07-01 11:35 Ferruh Yigit
  2020-07-01 11:59 ` [dpdk-dev] [dpdk-ci] " Thomas Monjalon
  2020-07-03  9:53 ` [dpdk-dev] [PATCH v2] " Ferruh Yigit
  0 siblings, 2 replies; 10+ messages in thread
From: Ferruh Yigit @ 2020-07-01 11:35 UTC (permalink / raw)
  To: John McNamara, Marko Kovacevic; +Cc: dev, Ferruh Yigit, ci

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


^ permalink raw reply	[flat|nested] 10+ messages in thread

end of thread, other threads:[~2020-07-30 23:13 UTC | newest]

Thread overview: 10+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-07-01 11:35 [dpdk-dev] [PATCH] doc: add dependency syntax to contributing guide Ferruh Yigit
2020-07-01 11:59 ` [dpdk-dev] [dpdk-ci] " 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

DPDK patches and discussions

This inbox may be cloned and mirrored by anyone:

	git clone --mirror https://inbox.dpdk.org/dev/0 dev/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 dev dev/ https://inbox.dpdk.org/dev \
		dev@dpdk.org
	public-inbox-index dev

Example config snippet for mirrors.
Newsgroup available over NNTP:
	nntp://inbox.dpdk.org/inbox.dpdk.dev


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