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 0926EA04B5; Wed, 13 Jan 2021 10:12:21 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id BA1CA140E88; Wed, 13 Jan 2021 10:12:20 +0100 (CET) Received: from out1-smtp.messagingengine.com (out1-smtp.messagingengine.com [66.111.4.25]) by mails.dpdk.org (Postfix) with ESMTP id 6A96F140E85 for ; Wed, 13 Jan 2021 10:12:19 +0100 (CET) Received: from compute2.internal (compute2.nyi.internal [10.202.2.42]) by mailout.nyi.internal (Postfix) with ESMTP id 012935C011D; Wed, 13 Jan 2021 04:12:19 -0500 (EST) Received: from mailfrontend2 ([10.202.2.163]) by compute2.internal (MEProxy); Wed, 13 Jan 2021 04:12:19 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=monjalon.net; h= from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; s=fm3; bh=7U1lag3r08YtI Ddc8lmW6DRHZVAwCK8bKG2KM/xyGfs=; b=KpeR3ryoQ72Ty4aWWebnZDE1uba5K 21N44s3r9+j11gkC00+bRbso59GYGrhytyw+5wNZcOf44+g8ykTrXc+02/zi0xjz InrdPHTrDGKPw5epLtXmjt7Sv74iymsYqZdLDyK600F8c94gS24AoErnq5+2As1x XwUg8GAsFO6agk8Xe9SlIv3ehEcbze8UkpryWnlIkodwKAbyxLyBAR7euFa0z47p 58RStVvjZ1XE5y3715GZHv2uw+9zJ1u2jIrfJVb3mxx057w8FH0FxF/tiGxRyxUR OefsZ6LRylZsq6N6rUO7zrTMtrR6+0Rx8i6owFD3WsO3DSeJQFxR2CVrg== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:content-transfer-encoding:date:from :in-reply-to:message-id:mime-version:references:subject:to :x-me-proxy:x-me-proxy:x-me-sender:x-me-sender:x-sasl-enc; s= fm1; bh=7U1lag3r08YtIDdc8lmW6DRHZVAwCK8bKG2KM/xyGfs=; b=QTAVqDDh gm2JIujVUkzEVMi4GdcWUoEk3PeoHxUUXroqiKD4eBHAiEhIUfNObqKs9nsK5GEE TaES9yKfI7cxxIhRhWgYEZltYGt/L8FlG6ifBZUlDQVFOTK4ixxMitWeR3BVYJWj ZASJAnWRWpeGPQcsmoGAL3/eeErzBsG7IKwFlgX1IWyYLOsVOxXKiR25NC5ntQjr h8ylFMoTqkN2+xgt5+O1sSKcxoBM620UpFGPEF7prlC+GQmIaAka/BvtWUpLXw3u TIhQY7oAQSAJwbw0hlGmAzldw5L3x1x6/cIfMXnHY+OOjxqh3okTnbzVjVQjA9s2 u+osQCSrMFWgJQ== X-ME-Sender: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedukedrtdefgddtudcutefuodetggdotefrodftvf curfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfghnecu uegrihhlohhuthemuceftddtnecusecvtfgvtghiphhivghnthhsucdlqddutddtmdenuc fjughrpefhvffufffkofgjfhgggfestdekredtredttdenucfhrhhomhepvfhhohhmrghs ucfoohhnjhgrlhhonhcuoehthhhomhgrshesmhhonhhjrghlohhnrdhnvghtqeenucggtf frrghtthgvrhhnpedvhefgiedvjeegtdevheefhfetleefgfeivefgffevfeejgedtgfeu tdehtdegveenucfkphepjeejrddufeegrddvtdefrddukeegnecuvehluhhsthgvrhfuih iivgeptdenucfrrghrrghmpehmrghilhhfrhhomhepthhhohhmrghssehmohhnjhgrlhho nhdrnhgvth X-ME-Proxy: Received: from xps.monjalon.net (184.203.134.77.rev.sfr.net [77.134.203.184]) by mail.messagingengine.com (Postfix) with ESMTPA id DD6B3108005C; Wed, 13 Jan 2021 04:12:17 -0500 (EST) From: Thomas Monjalon To: dev@dpdk.org Cc: david.marchand@redhat.com, ferruh.yigit@intel.com, Asaf Penso Date: Wed, 13 Jan 2021 10:12:13 +0100 Message-Id: <20210113091213.4118267-1-thomas@monjalon.net> X-Mailer: git-send-email 2.29.2 In-Reply-To: <1610458201-21022-1-git-send-email-michaelba@nvidia.com> References: <1610458201-21022-1-git-send-email-michaelba@nvidia.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [dpdk-dev] [PATCH v3 1/1] 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 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