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 In addition, <rte_random.h> is extended with a new function
68 rte_rand_max() which supplies unbiased, bounded pseudo-random
71 * **Updated the bnxt PMD.**
73 Updated the bnxt PMD. The major enhancements include:
75 * Performance optimizations in non-vector Tx path
76 * Added support for SSE vector mode
77 * Updated HWRM API to version 1.10.0.74
79 * **Added support for Broadcom NetXtreme-E BCM57500 Ethernet controllers.**
81 Added support to the bnxt PMD for the BCM57500 (a.k.a. "Thor") family
82 of Ethernet controllers. These controllers support link speeds up to
83 200Gbps, 50G PAM-4, and PCIe 4.0.
85 * **Updated the ice driver.**
87 Updated ice driver with new features and improvements, including:
89 * Enabled Tx outer/inner L3/L4 checksum offload.
91 * **Updated Solarflare network PMD.**
93 Updated the Solarflare ``sfc_efx`` driver with changes including:
95 * Added support for Rx interrupts.
97 * **Added memif PMD.**
99 Added the new Shared Memory Packet Interface (``memif``) PMD.
100 See the :doc:`../nics/memif` guide for more details on this new driver.
102 * **Updated the AF_XDP PMD.**
104 Updated the AF_XDP PMD. The new features include:
106 * Enabled zero copy through mbuf's external memory mechanism to achieve
108 * Added multi-queue support to allow one af_xdp vdev with multiple netdev
111 * **Updated telemetry library for global metrics support.**
113 Updated ``librte_telemetry`` to fetch the global metrics from the
114 ``librte_metrics`` library.
116 * **Added new telemetry mode for l3fwd-power application.**
118 Added telemetry mode to l3fwd-power application to report
119 application level busyness, empty and full polls of rte_eth_rx_burst().
125 .. This section should contain removed items in this release. Sample format:
127 * Add a short 1-2 sentence description of the removed item
130 This section is a comment. Do not overwrite or remove it.
131 Also, make sure to start the actual text at the margin.
132 =========================================================
134 * Removed KNI ethtool, CONFIG_RTE_KNI_KMOD_ETHTOOL, support.
136 * build: armv8 crypto extension is disabled.
142 .. This section should contain API changes. Sample format:
144 * sample: Add a short 1-2 sentence description of the API 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 =========================================================
154 * The network structures, definitions and functions have
155 been prefixed by ``rte_`` to resolve conflicts with libc headers.
161 .. This section should contain ABI changes. Sample format:
163 * sample: Add a short 1-2 sentence description of the ABI change
164 which was announced in the previous releases and made in this release.
165 Start with a scope label like "ethdev:".
166 Use fixed width quotes for ``function_names`` or ``struct_names``.
169 This section is a comment. Do not overwrite or remove it.
170 Also, make sure to start the actual text at the margin.
171 =========================================================
174 Shared Library Versions
175 -----------------------
177 .. Update any library version updated in this release
178 and prepend with a ``+`` sign, like this:
184 This section is a comment. Do not overwrite or remove it.
185 =========================================================
187 The libraries prepended with a plus sign were incremented in this version.
193 librte_bitratestats.so.2
196 librte_bus_fslmc.so.2
197 librte_bus_ifpga.so.2
200 librte_bus_vmbus.so.2
203 librte_compressdev.so.1
204 librte_cryptodev.so.7
205 librte_distributor.so.1
210 librte_flow_classify.so.1
219 librte_latencystats.so.1
233 librte_pmd_ixgbe.so.2
234 librte_pmd_dpaa2_qdma.so.1
236 librte_pmd_softnic.so.1
237 librte_pmd_vhost.so.2
255 .. This section should contain new known issues in this release. Sample format:
257 * **Add title in present tense with full stop.**
259 Add a short 1-2 sentence description of the known issue
260 in the present tense. Add information on any known workarounds.
262 This section is a comment. Do not overwrite or remove it.
263 Also, make sure to start the actual text at the margin.
264 =========================================================
270 .. This section should contain a list of platforms that were tested
275 * <vendor> platform with <vendor> <type of devices> combinations
280 * Other relevant details...
282 This section is a comment. Do not overwrite or remove it.
283 Also, make sure to start the actual text at the margin.
284 =========================================================