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_05.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 Solarflare network PMD.**
59 Updated the sfc_efx driver including the following changes:
61 * Added support for Rx descriptor status and related API in a secondary
63 * Added support for Tx descriptor status API in a secondary process.
64 * Added support for RSS RETA and hash configuration get API in a secondary
66 * Added support for Rx packet types list in a secondary process.
72 .. This section should contain removed items in this release. Sample format:
74 * Add a short 1-2 sentence description of the removed item
77 This section is a comment. Do not overwrite or remove it.
78 Also, make sure to start the actual text at the margin.
79 =========================================================
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 =========================================================
101 .. This section should contain ABI changes. Sample format:
103 * sample: Add a short 1-2 sentence description of the ABI change
104 which was announced in the previous releases and made in this release.
105 Start with a scope label like "ethdev:".
106 Use fixed width quotes for ``function_names`` or ``struct_names``.
109 This section is a comment. Do not overwrite or remove it.
110 Also, make sure to start the actual text at the margin.
111 =========================================================
114 Shared Library Versions
115 -----------------------
117 .. Update any library version updated in this release
118 and prepend with a ``+`` sign, like this:
124 This section is a comment. Do not overwrite or remove it.
125 =========================================================
127 The libraries prepended with a plus sign were incremented in this version.
133 librte_bitratestats.so.2
136 librte_bus_fslmc.so.2
137 librte_bus_ifpga.so.2
140 librte_bus_vmbus.so.2
143 librte_compressdev.so.1
144 librte_cryptodev.so.6
145 librte_distributor.so.1
150 librte_flow_classify.so.1
158 librte_latencystats.so.1
172 librte_pmd_ixgbe.so.2
173 librte_pmd_dpaa2_qdma.so.1
175 librte_pmd_softnic.so.1
176 librte_pmd_vhost.so.2
192 .. This section should contain new known issues in this release. Sample format:
194 * **Add title in present tense with full stop.**
196 Add a short 1-2 sentence description of the known issue
197 in the present tense. Add information on any known workarounds.
199 This section is a comment. Do not overwrite or remove it.
200 Also, make sure to start the actual text at the margin.
201 =========================================================
207 .. This section should contain a list of platforms that were tested
212 * <vendor> platform with <vendor> <type of devices> combinations
217 * Other relevant details...
219 This section is a comment. Do not overwrite or remove it.
220 Also, make sure to start the actual text at the margin.
221 =========================================================