From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 1BEADA04B5; Tue, 12 Jan 2021 14:30:24 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id C8D5E140D41; Tue, 12 Jan 2021 14:30:23 +0100 (CET) Received: from mellanox.co.il (mail-il-dmz.mellanox.com [193.47.165.129]) by mails.dpdk.org (Postfix) with ESMTP id AA2F8140D3D for ; Tue, 12 Jan 2021 14:30:22 +0100 (CET) Received: from Internal Mail-Server by MTLPINE1 (envelope-from michaelba@nvidia.com) with SMTP; 12 Jan 2021 15:30:19 +0200 Received: from nvidia.com (pegasus07.mtr.labs.mlnx [10.210.16.112]) by labmailer.mlnx (8.13.8/8.13.8) with ESMTP id 10CDUJVf020197; Tue, 12 Jan 2021 15:30:19 +0200 From: Michael Baum To: dev@dpdk.org Cc: techboard@dpdk.org, Asaf Penso Date: Tue, 12 Jan 2021 13:30:01 +0000 Message-Id: <1610458201-21022-1-git-send-email-michaelba@nvidia.com> X-Mailer: git-send-email 1.8.3.1 In-Reply-To: <1610304247-11455-1-git-send-email-asafp@nvidia.com> References: <1610304247-11455-1-git-send-email-asafp@nvidia.com> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Subject: [dpdk-dev] [PATCH v2] doc: add release milestones definition X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 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" From: Asaf Penso Adding more information about the release milestones. This includes the scope of change, expectations etc. Signed-off-by: Asaf Penso --- 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