1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright 2018 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_02.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 enic driver.**
59 * Added support for ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
60 * Added the handler to get firmware version string.
61 * Added support for multicast filtering.
63 * **Added a compression performance test tool.**
65 Added a new performance test tool to test the compressdev PMD. The tool tests
66 compression ratio and compression throughput. Dynamic compression test is not
73 .. This section should contain removed items in this release. Sample format:
75 * Add a short 1-2 sentence description of the removed item
78 This section is a comment. Do not overwrite or remove it.
79 Also, make sure to start the actual text at the margin.
80 =========================================================
86 .. This section should contain API changes. Sample format:
88 * sample: Add a short 1-2 sentence description of the API change
89 which was announced in the previous releases and made in this release.
90 Start with a scope label like "ethdev:".
91 Use fixed width quotes for ``function_names`` or ``struct_names``.
94 This section is a comment. Do not overwrite or remove it.
95 Also, make sure to start the actual text at the margin.
96 =========================================================
98 * pdump: The ``rte_pdump_set_socket_dir()``, the parameter ``path`` of
99 ``rte_pdump_init()`` and enum ``rte_pdump_socktype`` were deprecated
100 since 18.05 and are removed in this release.
106 .. This section should contain ABI changes. Sample format:
108 * sample: Add a short 1-2 sentence description of the ABI change
109 which was announced in the previous releases and made in this release.
110 Start with a scope label like "ethdev:".
111 Use fixed width quotes for ``function_names`` or ``struct_names``.
114 This section is a comment. Do not overwrite or remove it.
115 Also, make sure to start the actual text at the margin.
116 =========================================================
119 Shared Library Versions
120 -----------------------
122 .. Update any library version updated in this release
123 and prepend with a ``+`` sign, like this:
129 This section is a comment. Do not overwrite or remove it.
130 =========================================================
132 The libraries prepended with a plus sign were incremented in this version.
138 librte_bitratestats.so.2
141 librte_bus_fslmc.so.2
142 librte_bus_ifpga.so.2
145 librte_bus_vmbus.so.2
148 librte_compressdev.so.1
149 librte_cryptodev.so.5
150 librte_distributor.so.1
155 librte_flow_classify.so.1
163 librte_latencystats.so.1
177 librte_pmd_ixgbe.so.2
178 librte_pmd_dpaa2_qdma.so.1
180 librte_pmd_softnic.so.1
181 librte_pmd_vhost.so.2
197 .. This section should contain new known issues in this release. Sample format:
199 * **Add title in present tense with full stop.**
201 Add a short 1-2 sentence description of the known issue
202 in the present tense. Add information on any known workarounds.
204 This section is a comment. Do not overwrite or remove it.
205 Also, make sure to start the actual text at the margin.
206 =========================================================
212 .. This section should contain a list of platforms that were tested
217 * <vendor> platform with <vendor> <type of devices> combinations
222 * Other relevant details...
224 This section is a comment. Do not overwrite or remove it.
225 Also, make sure to start the actual text at the margin.
226 =========================================================