From patchwork Tue May 18 16:43:03 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Thomas Monjalon X-Patchwork-Id: 93311 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 B8882A0A02; Tue, 18 May 2021 18:43:13 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 3B2914068E; Tue, 18 May 2021 18:43:13 +0200 (CEST) Received: from out4-smtp.messagingengine.com (out4-smtp.messagingengine.com [66.111.4.28]) by mails.dpdk.org (Postfix) with ESMTP id 20BD240041 for ; Tue, 18 May 2021 18:43:12 +0200 (CEST) Received: from compute6.internal (compute6.nyi.internal [10.202.2.46]) by mailout.nyi.internal (Postfix) with ESMTP id C82EF5C01B2; Tue, 18 May 2021 12:43:09 -0400 (EDT) Received: from mailfrontend2 ([10.202.2.163]) by compute6.internal (MEProxy); Tue, 18 May 2021 12:43:09 -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=fm1; bh=ioQSAdFiEniP4 oU1ssoMUVaq10tL3vS0cvjsMbH3gJI=; b=4v9u3nKZf0s+82hHU+7PF4Qg/rjvh Tr0Li64bvZ+/vcEBaLhiV1tCa6m1JgdrWcJ6xzH5l0Dd6pWL6oSH625i9MT5Ut4G IRA7J/JoBT1+u0Ipp031ECE3XFxw4FZlYlo5d3yNExvTEnOQdcAH+ntNcLnUaj17 LGhclrGwf8sFTyuvPm48rLcUgIJbMrSjiVtmPBPMnUOk/uQ+S8OVm79ZhvciS1Aq McWz9ZwtohuV3czKYhBlREx0Jf9r9PodD/LCsz8gRQsr1NiXJavkQLkeWUug08Zi A1t7v16MiR1lYr7dw+K75W0l3GS1ABmL2EY1hyuAbFnotYbbU65Bd2JeQ== 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=ioQSAdFiEniP4oU1ssoMUVaq10tL3vS0cvjsMbH3gJI=; b=IQAS43S1 +QtiMHZud+t+kC8MH1do8VrxaP8pV3/Pf8kj3ckNNJlD/FJkxW6LdTGVvVEXP3X6 CK3HHrQE9RUlsL7Xjq/agfrHslFEubRcUxxpdQJ55WmzGCVuQLWSJVJFdCAOvosu 9F1ZaOC2PP9aB6EM5lUpEkkObMwoMQ38BCg2HVcyvHF2q+DWH3iTKTbtHsb2fB82 PWgSMYDdWD0QGEG795uQODVs19KGqXDqVr7giouCMviOIAmC5p7x9NpDlvBC0klN CND2SvqkmKUgkCf+YcELXGdaZbBsqzx12KZqC5QprnBK4p0p0rUBn2JfVJM3IhYR B4tpAeOHa+9DTA== X-ME-Sender: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgeduledrvdeijedguddtgecutefuodetggdotefrod 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; Tue, 18 May 2021 12:43:08 -0400 (EDT) From: Thomas Monjalon To: dev@dpdk.org Cc: david.marchand@redhat.com, ferruh.yigit@intel.com, Asaf Penso , John McNamara , Ajit Khaparde Date: Tue, 18 May 2021 18:43:03 +0200 Message-Id: <20210518164303.4108310-1-thomas@monjalon.net> X-Mailer: git-send-email 2.31.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 Subject: [dpdk-dev] [PATCH v7] 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 Acked-by: Ajit Khaparde Acked-by: Bruce Richardson --- 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 v7: make expectations clearer and stricter --- 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 6dbbd5f8d1..4d70e326c5 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,73 @@ 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 `_. + +.. note:: + Sooner is always better. Deadlines are not ideal dates. + + Integration is never guaranteed but everyone can help. + +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: libraries. No library feature should be accepted after -rc1. +* New API must be defined and implemented in libraries. +* The API must 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 may be a draft sent in 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. No driver feature should be accepted after -rc2. +* A driver change must 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. No application feature should be accepted after -rc3. +* New functionality that does not depend on libraries update + can be integrated as part of -rc3. +* The application change must include documentation in the relevant .rst files + (application-specific and release notes if significant). +* Libraries and drivers cleanup are allowed. +* Small driver reworks. +* Critical and minor bug fixes. + +rc4 +~~~ + +* Documentation updates. +* Critical bug fixes.