From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <ci-bounces@dpdk.org>
Received: from dpdk.org (dpdk.org [92.243.14.124])
	by inbox.dpdk.org (Postfix) with ESMTP id BB8CDA0522
	for <public@inbox.dpdk.org>; Wed,  1 Jul 2020 13:35:34 +0200 (CEST)
Received: from [92.243.14.124] (localhost [127.0.0.1])
	by dpdk.org (Postfix) with ESMTP id 871501C2F8;
	Wed,  1 Jul 2020 13:35:34 +0200 (CEST)
Received: from mga01.intel.com (mga01.intel.com [192.55.52.88])
 by dpdk.org (Postfix) with ESMTP id 5B3EC1C2E8;
 Wed,  1 Jul 2020 13:35:32 +0200 (CEST)
IronPort-SDR: D5AF0CAG0IvbWSpL/g3ocZFvRXBuPnQFbjPyKtKmBGLDZpWSols8JJj461UY+VapWxTeUsqftR
 u5V/mT1LFyqQ==
X-IronPort-AV: E=McAfee;i="6000,8403,9668"; a="164551860"
X-IronPort-AV: E=Sophos;i="5.75,300,1589266800"; d="scan'208";a="164551860"
X-Amp-Result: SKIPPED(no attachment in message)
X-Amp-File-Uploaded: False
Received: from orsmga005.jf.intel.com ([10.7.209.41])
 by fmsmga101.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384;
 01 Jul 2020 04:35:31 -0700
IronPort-SDR: EozWRRiPEuwNQq1nsWzDSz4AZaIzoXwK6pVk50gUTp4c6Di6/aI0qZllhgFQ9AjtGw2A9boxqE
 9Gi98e6j+hOw==
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.75,300,1589266800"; d="scan'208";a="455073913"
Received: from silpixa00399752.ir.intel.com (HELO
 silpixa00399752.ger.corp.intel.com) ([10.237.222.180])
 by orsmga005.jf.intel.com with ESMTP; 01 Jul 2020 04:35:29 -0700
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
Date: Wed,  1 Jul 2020 12:35:28 +0100
Message-Id: <20200701113528.303605-1-ferruh.yigit@intel.com>
X-Mailer: git-send-email 2.25.4
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Subject: [dpdk-ci] [PATCH] doc: add dependency syntax to contributing guide
X-BeenThere: ci@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK CI discussions <ci.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/ci>,
 <mailto:ci-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/ci/>
List-Post: <mailto:ci@dpdk.org>
List-Help: <mailto:ci-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/ci>,
 <mailto:ci-request@dpdk.org?subject=subscribe>
Errors-To: ci-bounces@dpdk.org
Sender: "ci" <ci-bounces@dpdk.org>

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