From: Thomas Monjalon <thomas@monjalon.net>
To: dev@dpdk.org
Cc: david.marchand@redhat.com, ferruh.yigit@intel.com,
Asaf Penso <asafp@nvidia.com>
Subject: [dpdk-dev] [PATCH v3 1/1] doc: add release milestones definition
Date: Wed, 13 Jan 2021 10:12:13 +0100 [thread overview]
Message-ID: <20210113091213.4118267-1-thomas@monjalon.net> (raw)
In-Reply-To: <1610458201-21022-1-git-send-email-michaelba@nvidia.com>
From: Asaf Penso <asafp@nvidia.com>
Adding more information about the release milestones.
This includes the scope of change, expectations, etc.
Signed-off-by: Asaf Penso <asafp@nvidia.com>
---
v2: fix styling format and add content in the commit message
v3: change punctuation and avoid plural form when unneeded
---
doc/guides/contributing/patches.rst | 72 +++++++++++++++++++++++++++++
1 file changed, 72 insertions(+)
diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index 4e9140bca4..87c1c6f8f6 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -657,3 +657,75 @@ patch accepted. The general cycle for patch review and acceptance is:
than rework of the original.
* Trivial patches may be merged sooner than described above at the tree committer's
discretion.
+
+
+Milestones definition
+---------------------
+
+Each DPDK release has milestones that help everyone to converge to the release date.
+The following is a list of these milestones
+together with concrete definitions and expectations.
+
+Roadmap
+~~~~~~~
+
+* Content: new features in libs, drivers, apps, and examples.
+* Timeframe: to be published until the first day of the release cycle.
+
+RFC
+~~~
+
+* Content: public design review for the feature, explaining the need, and the design.
+* Should include the API changes, in libs and apps.
+* RFC is not mandatory but strongly advised to start early discussion.
+* Nice to have: driver implementation (full or draft), example code, and documentation.
+
+Proposal Deadline
+~~~~~~~~~~~~~~~~~
+
+* Content: either an RFC as stated above or a v1 patch.
+* Nice to have: code complete for libs.
+
+rc1
+~~~
+
+* Content: new or updated API.
+* New API should be defined and implemented in libraries.
+* The API should include Doxygen documentation
+ and be part of the relevant .rst files (lib, release notes).
+* Code and related documentation must be updated atomically in the same patch.
+* API should be used in a test application (/apps).
+* At least one PMD should implement the API.
+ It can be a draft but must be sent as a separate series.
+* At least 2 weeks before -rc1 the above should be sent to the ML for review.
+* Nice to have: example code (/examples)
+
+rc2
+~~~
+
+* Content: drivers.
+* New features should be implemented in drivers.
+* A driver change should include documentation
+ in the relevant .rst files (driver, release notes).
+* Code and related documentation must be updated atomically in the same patch.
+* At least 2 weeks before -rc2 the above should be sent to the ML for review.
+
+rc3
+~~~
+
+* Content: test apps.
+* New functionality that does not depend on libs update
+ can be integrated as part of -rc3.
+* The app should include documentation in the relevant .rst files
+ (app, release notes if significant).
+* Code and related documentation must be updated atomically in the same patch.
+* Last opportunity for miscellaneous changes.
+* Libs and drivers cleanup.
+* Small driver reworks.
+* Big bug fixes.
+
+rc4
+~~~
+
+* Documentation updates.
+* Critical bug fixes.
--
2.29.2
next prev parent reply other threads:[~2021-01-13 9:12 UTC|newest]
Thread overview: 34+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-01-10 18:44 [dpdk-dev] [PATCH] " Asaf Penso
2021-01-12 13:30 ` [dpdk-dev] [PATCH v2] " Michael Baum
2021-01-13 9:12 ` Thomas Monjalon [this message]
2021-01-27 18:33 ` [dpdk-dev] [PATCH v3 1/1] " Mcnamara, John
2021-02-01 22:13 ` [dpdk-dev] [PATCH v4 " Thomas Monjalon
2021-02-01 22:31 ` Ajit Khaparde
2021-02-01 22:38 ` Thomas Monjalon
2021-02-03 7:58 ` [dpdk-dev] [PATCH v5 " Thomas Monjalon
2021-02-03 10:14 ` David Marchand
2021-02-03 10:27 ` Thomas Monjalon
2021-03-28 19:00 ` [dpdk-dev] [PATCH v6] " Thomas Monjalon
2021-03-29 2:02 ` Ajit Khaparde
2021-05-18 11:57 ` Ferruh Yigit
2021-05-18 12:25 ` Thomas Monjalon
2021-05-18 13:13 ` Ferruh Yigit
2021-05-18 17:20 ` Ajit Khaparde
2021-05-18 16:43 ` [dpdk-dev] [PATCH v7] " Thomas Monjalon
2021-05-19 8:56 ` Bruce Richardson
2021-05-19 11:58 ` Ferruh Yigit
2021-05-19 12:16 ` Thomas Monjalon
2021-08-26 10:11 ` [dpdk-dev] [PATCH v8] " Thomas Monjalon
2021-09-02 16:33 ` Ferruh Yigit
2021-09-03 11:50 ` Thomas Monjalon
2021-09-03 15:35 ` Ferruh Yigit
2021-09-14 7:53 ` Thomas Monjalon
2021-09-14 16:11 ` Ajit Khaparde
2021-09-14 16:46 ` Thomas Monjalon
2021-09-03 12:26 ` Andrew Rybchenko
2021-09-03 12:55 ` Thomas Monjalon
2021-09-14 7:56 ` [dpdk-dev] [PATCH v9] " Thomas Monjalon
2021-09-14 16:34 ` Ferruh Yigit
2021-09-14 16:50 ` Thomas Monjalon
2021-09-14 16:51 ` Ajit Khaparde
2021-09-14 17:20 ` 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=20210113091213.4118267-1-thomas@monjalon.net \
--to=thomas@monjalon.net \
--cc=asafp@nvidia.com \
--cc=david.marchand@redhat.com \
--cc=dev@dpdk.org \
--cc=ferruh.yigit@intel.com \
/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
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).