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>, Thomas Monjalon <thomas@monjalon.net>, ci@dpdk.org Subject: [dpdk-dev] [PATCH v2] doc: add dependency syntax to contributing guide Date: Fri, 3 Jul 2020 10:53:48 +0100 Message-ID: <20200703095348.232927-1-ferruh.yigit@intel.com> (raw) In-Reply-To: <20200701113528.303605-1-ferruh.yigit@intel.com> 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 <ferruh.yigit@intel.com> --- 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 <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 ("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 <alex.smith@example.com> + --- + Depends-on: series-10000 ("Title of the series") Creating Patches ---------------- -- 2.25.4
next prev parent reply other threads:[~2020-07-03 9:53 UTC|newest] Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top 2020-07-01 11:35 [dpdk-dev] [PATCH] " 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 ` Ferruh Yigit [this message] 2020-07-06 15:09 ` [dpdk-dev] [dpdk-ci] [PATCH v2] " 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
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=20200703095348.232927-1-ferruh.yigit@intel.com \ --to=ferruh.yigit@intel.com \ --cc=ci@dpdk.org \ --cc=dev@dpdk.org \ --cc=john.mcnamara@intel.com \ --cc=marko.kovacevic@intel.com \ --cc=thomas@monjalon.net \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: link
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