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.
80 * **Updated the enic driver.**
82 * Fixed several flow (director) bugs related to MARK, SCTP, VLAN, VXLAN, and
83 inner packet matching.
84 * Added limited support for RAW.
85 * Added limited support for RSS.
86 * Added limited support for PASSTHRU.
88 * **Updated the ixgbe driver.**
92 * Added promiscuous mode support.
98 .. This section should contain removed items in this release. Sample format:
100 * Add a short 1-2 sentence description of the removed item
103 This section is a comment. Do not overwrite or remove it.
104 Also, make sure to start the actual text at the margin.
105 =========================================================
111 .. This section should contain API changes. Sample format:
113 * sample: Add a short 1-2 sentence description of the API change
114 which was announced in the previous releases and made in this release.
115 Start with a scope label like "ethdev:".
116 Use fixed width quotes for ``function_names`` or ``struct_names``.
119 This section is a comment. Do not overwrite or remove it.
120 Also, make sure to start the actual text at the margin.
121 =========================================================
127 .. This section should contain ABI changes. Sample format:
129 * sample: Add a short 1-2 sentence description of the ABI change
130 which was announced in the previous releases and made in this release.
131 Start with a scope label like "ethdev:".
132 Use fixed width quotes for ``function_names`` or ``struct_names``.
135 This section is a comment. Do not overwrite or remove it.
136 Also, make sure to start the actual text at the margin.
137 =========================================================
140 Shared Library Versions
141 -----------------------
143 .. Update any library version updated in this release
144 and prepend with a ``+`` sign, like this:
150 This section is a comment. Do not overwrite or remove it.
151 =========================================================
153 The libraries prepended with a plus sign were incremented in this version.
159 librte_bitratestats.so.2
162 librte_bus_fslmc.so.2
163 librte_bus_ifpga.so.2
166 librte_bus_vmbus.so.2
169 librte_compressdev.so.1
170 librte_cryptodev.so.6
171 librte_distributor.so.1
176 librte_flow_classify.so.1
184 librte_latencystats.so.1
198 librte_pmd_ixgbe.so.2
199 librte_pmd_dpaa2_qdma.so.1
201 librte_pmd_softnic.so.1
202 librte_pmd_vhost.so.2
218 .. This section should contain new known issues in this release. Sample format:
220 * **Add title in present tense with full stop.**
222 Add a short 1-2 sentence description of the known issue
223 in the present tense. Add information on any known workarounds.
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 =========================================================
233 .. This section should contain a list of platforms that were tested
238 * <vendor> platform with <vendor> <type of devices> combinations
243 * Other relevant details...
245 This section is a comment. Do not overwrite or remove it.
246 Also, make sure to start the actual text at the margin.
247 =========================================================