From patchwork Wed Nov 28 14:52:39 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Thomas Monjalon X-Patchwork-Id: 48389 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 13EEF3256; Wed, 28 Nov 2018 15:52:55 +0100 (CET) Received: from wout2-smtp.messagingengine.com (wout2-smtp.messagingengine.com [64.147.123.25]) by dpdk.org (Postfix) with ESMTP id 933972C15 for ; Wed, 28 Nov 2018 15:52:53 +0100 (CET) Received: from compute1.internal (compute1.nyi.internal [10.202.2.41]) by mailout.west.internal (Postfix) with ESMTP id 702D4E1A; Wed, 28 Nov 2018 09:52:52 -0500 (EST) Received: from mailfrontend2 ([10.202.2.163]) by compute1.internal (MEProxy); Wed, 28 Nov 2018 09:52:52 -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=3I/gUOUMfJ N97ANrtpHrGfLHd/usyiKSIKxE5GADXRU=; b=k96/hV36mmPH6klcWnMCtiPXhQ aHOXIvhsBBJf/nHE3UwxsziCezGCyT+HNzYtdMKpRkmQTAp6qpR3tQGJUrWYIXRb y3v8ig3W8yXP+Y48TuyJfReT1bzoyJt9ikGHbf5BzP8tmjHBfTn04Y4Q+B/oY77k ygHChRc4liHOlg/g4= 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=3I/gUOUMfJN97ANrtpHrGfLHd/usyiKSIKxE5GADXRU=; b=RMHCtx4F 7P9IKFaqAxKptjWCCzJ+iHc4jY/daW3gxY+6r52SL8Ct/8yNdDQ6ONrB/vTCrVW+ Fe5HQnsClEBC1iUMBNHqSe+fJilEjY3tdNFSG0Tf+8Suzn/W1n4UvJb55HHL4w8d HYuWmWJTaIaBb+8T2KNWs7ri4tDnnhQQzjcaWsN98vyGtjogGUxPuHQ0QIjxnfsz AKD68fG2yJq1LYJxMD+oaATb2N47/0b2RUs/r8R0T9zt+JvQ84nfBlZhDcltOe13 Usb5cB/25XaTFBgrXO0B1EnP2vQSAkUpZxGzwDaIJ5waa7am3l3tSbulMPyUmLIl QteI2/ffA31HiA== 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 E1324102DE; Wed, 28 Nov 2018 09:52:49 -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:39 +0100 Message-Id: <20181128145240.26290-1-thomas@monjalon.net> X-Mailer: git-send-email 2.19.0 In-Reply-To: <20181128104430.22669-1-thomas@monjalon.net> References: <20181128104430.22669-1-thomas@monjalon.net> MIME-Version: 1.0 Subject: [dpdk-dev] [PATCH v2 1/2] version: 19.02-rc0 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" Start version numbering for a new release cycle, and introduce a template file for release notes. The release notes comments are updated to mandate a scope label for API and ABI changes. Signed-off-by: Thomas Monjalon Reviewed-by: Ferruh Yigit Acked-by: John McNamara --- doc/guides/rel_notes/index.rst | 1 + doc/guides/rel_notes/release_19_02.rst | 207 ++++++++++++++++++++ lib/librte_eal/common/include/rte_version.h | 8 +- meson.build | 2 +- 4 files changed, 213 insertions(+), 5 deletions(-) create mode 100644 doc/guides/rel_notes/release_19_02.rst diff --git a/doc/guides/rel_notes/index.rst b/doc/guides/rel_notes/index.rst index 1243e985c..ccfd38bcf 100644 --- a/doc/guides/rel_notes/index.rst +++ b/doc/guides/rel_notes/index.rst @@ -8,6 +8,7 @@ Release Notes :maxdepth: 1 :numbered: + release_19_02 release_18_11 release_18_08 release_18_05 diff --git a/doc/guides/rel_notes/release_19_02.rst b/doc/guides/rel_notes/release_19_02.rst new file mode 100644 index 000000000..cbb2ddb78 --- /dev/null +++ b/doc/guides/rel_notes/release_19_02.rst @@ -0,0 +1,207 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright 2018 The DPDK contributors + +DPDK Release 19.02 +================== + +.. **Read this first.** + + The text in the sections below explains how to update the release notes. + + Use proper spelling, capitalization and punctuation in all sections. + + Variable and config names should be quoted as fixed width text: + ``LIKE_THIS``. + + Build the docs and view the output file to ensure the changes are correct:: + + make doc-guides-html + + xdg-open build/doc/html/guides/rel_notes/release_19_02.html + + +New Features +------------ + +.. This section should contain new features added in this release. + Sample format: + + * **Add a title in the past tense with a full stop.** + + Add a short 1-2 sentence description in the past tense. + The description should be enough to allow someone scanning + the release notes to understand the new feature. + + If the feature adds a lot of sub-features you can use a bullet list + like this: + + * Added feature foo to do something. + * Enhanced feature bar to do something else. + + Refer to the previous release notes for examples. + + Suggested order in release notes items: + * Core libs (EAL, mempool, ring, mbuf, buses) + * Device abstraction libs and PMDs + - ethdev (lib, PMDs) + - cryptodev (lib, PMDs) + - eventdev (lib, PMDs) + - etc + * Other libs + * Apps, Examples, Tools (if significant) + + This section is a comment. Do not overwrite or remove it. + Also, make sure to start the actual text at the margin. + ========================================================= + + +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 +------------- + +.. This section should contain removed items in this release. Sample format: + + * Add a short 1-2 sentence description of the removed item + in 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 + + This section is a comment. Do not overwrite or remove it. + ========================================================= + +The libraries prepended with a plus sign were incremented in this version. + +.. code-block:: diff + + librte_acl.so.2 + librte_bbdev.so.1 + librte_bitratestats.so.2 + librte_bpf.so.1 + librte_bus_dpaa.so.2 + librte_bus_fslmc.so.2 + librte_bus_ifpga.so.2 + librte_bus_pci.so.2 + librte_bus_vdev.so.2 + librte_bus_vmbus.so.2 + librte_cfgfile.so.2 + librte_cmdline.so.2 + librte_compressdev.so.1 + librte_cryptodev.so.5 + librte_distributor.so.1 + librte_eal.so.9 + librte_efd.so.1 + librte_ethdev.so.11 + librte_eventdev.so.6 + librte_flow_classify.so.1 + librte_gro.so.1 + librte_gso.so.1 + librte_hash.so.2 + librte_ip_frag.so.1 + librte_jobstats.so.1 + librte_kni.so.2 + librte_kvargs.so.1 + librte_latencystats.so.1 + librte_lpm.so.2 + librte_mbuf.so.4 + librte_member.so.1 + librte_mempool.so.5 + librte_meter.so.2 + librte_metrics.so.1 + librte_net.so.1 + librte_pci.so.1 + librte_pdump.so.2 + librte_pipeline.so.3 + librte_pmd_bnxt.so.2 + librte_pmd_bond.so.2 + librte_pmd_i40e.so.2 + librte_pmd_ixgbe.so.2 + librte_pmd_dpaa2_qdma.so.1 + librte_pmd_ring.so.2 + librte_pmd_softnic.so.1 + librte_pmd_vhost.so.2 + librte_port.so.3 + librte_power.so.1 + librte_rawdev.so.1 + librte_reorder.so.1 + librte_ring.so.2 + librte_sched.so.1 + librte_security.so.1 + librte_table.so.3 + librte_timer.so.1 + librte_vhost.so.4 + + +Known Issues +------------ + +.. This section should contain new known issues in this release. Sample format: + + * **Add title in present tense with full stop.** + + Add a short 1-2 sentence description of the known issue + in the present tense. Add information on any known workarounds. + + This section is a comment. Do not overwrite or remove it. + Also, make sure to start the actual text at the margin. + ========================================================= + + +Tested Platforms +---------------- + +.. This section should contain a list of platforms that were tested + with this release. + + The format is: + + * platform with combinations + + * List of CPU + * List of OS + * List of devices + * Other relevant details... + + This section is a comment. Do not overwrite or remove it. + Also, make sure to start the actual text at the margin. + ========================================================= diff --git a/lib/librte_eal/common/include/rte_version.h b/lib/librte_eal/common/include/rte_version.h index f01c227f5..b790579a7 100644 --- a/lib/librte_eal/common/include/rte_version.h +++ b/lib/librte_eal/common/include/rte_version.h @@ -27,12 +27,12 @@ extern "C" { /** * Major version/year number i.e. the yy in yy.mm.z */ -#define RTE_VER_YEAR 18 +#define RTE_VER_YEAR 19 /** * Minor version/month number i.e. the mm in yy.mm.z */ -#define RTE_VER_MONTH 11 +#define RTE_VER_MONTH 2 /** * Patch level number i.e. the z in yy.mm.z @@ -42,14 +42,14 @@ extern "C" { /** * Extra string to be appended to version number */ -#define RTE_VER_SUFFIX "" +#define RTE_VER_SUFFIX "-rc" /** * Patch release number * 0-15 = release candidates * 16 = release */ -#define RTE_VER_RELEASE 16 +#define RTE_VER_RELEASE 0 /** * Macro to compute a version number usable for comparisons diff --git a/meson.build b/meson.build index 4122be83d..863f4e596 100644 --- a/meson.build +++ b/meson.build @@ -2,7 +2,7 @@ # Copyright(c) 2017 Intel Corporation project('DPDK', 'C', - version: '18.11.0', + version: '19.02.0-rc0' license: 'BSD', default_options: ['buildtype=release', 'default_library=static'], meson_version: '>= 0.41' 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. =========================================================