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.
68 * **Updated Mellanox drivers.**
70 New features and improvements were done in mlx4 and mlx5 PMDs:
72 * Added firmware version reading.
74 * **Renamed avf to iavf.**
76 Renamed Intel Ethernet Adaptive Virtual Function driver ``avf`` to ``iavf``,
77 which includes the directory name, lib name, filenames, makefile, docs,
78 macros, functions, structs and any other strings in the code.
84 .. This section should contain removed items in this release. Sample format:
86 * Add a short 1-2 sentence description of the removed item
89 This section is a comment. Do not overwrite or remove it.
90 Also, make sure to start the actual text at the margin.
91 =========================================================
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 =========================================================
113 .. This section should contain ABI changes. Sample format:
115 * sample: Add a short 1-2 sentence description of the ABI change
116 which was announced in the previous releases and made in this release.
117 Start with a scope label like "ethdev:".
118 Use fixed width quotes for ``function_names`` or ``struct_names``.
121 This section is a comment. Do not overwrite or remove it.
122 Also, make sure to start the actual text at the margin.
123 =========================================================
126 Shared Library Versions
127 -----------------------
129 .. Update any library version updated in this release
130 and prepend with a ``+`` sign, like this:
136 This section is a comment. Do not overwrite or remove it.
137 =========================================================
139 The libraries prepended with a plus sign were incremented in this version.
145 librte_bitratestats.so.2
148 librte_bus_fslmc.so.2
149 librte_bus_ifpga.so.2
152 librte_bus_vmbus.so.2
155 librte_compressdev.so.1
156 librte_cryptodev.so.6
157 librte_distributor.so.1
162 librte_flow_classify.so.1
170 librte_latencystats.so.1
184 librte_pmd_ixgbe.so.2
185 librte_pmd_dpaa2_qdma.so.1
187 librte_pmd_softnic.so.1
188 librte_pmd_vhost.so.2
204 .. This section should contain new known issues in this release. Sample format:
206 * **Add title in present tense with full stop.**
208 Add a short 1-2 sentence description of the known issue
209 in the present tense. Add information on any known workarounds.
211 This section is a comment. Do not overwrite or remove it.
212 Also, make sure to start the actual text at the margin.
213 =========================================================
219 .. This section should contain a list of platforms that were tested
224 * <vendor> platform with <vendor> <type of devices> combinations
229 * Other relevant details...
231 This section is a comment. Do not overwrite or remove it.
232 Also, make sure to start the actual text at the margin.
233 =========================================================