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 64AA5A0A0B; Mon, 1 Feb 2021 23:13:46 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id E4B8B160655; Mon, 1 Feb 2021 23:13:45 +0100 (CET) Received: from out3-smtp.messagingengine.com (out3-smtp.messagingengine.com [66.111.4.27]) by mails.dpdk.org (Postfix) with ESMTP id 9FFC640693 for ; Mon, 1 Feb 2021 23:13:44 +0100 (CET) Received: from compute2.internal (compute2.nyi.internal [10.202.2.42]) by mailout.nyi.internal (Postfix) with ESMTP id CB3FA5C0166; Mon, 1 Feb 2021 17:13:42 -0500 (EST) Received: from mailfrontend1 ([10.202.2.162]) by compute2.internal (MEProxy); Mon, 01 Feb 2021 17:13:42 -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=B6MjTNBcj+1a3 yHPExOgXVYG9iU8W1TevL8sf3HUE+M=; b=NKH8h+sWbcGiMFxsknEBE2KSVDxq/ MYncETePS+k+IYglWVH1GiFULTzEB+YfksZot21llfNF0rznwJvibVsMqFjf46A/ G6xgt5Uw4H86rYZrwgA2iYhG0ePRBAUxWp5ydH5eVoo0gfIXcagB/UL/vZIeBMIH xra3oPGJn9xGNGBqPTOXCI84z1AG2acqkWXoIzJpr8/tlkFMkwfbXdPd+6hw8ati /m27HwkIadT0W5ALqY7l7e5DBCqFvYHRmmsQu0/Y8hdhX5pzYEfsjnaeqzkaya7y pOTEKhu1DNnnMgIUaivILK2fgEWpLeD7KFB0tV3EbWMGwPRT+THLP3itw== 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=B6MjTNBcj+1a3yHPExOgXVYG9iU8W1TevL8sf3HUE+M=; b=Hf9bP9Og 0jHVVGwvUkk7hP8l36WBmk8+vOlxN2jIjbjEqrlMCpncMQDB+q+NRyph5mR2jLLp qxlQP6ELWLbnV7T45atehI2N+ziRIew4J4P1spOllenNPCTDT8e+bxDA8OQDUz31 235xInOPpuWr24VoJjOl1TC7ZyF/PAgeHT2sbeqFRbhku1VNiv312SPYCfyzeQXk gvyi6IJ/wjInjGBzqSafJjfUqiW06cNi+Y3fHos/FFREQRTCHXfO1SY8IcXZEJm7 4j9PcxsR7tdhGLNKSbY2WfKX2hSulg1Vnuy8sWYLAyqArpjW9+qXOeHBjo9B5q8c Y8OzfoyPayvxIQ== X-ME-Sender: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgeduledrfeekgdduhedvucetufdoteggodetrfdotf 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 B26DD240057; Mon, 1 Feb 2021 17:13:41 -0500 (EST) From: Thomas Monjalon To: dev@dpdk.org Cc: Asaf Penso , John McNamara Date: Mon, 1 Feb 2021 23:13:33 +0100 Message-Id: <20210201221333.2062052-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 Content-Transfer-Encoding: 8bit Subject: [dpdk-dev] [PATCH v4 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 --- 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..15739a43dc 100644 --- a/doc/guides/contributing/patches.rst +++ b/doc/guides/contributing/patches.rst @@ -660,3 +660,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 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. -- 2.30.0