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 31B71A034F; Sun, 28 Mar 2021 21:00:17 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id DDC5B40042; Sun, 28 Mar 2021 21:00:16 +0200 (CEST) Received: from out3-smtp.messagingengine.com (out3-smtp.messagingengine.com [66.111.4.27]) by mails.dpdk.org (Postfix) with ESMTP id 1517940040 for ; Sun, 28 Mar 2021 21:00:15 +0200 (CEST) Received: from compute2.internal (compute2.nyi.internal [10.202.2.42]) by mailout.nyi.internal (Postfix) with ESMTP id 63A565C03DC; Sun, 28 Mar 2021 15:00:14 -0400 (EDT) Received: from mailfrontend2 ([10.202.2.163]) by compute2.internal (MEProxy); Sun, 28 Mar 2021 15:00:14 -0400 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=h+4U+AxwXi1Zp SFyrGmhtn8cHaZdCYpnaYPWrsRgqiY=; b=jyTtrvrsM7ry75jkvpsEnY+Kp32zt Lnp37YXnW53JGHGoyqN77qNNYYlmgApWUxqvZxb35YvS9C6BUZtsoIxKt1PlUlTa STjt/53RY7cwDijvEReRkMGQeF5ZiMVMz7jnu4SZyXX0eDQZW06wpPQQlMPQsVdY R8Mol/CTT85aCZKxAU6E+WwMe4BQGUtY+SL5xoo8YGZF0yrGa713UhwTdVvf4EcH 1t1zmJEO4DV9qQTch5bK1T+6m7gxg3Z4wcpId06I2r8gdvj0KIJ2l73LjpW8F7lo kjkTcp6TDvOku/upwlCHa/JJd+ooVqKDZyyObLnVLZLfHHaeLaLo9smOQ== 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=h+4U+AxwXi1ZpSFyrGmhtn8cHaZdCYpnaYPWrsRgqiY=; b=QPCbxW69 B8c76eTiSioTj2OlaMYXzMDf+sQ2R2UEZpX4t4hIiUh6VypgyTuoEpC6W9Uyjdx0 +MCnUmsiZaTfk0NHAohLo9XXf2Jf8B62Bua2cG5yOG4Z+EFV15jP18tlIVDwMM29 7/Drk6UiBqZUbpEcJHEdNaFkByK5SCRDOcv6jE+SM57zNvW5NW2zSAOh3LJ9/jlO qCUMhwJjKKml4HqCHgVaL/5UIifF2JPGGyguYZaBKAFbZLMRK3KvZXvNDRfgB/XI zwCx4X7CqKCAy11MpDGEd7Uj9HpfTtQsKfx4AtsUfRiCTi4mD0DNzRrCPuF+K7P+ 9Qf8t9j5Eqa8ng== X-ME-Sender: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgeduledrudehiedgudefgecutefuodetggdotefrod ftvfcurfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfgh necuuegrihhlohhuthemuceftddtnecusecvtfgvtghiphhivghnthhsucdlqddutddtmd enucfjughrpefhvffufffkofgjfhgggfestdekredtredttdenucfhrhhomhepvfhhohhm rghsucfoohhnjhgrlhhonhcuoehthhhomhgrshesmhhonhhjrghlohhnrdhnvghtqeenuc ggtffrrghtthgvrhhnpeehtdduuefggeekveehueeitdefhfdvkeevtedvfeeivdffudeu udehudetiedvudenucffohhmrghinhepughpughkrdhorhhgnecukfhppeejjedrudefge drvddtfedrudekgeenucevlhhushhtvghrufhiiigvpedtnecurfgrrhgrmhepmhgrihhl fhhrohhmpehthhhomhgrshesmhhonhhjrghlohhnrdhnvght 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 3A9F01080054; Sun, 28 Mar 2021 15:00:13 -0400 (EDT) From: Thomas Monjalon To: dev@dpdk.org Cc: david.marchand@redhat.com, Asaf Penso , John McNamara Date: Sun, 28 Mar 2021 21:00:05 +0200 Message-Id: <20210328190005.4185594-1-thomas@monjalon.net> X-Mailer: git-send-email 2.30.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-Transfer-Encoding: 8bit Subject: [dpdk-dev] [PATCH v6] 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 v6: merge RFC and proposal deadline, add roadmap link and reduce duplication --- doc/guides/contributing/patches.rst | 69 +++++++++++++++++++++++++++++ 1 file changed, 69 insertions(+) diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst index 6dbbd5f8d1..1277443620 100644 --- a/doc/guides/contributing/patches.rst +++ b/doc/guides/contributing/patches.rst @@ -177,6 +177,8 @@ Make your planned changes in the cloned ``dpdk`` repo. Here are some guidelines * Add documentation, if relevant, in the form of Doxygen comments or a User Guide in RST format. See the :ref:`Documentation Guidelines `. +* Code and related documentation must be updated atomically in the same patch. + Once the changes have been made you should commit them to your local repo. For small changes, that do not require specific explanations, it is better to keep things together in the @@ -660,3 +662,70 @@ 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 (3 months ending after 4 release candidates). +The number and expectations of release candidates might vary slightly. +The schedule is updated in the `roadmap `_. + +Roadmap +~~~~~~~ + +* Announce new features in libraries, drivers, applications, and examples. +* To be published before the first day of the release cycle. + +Proposal Deadline +~~~~~~~~~~~~~~~~~ + +* Must send an RFC or a complete v1 patch. +* Early RFC gives time for design review before complete implementation. +* Should include at least the API changes in libraries and applications. +* Library code should be quite complete at the deadline. +* Nice to have: driver implementation (full or draft), example code, and documentation. + +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-specific and release notes). +* 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-specific and release notes). +* 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 libraries update + can be integrated as part of -rc3. +* The application should include documentation in the relevant .rst files + (application-specific and release notes if significant). +* It may be the last opportunity for miscellaneous changes. +* Libraries and drivers cleanup are allowed. +* Small driver reworks. +* Critical and minor bug fixes. + +rc4 +~~~ + +* Documentation updates. +* Critical bug fixes. -- 2.30.1