DPDK patches and discussions
 help / color / mirror / Atom feed
* [dpdk-dev] [PATCH] doc: add release milestones definition
@ 2021-01-10 18:44 Asaf Penso
  2021-01-12 13:30 ` [dpdk-dev] [PATCH v2] " Michael Baum
  0 siblings, 1 reply; 3+ messages in thread
From: Asaf Penso @ 2021-01-10 18:44 UTC (permalink / raw)
  To: dev; +Cc: techboard

Signed-off-by: Asaf Penso <asafp@nvidia.com>
---
 doc/guides/contributing/patches.rst | 52 +++++++++++++++++++++++++++++++++++++
 1 file changed, 52 insertions(+)

diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index 4e9140b..849fe6d 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -657,3 +657,55 @@ 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 a couple of 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
+
+RFC
+* Content - public design review for the features, explaining the need, and the design
+* It should include the API changes, in libs and apps
+* RFCs are not mandatory but are strongly advised to start early discussions
+* 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 shared 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
+* It should be used in a test application (/apps) and also documented in the relevant .rst files
+* At least one pmd should implement this API. It can be in a draft mode 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
+* All features should be implemented in drivers
+* The drivers should include documentation and be part of 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 doesn’t depend on libs update can be integrated as part of -rc3
+* The app should include documentation and be part of the relevant .rst files (app, release_notes if significant)
+* Code and related documentation must be updated atomically in the same patch
+* Last opportunity for Misc changes
+* Small driver rework
+* libs and driver cleanup
+* Big bug fixes
+
+rc4
+* Content - documentation updates
+* Critical bug fixes
-- 
1.8.3.1


^ permalink raw reply	[flat|nested] 3+ messages in thread

* [dpdk-dev] [PATCH v2] doc: add release milestones definition
  2021-01-10 18:44 [dpdk-dev] [PATCH] doc: add release milestones definition Asaf Penso
@ 2021-01-12 13:30 ` Michael Baum
  2021-01-13  9:12   ` [dpdk-dev] [PATCH v3 1/1] " Thomas Monjalon
  0 siblings, 1 reply; 3+ messages in thread
From: Michael Baum @ 2021-01-12 13:30 UTC (permalink / raw)
  To: dev; +Cc: techboard, Asaf Penso

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
---
 doc/guides/contributing/patches.rst | 66 +++++++++++++++++++++++++++++++++++++
 1 file changed, 66 insertions(+)

diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index 4e9140b..159d220 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -657,3 +657,69 @@ 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 a couple of 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
+
+RFC
+~~~
+
+* Content - public design review for the features, explaining the need, and the design
+* It should include the API changes, in libs and apps
+* RFCs are not mandatory but are strongly advised to start early discussions
+* 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 shared 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
+* It should be used in a test application (/apps) and also documented in the relevant .rst files
+* At least one pmd should implement this API. It can be in a draft mode 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
+* All features should be implemented in drivers
+* The drivers should include documentation and be part of 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 doesn’t depend on libs update can be integrated as part of -rc3
+* The app should include documentation and be part of the relevant .rst files (app, release_notes if significant)
+* Code and related documentation must be updated atomically in the same patch
+* Last opportunity for Misc changes
+* Small driver rework
+* libs and driver cleanup
+* Big bug fixes
+
+rc4
+~~~
+
+* Content - documentation updates
+* Critical bug fixes
-- 
1.8.3.1


^ permalink raw reply	[flat|nested] 3+ messages in thread

* [dpdk-dev] [PATCH v3 1/1] doc: add release milestones definition
  2021-01-12 13:30 ` [dpdk-dev] [PATCH v2] " Michael Baum
@ 2021-01-13  9:12   ` Thomas Monjalon
  0 siblings, 0 replies; 3+ messages in thread
From: Thomas Monjalon @ 2021-01-13  9:12 UTC (permalink / raw)
  To: dev; +Cc: david.marchand, ferruh.yigit, Asaf Penso

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


^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2021-01-13  9:12 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-01-10 18:44 [dpdk-dev] [PATCH] doc: add release milestones definition Asaf Penso
2021-01-12 13:30 ` [dpdk-dev] [PATCH v2] " Michael Baum
2021-01-13  9:12   ` [dpdk-dev] [PATCH v3 1/1] " Thomas Monjalon

DPDK patches and discussions

This inbox may be cloned and mirrored by anyone:

	git clone --mirror http://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/ http://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