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 * **Added memif PMD.**
73 Added the new Shared Memory Packet Interface (``memif``) PMD.
74 See the :doc:`../nics/memif` guide for more details on this new driver.
80 .. This section should contain removed items in this release. Sample format:
82 * Add a short 1-2 sentence description of the removed item
85 This section is a comment. Do not overwrite or remove it.
86 Also, make sure to start the actual text at the margin.
87 =========================================================
89 * Removed KNI ethtool, CONFIG_RTE_KNI_KMOD_ETHTOOL, support.
91 * build: armv8 crypto extension is disabled.
97 .. This section should contain API changes. Sample format:
99 * sample: Add a short 1-2 sentence description of the API change
100 which was announced in the previous releases and made in this release.
101 Start with a scope label like "ethdev:".
102 Use fixed width quotes for ``function_names`` or ``struct_names``.
105 This section is a comment. Do not overwrite or remove it.
106 Also, make sure to start the actual text at the margin.
107 =========================================================
109 * The network structures, definitions and functions have
110 been prefixed by ``rte_`` to resolve conflicts with libc headers.
116 .. This section should contain ABI changes. Sample format:
118 * sample: Add a short 1-2 sentence description of the ABI change
119 which was announced in the previous releases and made in this release.
120 Start with a scope label like "ethdev:".
121 Use fixed width quotes for ``function_names`` or ``struct_names``.
124 This section is a comment. Do not overwrite or remove it.
125 Also, make sure to start the actual text at the margin.
126 =========================================================
129 Shared Library Versions
130 -----------------------
132 .. Update any library version updated in this release
133 and prepend with a ``+`` sign, like this:
139 This section is a comment. Do not overwrite or remove it.
140 =========================================================
142 The libraries prepended with a plus sign were incremented in this version.
148 librte_bitratestats.so.2
151 librte_bus_fslmc.so.2
152 librte_bus_ifpga.so.2
155 librte_bus_vmbus.so.2
158 librte_compressdev.so.1
159 librte_cryptodev.so.7
160 librte_distributor.so.1
165 librte_flow_classify.so.1
174 librte_latencystats.so.1
188 librte_pmd_ixgbe.so.2
189 librte_pmd_dpaa2_qdma.so.1
191 librte_pmd_softnic.so.1
192 librte_pmd_vhost.so.2
210 .. This section should contain new known issues in this release. Sample format:
212 * **Add title in present tense with full stop.**
214 Add a short 1-2 sentence description of the known issue
215 in the present tense. Add information on any known workarounds.
217 This section is a comment. Do not overwrite or remove it.
218 Also, make sure to start the actual text at the margin.
219 =========================================================
225 .. This section should contain a list of platforms that were tested
230 * <vendor> platform with <vendor> <type of devices> combinations
235 * Other relevant details...
237 This section is a comment. Do not overwrite or remove it.
238 Also, make sure to start the actual text at the margin.
239 =========================================================