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
68 .. This section should contain removed items in this release. Sample format:
70 * Add a short 1-2 sentence description of the removed item
73 This section is a comment. Do not overwrite or remove it.
74 Also, make sure to start the actual text at the margin.
75 =========================================================
77 * Removed KNI ethtool, CONFIG_RTE_KNI_KMOD_ETHTOOL, support.
79 * build: armv8 crypto extension is disabled.
85 .. This section should contain API changes. Sample format:
87 * sample: Add a short 1-2 sentence description of the API change
88 which was announced in the previous releases and made in this release.
89 Start with a scope label like "ethdev:".
90 Use fixed width quotes for ``function_names`` or ``struct_names``.
93 This section is a comment. Do not overwrite or remove it.
94 Also, make sure to start the actual text at the margin.
95 =========================================================
97 * The network structures, definitions and functions have
98 been prefixed by ``rte_`` to resolve conflicts with libc headers.
104 .. This section should contain ABI changes. Sample format:
106 * sample: Add a short 1-2 sentence description of the ABI change
107 which was announced in the previous releases and made in this release.
108 Start with a scope label like "ethdev:".
109 Use fixed width quotes for ``function_names`` or ``struct_names``.
112 This section is a comment. Do not overwrite or remove it.
113 Also, make sure to start the actual text at the margin.
114 =========================================================
117 Shared Library Versions
118 -----------------------
120 .. Update any library version updated in this release
121 and prepend with a ``+`` sign, like this:
127 This section is a comment. Do not overwrite or remove it.
128 =========================================================
130 The libraries prepended with a plus sign were incremented in this version.
136 librte_bitratestats.so.2
139 librte_bus_fslmc.so.2
140 librte_bus_ifpga.so.2
143 librte_bus_vmbus.so.2
146 librte_compressdev.so.1
147 librte_cryptodev.so.7
148 librte_distributor.so.1
153 librte_flow_classify.so.1
162 librte_latencystats.so.1
176 librte_pmd_ixgbe.so.2
177 librte_pmd_dpaa2_qdma.so.1
179 librte_pmd_softnic.so.1
180 librte_pmd_vhost.so.2
198 .. This section should contain new known issues in this release. Sample format:
200 * **Add title in present tense with full stop.**
202 Add a short 1-2 sentence description of the known issue
203 in the present tense. Add information on any known workarounds.
205 This section is a comment. Do not overwrite or remove it.
206 Also, make sure to start the actual text at the margin.
207 =========================================================
213 .. This section should contain a list of platforms that were tested
218 * <vendor> platform with <vendor> <type of devices> combinations
223 * Other relevant details...
225 This section is a comment. Do not overwrite or remove it.
226 Also, make sure to start the actual text at the margin.
227 =========================================================