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 * **Added API to register external memory in DPDK.**
68 A new ``rte_extmem_register``/``rte_extmem_unregister`` API was added to allow
69 chunks of external memory to be registered with DPDK without adding them to
72 * **Support for using virtio-user without hugepages**
74 The --no-huge mode was augmented to use memfd-backed memory (on systems that
75 support memfd), to allow using virtio-user-based NICs without hugepages.
77 * **Updated the enic driver.**
79 * Added support for ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
80 * Added the handler to get firmware version string.
81 * Added support for multicast filtering.
83 * **Added a compression performance test tool.**
85 Added a new performance test tool to test the compressdev PMD. The tool tests
86 compression ratio and compression throughput.
92 .. This section should contain removed items in this release. Sample format:
94 * Add a short 1-2 sentence description of the removed item
97 This section is a comment. Do not overwrite or remove it.
98 Also, make sure to start the actual text at the margin.
99 =========================================================
105 .. This section should contain API changes. Sample format:
107 * sample: Add a short 1-2 sentence description of the API change
108 which was announced in the previous releases and made in this release.
109 Start with a scope label like "ethdev:".
110 Use fixed width quotes for ``function_names`` or ``struct_names``.
113 This section is a comment. Do not overwrite or remove it.
114 Also, make sure to start the actual text at the margin.
115 =========================================================
117 * eal: Function ``rte_bsf64`` in ``rte_bitmap.h`` has been renamed to
118 ``rte_bsf64_safe`` and moved to ``rte_common.h``.
120 * eal: Segment fd API on Linux now sets error code to ``ENOTSUP`` in more cases
121 where segment fd API is not expected to be supported:
123 - On attempt to get segment fd for an externally allocated memory segment
124 - In cases where memfd support would have been required to provide segment
125 fd's (such as in-memory or no-huge mode)
127 * pdump: The ``rte_pdump_set_socket_dir()``, the parameter ``path`` of
128 ``rte_pdump_init()`` and enum ``rte_pdump_socktype`` were deprecated
129 since 18.05 and are removed in this release.
135 .. This section should contain ABI changes. Sample format:
137 * sample: Add a short 1-2 sentence description of the ABI change
138 which was announced in the previous releases and made in this release.
139 Start with a scope label like "ethdev:".
140 Use fixed width quotes for ``function_names`` or ``struct_names``.
143 This section is a comment. Do not overwrite or remove it.
144 Also, make sure to start the actual text at the margin.
145 =========================================================
148 Shared Library Versions
149 -----------------------
151 .. Update any library version updated in this release
152 and prepend with a ``+`` sign, like this:
158 This section is a comment. Do not overwrite or remove it.
159 =========================================================
161 The libraries prepended with a plus sign were incremented in this version.
167 librte_bitratestats.so.2
170 librte_bus_fslmc.so.2
171 librte_bus_ifpga.so.2
174 librte_bus_vmbus.so.2
177 librte_compressdev.so.1
178 librte_cryptodev.so.5
179 librte_distributor.so.1
184 librte_flow_classify.so.1
192 librte_latencystats.so.1
206 librte_pmd_ixgbe.so.2
207 librte_pmd_dpaa2_qdma.so.1
209 librte_pmd_softnic.so.1
210 librte_pmd_vhost.so.2
226 .. This section should contain new known issues in this release. Sample format:
228 * **Add title in present tense with full stop.**
230 Add a short 1-2 sentence description of the known issue
231 in the present tense. Add information on any known workarounds.
233 This section is a comment. Do not overwrite or remove it.
234 Also, make sure to start the actual text at the margin.
235 =========================================================
241 .. This section should contain a list of platforms that were tested
246 * <vendor> platform with <vendor> <type of devices> combinations
251 * Other relevant details...
253 This section is a comment. Do not overwrite or remove it.
254 Also, make sure to start the actual text at the margin.
255 =========================================================