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 * **Added support to free hugepages exactly as originally allocated.**
59 Some applications using memory event callbacks (especially for managing
60 RDMA memory regions) require that memory be freed back to the system
61 exactly as it was originally allocated. These applications typically
62 also require that a malloc allocation not span across two separate
63 hugepage allocations. A new ``--match-allocations`` EAL init flag has
64 been added to fulfill both of these requirements.
66 * **Updated the enic driver.**
68 * Added support for ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
69 * Added the handler to get firmware version string.
70 * Added support for multicast filtering.
72 * **Added a compression performance test tool.**
74 Added a new performance test tool to test the compressdev PMD. The tool tests
75 compression ratio and compression throughput.
81 .. This section should contain removed items in this release. Sample format:
83 * Add a short 1-2 sentence description of the removed item
86 This section is a comment. Do not overwrite or remove it.
87 Also, make sure to start the actual text at the margin.
88 =========================================================
94 .. This section should contain API changes. Sample format:
96 * sample: Add a short 1-2 sentence description of the API change
97 which was announced in the previous releases and made in this release.
98 Start with a scope label like "ethdev:".
99 Use fixed width quotes for ``function_names`` or ``struct_names``.
102 This section is a comment. Do not overwrite or remove it.
103 Also, make sure to start the actual text at the margin.
104 =========================================================
106 * pdump: The ``rte_pdump_set_socket_dir()``, the parameter ``path`` of
107 ``rte_pdump_init()`` and enum ``rte_pdump_socktype`` were deprecated
108 since 18.05 and are removed in this release.
114 .. This section should contain ABI changes. Sample format:
116 * sample: Add a short 1-2 sentence description of the ABI change
117 which was announced in the previous releases and made in this release.
118 Start with a scope label like "ethdev:".
119 Use fixed width quotes for ``function_names`` or ``struct_names``.
122 This section is a comment. Do not overwrite or remove it.
123 Also, make sure to start the actual text at the margin.
124 =========================================================
127 Shared Library Versions
128 -----------------------
130 .. Update any library version updated in this release
131 and prepend with a ``+`` sign, like this:
137 This section is a comment. Do not overwrite or remove it.
138 =========================================================
140 The libraries prepended with a plus sign were incremented in this version.
146 librte_bitratestats.so.2
149 librte_bus_fslmc.so.2
150 librte_bus_ifpga.so.2
153 librte_bus_vmbus.so.2
156 librte_compressdev.so.1
157 librte_cryptodev.so.5
158 librte_distributor.so.1
163 librte_flow_classify.so.1
171 librte_latencystats.so.1
185 librte_pmd_ixgbe.so.2
186 librte_pmd_dpaa2_qdma.so.1
188 librte_pmd_softnic.so.1
189 librte_pmd_vhost.so.2
205 .. This section should contain new known issues in this release. Sample format:
207 * **Add title in present tense with full stop.**
209 Add a short 1-2 sentence description of the known issue
210 in the present tense. Add information on any known workarounds.
212 This section is a comment. Do not overwrite or remove it.
213 Also, make sure to start the actual text at the margin.
214 =========================================================
220 .. This section should contain a list of platforms that were tested
225 * <vendor> platform with <vendor> <type of devices> combinations
230 * Other relevant details...
232 This section is a comment. Do not overwrite or remove it.
233 Also, make sure to start the actual text at the margin.
234 =========================================================