1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright 2019 The DPDK contributors
7 .. **Read this first.**
9 The text in the sections below explains how to update the release notes.
11 Use proper spelling, capitalization and punctuation in all sections.
13 Variable and config names should be quoted as fixed width text:
16 Build the docs and view the output file to ensure the changes are correct::
20 xdg-open build/doc/html/guides/rel_notes/release_19_08.html
26 .. This section should contain new features added in this release.
29 * **Add a title in the past tense with a full stop.**
31 Add a short 1-2 sentence description in the past tense.
32 The description should be enough to allow someone scanning
33 the release notes to understand the new feature.
35 If the feature adds a lot of sub-features you can use a bullet list
38 * Added feature foo to do something.
39 * Enhanced feature bar to do something else.
41 Refer to the previous release notes for examples.
43 Suggested order in release notes items:
44 * Core libs (EAL, mempool, ring, mbuf, buses)
45 * Device abstraction libs and PMDs
47 - cryptodev (lib, PMDs)
48 - eventdev (lib, PMDs)
51 * Apps, Examples, Tools (if significant)
53 This section is a comment. Do not overwrite or remove it.
54 Also, make sure to start the actual text at the margin.
55 =========================================================
57 * **Updated the bnxt PMD.**
59 Updated the bnxt PMD. The major enhancements include:
61 * Performance optimizations in non-vector Tx path
62 * Added support for SSE vector mode
63 * Updated HWRM API to version 1.10.0.74
65 * **Added support for Broadcom NetXtreme-E BCM57500 Ethernet controllers.**
67 Added support to the bnxt PMD for the BCM57500 (a.k.a. "Thor") family
68 of Ethernet controllers. These controllers support link speeds up to
69 200Gbps, 50G PAM-4, and PCIe 4.0.
71 * **Updated the ice driver.**
73 Updated ice driver with new features and improvements, including:
75 * Enabled Tx outer/inner L3/L4 checksum offload.
77 * **Updated Solarflare network PMD.**
79 Updated the Solarflare ``sfc_efx`` driver with changes including:
81 * Added support for Rx interrupts.
83 * **Added memif PMD.**
85 Added the new Shared Memory Packet Interface (``memif``) PMD.
86 See the :doc:`../nics/memif` guide for more details on this new driver.
88 * **Updated the AF_XDP PMD.**
90 Updated the AF_XDP PMD. The new features include:
92 * Enabled zero copy through mbuf's external memory mechanism to achieve
94 * Added multi-queue support to allow one af_xdp vdev with multiple netdev
97 * **Updated telemetry library for global metrics support.**
99 Updated ``librte_telemetry`` to fetch the global metrics from the
100 ``librte_metrics`` library.
106 .. This section should contain removed items in this release. Sample format:
108 * Add a short 1-2 sentence description of the removed item
111 This section is a comment. Do not overwrite or remove it.
112 Also, make sure to start the actual text at the margin.
113 =========================================================
115 * Removed KNI ethtool, CONFIG_RTE_KNI_KMOD_ETHTOOL, support.
117 * build: armv8 crypto extension is disabled.
123 .. This section should contain API changes. Sample format:
125 * sample: Add a short 1-2 sentence description of the API change
126 which was announced in the previous releases and made in this release.
127 Start with a scope label like "ethdev:".
128 Use fixed width quotes for ``function_names`` or ``struct_names``.
131 This section is a comment. Do not overwrite or remove it.
132 Also, make sure to start the actual text at the margin.
133 =========================================================
135 * The network structures, definitions and functions have
136 been prefixed by ``rte_`` to resolve conflicts with libc headers.
142 .. This section should contain ABI changes. Sample format:
144 * sample: Add a short 1-2 sentence description of the ABI change
145 which was announced in the previous releases and made in this release.
146 Start with a scope label like "ethdev:".
147 Use fixed width quotes for ``function_names`` or ``struct_names``.
150 This section is a comment. Do not overwrite or remove it.
151 Also, make sure to start the actual text at the margin.
152 =========================================================
155 Shared Library Versions
156 -----------------------
158 .. Update any library version updated in this release
159 and prepend with a ``+`` sign, like this:
165 This section is a comment. Do not overwrite or remove it.
166 =========================================================
168 The libraries prepended with a plus sign were incremented in this version.
174 librte_bitratestats.so.2
177 librte_bus_fslmc.so.2
178 librte_bus_ifpga.so.2
181 librte_bus_vmbus.so.2
184 librte_compressdev.so.1
185 librte_cryptodev.so.7
186 librte_distributor.so.1
191 librte_flow_classify.so.1
200 librte_latencystats.so.1
214 librte_pmd_ixgbe.so.2
215 librte_pmd_dpaa2_qdma.so.1
217 librte_pmd_softnic.so.1
218 librte_pmd_vhost.so.2
236 .. This section should contain new known issues in this release. Sample format:
238 * **Add title in present tense with full stop.**
240 Add a short 1-2 sentence description of the known issue
241 in the present tense. Add information on any known workarounds.
243 This section is a comment. Do not overwrite or remove it.
244 Also, make sure to start the actual text at the margin.
245 =========================================================
251 .. This section should contain a list of platforms that were tested
256 * <vendor> platform with <vendor> <type of devices> combinations
261 * Other relevant details...
263 This section is a comment. Do not overwrite or remove it.
264 Also, make sure to start the actual text at the margin.
265 =========================================================