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 EAL Pseudo-random Number Generator.**
59 The lrand48()-based rte_rand() function is replaced with a
60 DPDK-native combined Linear Feedback Shift Register (LFSR)
61 pseudo-random number generator (PRNG).
63 This new PRNG implementation is multi-thread safe, provides
64 higher-quality pseudo-random numbers (including full 64 bit
65 support) and improved performance.
67 * **Updated the bnxt PMD.**
69 Updated the bnxt PMD. The major enhancements include:
71 * Performance optimizations in non-vector Tx path
72 * Added support for SSE vector mode
73 * Updated HWRM API to version 1.10.0.74
75 * **Added support for Broadcom NetXtreme-E BCM57500 Ethernet controllers.**
77 Added support to the bnxt PMD for the BCM57500 (a.k.a. "Thor") family
78 of Ethernet controllers. These controllers support link speeds up to
79 200Gbps, 50G PAM-4, and PCIe 4.0.
81 * **Updated the ice driver.**
83 Updated ice driver with new features and improvements, including:
85 * Enabled Tx outer/inner L3/L4 checksum offload.
87 * **Updated Solarflare network PMD.**
89 Updated the Solarflare ``sfc_efx`` driver with changes including:
91 * Added support for Rx interrupts.
93 * **Added memif PMD.**
95 Added the new Shared Memory Packet Interface (``memif``) PMD.
96 See the :doc:`../nics/memif` guide for more details on this new driver.
98 * **Updated the AF_XDP PMD.**
100 Updated the AF_XDP PMD. The new features include:
102 * Enabled zero copy through mbuf's external memory mechanism to achieve
104 * Added multi-queue support to allow one af_xdp vdev with multiple netdev
107 * **Updated telemetry library for global metrics support.**
109 Updated ``librte_telemetry`` to fetch the global metrics from the
110 ``librte_metrics`` library.
112 * **Added new telemetry mode for l3fwd-power application.**
114 Added telemetry mode to l3fwd-power application to report
115 application level busyness, empty and full polls of rte_eth_rx_burst().
121 .. This section should contain removed items in this release. Sample format:
123 * Add a short 1-2 sentence description of the removed item
126 This section is a comment. Do not overwrite or remove it.
127 Also, make sure to start the actual text at the margin.
128 =========================================================
130 * Removed KNI ethtool, CONFIG_RTE_KNI_KMOD_ETHTOOL, support.
132 * build: armv8 crypto extension is disabled.
138 .. This section should contain API changes. Sample format:
140 * sample: Add a short 1-2 sentence description of the API change
141 which was announced in the previous releases and made in this release.
142 Start with a scope label like "ethdev:".
143 Use fixed width quotes for ``function_names`` or ``struct_names``.
146 This section is a comment. Do not overwrite or remove it.
147 Also, make sure to start the actual text at the margin.
148 =========================================================
150 * The network structures, definitions and functions have
151 been prefixed by ``rte_`` to resolve conflicts with libc headers.
157 .. This section should contain ABI changes. Sample format:
159 * sample: Add a short 1-2 sentence description of the ABI change
160 which was announced in the previous releases and made in this release.
161 Start with a scope label like "ethdev:".
162 Use fixed width quotes for ``function_names`` or ``struct_names``.
165 This section is a comment. Do not overwrite or remove it.
166 Also, make sure to start the actual text at the margin.
167 =========================================================
170 Shared Library Versions
171 -----------------------
173 .. Update any library version updated in this release
174 and prepend with a ``+`` sign, like this:
180 This section is a comment. Do not overwrite or remove it.
181 =========================================================
183 The libraries prepended with a plus sign were incremented in this version.
189 librte_bitratestats.so.2
192 librte_bus_fslmc.so.2
193 librte_bus_ifpga.so.2
196 librte_bus_vmbus.so.2
199 librte_compressdev.so.1
200 librte_cryptodev.so.7
201 librte_distributor.so.1
206 librte_flow_classify.so.1
215 librte_latencystats.so.1
229 librte_pmd_ixgbe.so.2
230 librte_pmd_dpaa2_qdma.so.1
232 librte_pmd_softnic.so.1
233 librte_pmd_vhost.so.2
251 .. This section should contain new known issues in this release. Sample format:
253 * **Add title in present tense with full stop.**
255 Add a short 1-2 sentence description of the known issue
256 in the present tense. Add information on any known workarounds.
258 This section is a comment. Do not overwrite or remove it.
259 Also, make sure to start the actual text at the margin.
260 =========================================================
266 .. This section should contain a list of platforms that were tested
271 * <vendor> platform with <vendor> <type of devices> combinations
276 * Other relevant details...
278 This section is a comment. Do not overwrite or remove it.
279 Also, make sure to start the actual text at the margin.
280 =========================================================