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 * **Updated the enic driver.**
74 * Added support for ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
75 * Added the handler to get firmware version string.
76 * Added support for multicast filtering.
78 * **Added a compression performance test tool.**
80 Added a new performance test tool to test the compressdev PMD. The tool tests
81 compression ratio and compression throughput.
87 .. This section should contain removed items in this release. Sample format:
89 * Add a short 1-2 sentence description of the removed item
92 This section is a comment. Do not overwrite or remove it.
93 Also, make sure to start the actual text at the margin.
94 =========================================================
100 .. This section should contain API changes. Sample format:
102 * sample: Add a short 1-2 sentence description of the API change
103 which was announced in the previous releases and made in this release.
104 Start with a scope label like "ethdev:".
105 Use fixed width quotes for ``function_names`` or ``struct_names``.
108 This section is a comment. Do not overwrite or remove it.
109 Also, make sure to start the actual text at the margin.
110 =========================================================
112 * eal: Segment fd API on Linux now sets error code to ``ENOTSUP`` in more cases
113 where segment fd API is not expected to be supported:
115 - On attempt to get segment fd for an externally allocated memory segment
117 * pdump: The ``rte_pdump_set_socket_dir()``, the parameter ``path`` of
118 ``rte_pdump_init()`` and enum ``rte_pdump_socktype`` were deprecated
119 since 18.05 and are removed in this release.
125 .. This section should contain ABI changes. Sample format:
127 * sample: Add a short 1-2 sentence description of the ABI change
128 which was announced in the previous releases and made in this release.
129 Start with a scope label like "ethdev:".
130 Use fixed width quotes for ``function_names`` or ``struct_names``.
133 This section is a comment. Do not overwrite or remove it.
134 Also, make sure to start the actual text at the margin.
135 =========================================================
138 Shared Library Versions
139 -----------------------
141 .. Update any library version updated in this release
142 and prepend with a ``+`` sign, like this:
148 This section is a comment. Do not overwrite or remove it.
149 =========================================================
151 The libraries prepended with a plus sign were incremented in this version.
157 librte_bitratestats.so.2
160 librte_bus_fslmc.so.2
161 librte_bus_ifpga.so.2
164 librte_bus_vmbus.so.2
167 librte_compressdev.so.1
168 librte_cryptodev.so.5
169 librte_distributor.so.1
174 librte_flow_classify.so.1
182 librte_latencystats.so.1
196 librte_pmd_ixgbe.so.2
197 librte_pmd_dpaa2_qdma.so.1
199 librte_pmd_softnic.so.1
200 librte_pmd_vhost.so.2
216 .. This section should contain new known issues in this release. Sample format:
218 * **Add title in present tense with full stop.**
220 Add a short 1-2 sentence description of the known issue
221 in the present tense. Add information on any known workarounds.
223 This section is a comment. Do not overwrite or remove it.
224 Also, make sure to start the actual text at the margin.
225 =========================================================
231 .. This section should contain a list of platforms that were tested
236 * <vendor> platform with <vendor> <type of devices> combinations
241 * Other relevant details...
243 This section is a comment. Do not overwrite or remove it.
244 Also, make sure to start the actual text at the margin.
245 =========================================================