From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id D0ACDA0519 for ; Fri, 3 Jul 2020 11:53:55 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 9E4931DADA; Fri, 3 Jul 2020 11:53:55 +0200 (CEST) Received: from mga01.intel.com (mga01.intel.com [192.55.52.88]) by dpdk.org (Postfix) with ESMTP id 71E041DAD9; Fri, 3 Jul 2020 11:53:54 +0200 (CEST) IronPort-SDR: 2+/ZpY+wGrkPdO2P4uK0LuEUMPvL/G5kwoXlqFLdh4oUlwapb1bNVvxKlvulHmUwSq35i2g+oL ji9AJQPYYuiQ== X-IronPort-AV: E=McAfee;i="6000,8403,9670"; a="165190441" X-IronPort-AV: E=Sophos;i="5.75,307,1589266800"; d="scan'208";a="165190441" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga004.jf.intel.com ([10.7.209.38]) by fmsmga101.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 03 Jul 2020 02:53:53 -0700 IronPort-SDR: PCyjv20HUtXrporpgwXyx8p3r4CT5wSC5l6ZBqYZq5U/q8NBqNaDUl5xa3lZKl7mxNKzUWNl8m AgdeZsCYTJ+Q== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.75,307,1589266800"; d="scan'208";a="426250043" Received: from silpixa00399752.ir.intel.com (HELO silpixa00399752.ger.corp.intel.com) ([10.237.222.180]) by orsmga004.jf.intel.com with ESMTP; 03 Jul 2020 02:53:49 -0700 From: Ferruh Yigit To: John McNamara , Marko Kovacevic Cc: dev@dpdk.org, Ferruh Yigit , Thomas Monjalon , ci@dpdk.org Date: Fri, 3 Jul 2020 10:53:48 +0100 Message-Id: <20200703095348.232927-1-ferruh.yigit@intel.com> X-Mailer: git-send-email 2.25.4 In-Reply-To: <20200701113528.303605-1-ferruh.yigit@intel.com> References: <20200701113528.303605-1-ferruh.yigit@intel.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [dpdk-ci] [PATCH v2] 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 List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: ci-bounces@dpdk.org Sender: "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 ("Title of the series")' OR 'Depends-on: patch-NNNNN ("Title of the patch")' Signed-off-by: Ferruh Yigit --- Cc: ci@dpdk.org v2: * Add patch/series title as part of syntax --- doc/guides/contributing/patches.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst index 16b40225f..73f71fc69 100644 --- a/doc/guides/contributing/patches.rst +++ b/doc/guides/contributing/patches.rst @@ -336,6 +336,24 @@ 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 `. +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 ("Title of the series")`` or ``Depends-on: patch-NNNNN ("Title of the patch")`` + +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 + --- + Depends-on: series-10000 ("Title of the series") Creating Patches ---------------- -- 2.25.4