From patchwork Wed Feb 3 07:58:27 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Thomas Monjalon X-Patchwork-Id: 87670 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 0B148A0A0E; Wed, 3 Feb 2021 08:58:37 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 9C3EB240446; Wed, 3 Feb 2021 08:58:36 +0100 (CET) Received: from out4-smtp.messagingengine.com (out4-smtp.messagingengine.com [66.111.4.28]) by mails.dpdk.org (Postfix) with ESMTP id A091124043E for ; Wed, 3 Feb 2021 08:58:34 +0100 (CET) Received: from compute2.internal (compute2.nyi.internal [10.202.2.42]) by mailout.nyi.internal (Postfix) with ESMTP id CCE525C0328; Wed, 3 Feb 2021 02:58:32 -0500 (EST) Received: from mailfrontend2 ([10.202.2.163]) by compute2.internal (MEProxy); Wed, 03 Feb 2021 02:58:32 -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=NYB0Jg+IpwKMC +l8Ei9pyp+DVOmGdrt0c39vSLVNzeU=; b=MG5uXsIKM6DQkD3fH7G4WmTJYJ0TP LHm+ZX2NJdNhQdYuNN78vXMi9ZLTH65sauPtvk3wB/hsq7dZlISPXWfpYtfWhVhG oIlw8XhDoo8FNehD5nbzqPExwW00JLmvMWurzLmAmy2EErY84Mkw6E6VDao1KR5k fXVfDcoApEmFt3daL6tGHrtl2Glnj+iBufxpq+MOUmrT8ajPaN2ueveBc6ctrj36 sDyiz6QDX67kvQYvw8x9iplFmk+rmfNrr/X9ZeFeXEhe3am/7dl2VuLQa33rCV7P Wh/5jpaCdUQkG/xzGYpD+9XLKwDKnf75xIbfTw4MH0wlxYe2YdwCeRBDA== 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= fm2; bh=NYB0Jg+IpwKMC+l8Ei9pyp+DVOmGdrt0c39vSLVNzeU=; b=aE4Z++wq Mp9hJXSNohPLr4l4wOBzBY/C1v8I+/xbKJ7H5mZHpdyXA+h5joTcIFmDrh8C4rwq ipzG2TBySJvEuGLZ5vDq0n1GINpzMRDzUC/bvKIIdMSWAJ/QCf7gaEhT9cG5Qgcm YaZvQpybXld3E9kUII0OH0q9RAuklQf/o2r+6zdGs4E5UsX7Bjhw91pSepg+kp0T XhWxh/F0b+uhq4gs71IKHPNaK25gfmdWZjlK2l9+SIWDSRB+Zqk75/W/Zs/Ans6w RoHBM4UuK3kPNPby5kS1Q+LIadO7lpxUedYe+q8dkDLbIvyJX5RwOk2AXWZERjKk MfGSdg4EfBSrWQ== X-ME-Sender: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgeduledrgedugdduudegucetufdoteggodetrfdotf fvucfrrhhofhhilhgvmecuhfgrshhtofgrihhlpdfqfgfvpdfurfetoffkrfgpnffqhgen uceurghilhhouhhtmecufedttdenucesvcftvggtihhpihgvnhhtshculddquddttddmne cujfgurhephffvufffkffojghfggfgsedtkeertdertddtnecuhfhrohhmpefvhhhomhgr shcuofhonhhjrghlohhnuceothhhohhmrghssehmohhnjhgrlhhonhdrnhgvtheqnecugg ftrfgrthhtvghrnhepvdehgfeivdejgedtveehfefhteelfefgieevgfffveefjeegtdfg uedthedtgeevnecukfhppeejjedrudefgedrvddtfedrudekgeenucevlhhushhtvghruf hiiigvpedtnecurfgrrhgrmhepmhgrihhlfhhrohhmpehthhhomhgrshesmhhonhhjrghl ohhnrdhnvght 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 C92381080057; Wed, 3 Feb 2021 02:58:31 -0500 (EST) From: Thomas Monjalon To: dev@dpdk.org Cc: Asaf Penso , John McNamara Date: Wed, 3 Feb 2021 08:58:27 +0100 Message-Id: <20210203075827.2782653-1-thomas@monjalon.net> X-Mailer: git-send-email 2.30.0 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 Subject: [dpdk-dev] [PATCH v5 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 Signed-off-by: Thomas Monjalon Acked-by: John McNamara --- v2: fix styling format and add content in the commit message v3: change punctuation and avoid plural form when unneeded v4: avoid abbreviations, "Priority" in -rc, and reword as John suggests v5: note that release candidates may vary --- doc/guides/contributing/patches.rst | 74 +++++++++++++++++++++++++++++ 1 file changed, 74 insertions(+) diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst index 6dbbd5f8d1..650ae7ef9b 100644 --- a/doc/guides/contributing/patches.rst +++ b/doc/guides/contributing/patches.rst @@ -660,3 +660,77 @@ 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, +for a typical release cycle. +The number and expectations of release candidates might vary slightly. + +Roadmap +~~~~~~~ + +* Content: new features in libraries, drivers, applications, and examples. +* Timeframe: to be published before 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 libraries and applications. +* 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 libraries. + +rc1 +~~~ + +* Priority: 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 (library, release notes). +* Code and related documentation must be updated atomically in the same patch. +* API should be used in a test application (``/app``). +* At least one PMD should implement the API. + It can be a draft but must be sent as a separate series. +* The above should be sent to the mailing list at least 2 weeks before -rc1. +* Nice to have: example code (``/examples``) + +rc2 +~~~ + +* Priority: 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. +* The above should be sent to the mailing list at least 2 weeks before -rc2. + +rc3 +~~~ + +* Priority: applications. +* 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. +* Critical and minor bug fixes. + +rc4 +~~~ + +* Documentation updates. +* Critical bug fixes.