From patchwork Wed Nov 28 14:52:40 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Thomas Monjalon X-Patchwork-Id: 48390 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 083D51B465; Wed, 28 Nov 2018 15:53:03 +0100 (CET) Received: from wout2-smtp.messagingengine.com (wout2-smtp.messagingengine.com [64.147.123.25]) by dpdk.org (Postfix) with ESMTP id 8B3AD1B42F for ; Wed, 28 Nov 2018 15:53:01 +0100 (CET) Received: from compute1.internal (compute1.nyi.internal [10.202.2.41]) by mailout.west.internal (Postfix) with ESMTP id 2CA48DA9; Wed, 28 Nov 2018 09:53:00 -0500 (EST) Received: from mailfrontend2 ([10.202.2.163]) by compute1.internal (MEProxy); Wed, 28 Nov 2018 09:53:00 -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=mesmtp; bh=872yGRwIXm iRfMqFtfqVqSNclFOJRTn9T5WC+x3Jxwo=; b=n17j+gJwxqZ/MljE3YgXnSmqi7 8ZB25reynps26OR6nr1bedD9UP5IaHd5jz31Khv/Qm/y4AROopxALG9+p3t2+g09 TUJYQdwoGIl2gM66LCl4gWKTen/SH700Qf2BTtdDk7fuqfYHNRoRnowtbk3pg9kD G+d4bjDoyPTgLefNg= 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=872yGRwIXmiRfMqFtfqVqSNclFOJRTn9T5WC+x3Jxwo=; b=Ll1RHMe/ sz+eXNxXXUNSMztFgzpK8edOeL33M46KP6dYaZDxTBpN50qWH0w6o4p0rfP0tCic a2DUa0POGVvQ7ZyqILzltoppnUWyAGbtLjJO5jitzurIJPDvXA8634A1OfKhAmW1 QWlVWLCflioDO3gJ2j/R5A4cPxocX8p5zUS+jjUExspGNtx3phXKwRQNuES98YDr d8taPtwffl3fQapCYUNnGw7aeg/6uxGCcHabR4ES3gYlHFi65sDj3kEEFIBDoGX/ GYHBBgIxfQBKt4ipCJJK2sEdZAMS4PqfMTWKRRTHKWC/QQdVRONb+C/8yXHOeImO y2xE7M1Ype5sCA== X-ME-Sender: X-ME-Proxy: Received: from xps.monjalon.net (246.203.136.77.rev.sfr.net [77.136.203.246]) by mail.messagingengine.com (Postfix) with ESMTPA id D723D102F0; Wed, 28 Nov 2018 09:52:57 -0500 (EST) From: Thomas Monjalon To: dev@dpdk.org Cc: john.mcnamara@intel.com, marko.kovacevic@intel.com Date: Wed, 28 Nov 2018 15:52:40 +0100 Message-Id: <20181128145240.26290-2-thomas@monjalon.net> X-Mailer: git-send-email 2.19.0 In-Reply-To: <20181128145240.26290-1-thomas@monjalon.net> References: <20181128104430.22669-1-thomas@monjalon.net> <20181128145240.26290-1-thomas@monjalon.net> MIME-Version: 1.0 Subject: [dpdk-dev] [PATCH v2 2/2] doc: improve release notes template X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 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" Some comments are added to encourage classifying API and ABI changes with scope labels. The section "removed items" is moved just after the "new features". The sample for shared library versions is replaced with foo/bar names. Signed-off-by: Thomas Monjalon Reviewed-by: Ferruh Yigit Acked-by: John McNamara --- doc/guides/rel_notes/release_19_02.rst | 67 ++++++++++++++------------ 1 file changed, 35 insertions(+), 32 deletions(-) diff --git a/doc/guides/rel_notes/release_19_02.rst b/doc/guides/rel_notes/release_19_02.rst index cbb2ddb78..a94fa86a7 100644 --- a/doc/guides/rel_notes/release_19_02.rst +++ b/doc/guides/rel_notes/release_19_02.rst @@ -55,35 +55,6 @@ New Features ========================================================= -API Changes ------------ - -.. This section should contain API changes. Sample format: - - * Add a short 1-2 sentence description of the API change. - Use fixed width quotes for ``function_names`` or ``struct_names``. - Use the past tense. - - This section is a comment. Do not overwrite or remove it. - Also, make sure to start the actual text at the margin. - ========================================================= - - -ABI Changes ------------ - -.. This section should contain ABI changes. Sample format: - - * Add a short 1-2 sentence description of the ABI change - that was announced in the previous releases and made in this release. - Use fixed width quotes for ``function_names`` or ``struct_names``. - Use the past tense. - - This section is a comment. Do not overwrite or remove it. - Also, make sure to start the actual text at the margin. - ========================================================= - - Removed Items ------------- @@ -97,15 +68,47 @@ Removed Items ========================================================= +API Changes +----------- + +.. This section should contain API changes. Sample format: + + * sample: Add a short 1-2 sentence description of the API change + which was announced in the previous releases and made in this release. + Start with a scope label like "ethdev:". + Use fixed width quotes for ``function_names`` or ``struct_names``. + Use the past tense. + + This section is a comment. Do not overwrite or remove it. + Also, make sure to start the actual text at the margin. + ========================================================= + + +ABI Changes +----------- + +.. This section should contain ABI changes. Sample format: + + * sample: Add a short 1-2 sentence description of the ABI change + which was announced in the previous releases and made in this release. + Start with a scope label like "ethdev:". + Use fixed width quotes for ``function_names`` or ``struct_names``. + Use the past tense. + + This section is a comment. Do not overwrite or remove it. + Also, make sure to start the actual text at the margin. + ========================================================= + + Shared Library Versions ----------------------- .. Update any library version updated in this release and prepend with a ``+`` sign, like this: - librte_acl.so.2 - + librte_cfgfile.so.2 - librte_cmdline.so.2 + libfoo.so.1 + + libupdated.so.2 + libbar.so.1 This section is a comment. Do not overwrite or remove it. =========================================================