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 A618CA00C5; Mon, 6 Jul 2020 17:10:04 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 502C41D97E; Mon, 6 Jul 2020 17:10:03 +0200 (CEST) Received: from us-smtp-delivery-1.mimecast.com (us-smtp-2.mimecast.com [205.139.110.61]) by dpdk.org (Postfix) with ESMTP id D8A681C138 for ; Mon, 6 Jul 2020 17:10:01 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1594048201; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=dkxEwthfqKLptokOGf6Dx5BdSYRWZo0lZdNoAxIgZYM=; b=YVgRVIyfxmfJ1v/gJFQTb+O7DEx3cw+tDim4wC7Av3zCjONcXFiOlcg3s+2n2C3BYddFqV cFxcipoN5IQMa3lCPdxa1mvhzdU314d4Sz9PmxjiLmcpyjnZioDRLUdpP6Lbtn2igvy3rQ FM/BTKDrqrTuzK3LRdeCBjHFl9rFxQo= Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-44-VzX6i-9_MlqR6bMHdsMaOg-1; Mon, 06 Jul 2020 11:09:47 -0400 X-MC-Unique: VzX6i-9_MlqR6bMHdsMaOg-1 Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 293BF80183C; Mon, 6 Jul 2020 15:09:46 +0000 (UTC) Received: from dhcp-25.97.bos.redhat.com (ovpn-114-181.rdu2.redhat.com [10.10.114.181]) by smtp.corp.redhat.com (Postfix) with ESMTPS id F33B460BF3; Mon, 6 Jul 2020 15:09:44 +0000 (UTC) From: Aaron Conole To: Ferruh Yigit Cc: John McNamara , Marko Kovacevic , dev@dpdk.org, Thomas Monjalon , ci@dpdk.org References: <20200701113528.303605-1-ferruh.yigit@intel.com> <20200703095348.232927-1-ferruh.yigit@intel.com> Date: Mon, 06 Jul 2020 11:09:43 -0400 In-Reply-To: <20200703095348.232927-1-ferruh.yigit@intel.com> (Ferruh Yigit's message of "Fri, 3 Jul 2020 10:53:48 +0100") Message-ID: User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/26.3 (gnu/linux) MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=aconole@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain Subject: Re: [dpdk-dev] [dpdk-ci] [PATCH v2] doc: add dependency syntax to contributing guide X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Ferruh Yigit writes: > 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 > --- Is the plan that these must be scrubbed before committing? This data doesn't seem useful in the history. I would prefer it in the subject like [PATCH series-xxxx] lorem ipsum Since the metadata gets scrubbed. > 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 > ----------------