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.
67 .. This section should contain removed items in this release. Sample format:
69 * Add a short 1-2 sentence description of the removed item
72 This section is a comment. Do not overwrite or remove it.
73 Also, make sure to start the actual text at the margin.
74 =========================================================
80 .. This section should contain API changes. Sample format:
82 * sample: Add a short 1-2 sentence description of the API change
83 which was announced in the previous releases and made in this release.
84 Start with a scope label like "ethdev:".
85 Use fixed width quotes for ``function_names`` or ``struct_names``.
88 This section is a comment. Do not overwrite or remove it.
89 Also, make sure to start the actual text at the margin.
90 =========================================================
92 * pdump: The ``rte_pdump_set_socket_dir()``, the parameter ``path`` of
93 ``rte_pdump_init()`` and enum ``rte_pdump_socktype`` were deprecated
94 since 18.05 and are removed in this release.
100 .. This section should contain ABI changes. Sample format:
102 * sample: Add a short 1-2 sentence description of the ABI 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 =========================================================
113 Shared Library Versions
114 -----------------------
116 .. Update any library version updated in this release
117 and prepend with a ``+`` sign, like this:
123 This section is a comment. Do not overwrite or remove it.
124 =========================================================
126 The libraries prepended with a plus sign were incremented in this version.
132 librte_bitratestats.so.2
135 librte_bus_fslmc.so.2
136 librte_bus_ifpga.so.2
139 librte_bus_vmbus.so.2
142 librte_compressdev.so.1
143 librte_cryptodev.so.5
144 librte_distributor.so.1
149 librte_flow_classify.so.1
157 librte_latencystats.so.1
171 librte_pmd_ixgbe.so.2
172 librte_pmd_dpaa2_qdma.so.1
174 librte_pmd_softnic.so.1
175 librte_pmd_vhost.so.2
191 .. This section should contain new known issues in this release. Sample format:
193 * **Add title in present tense with full stop.**
195 Add a short 1-2 sentence description of the known issue
196 in the present tense. Add information on any known workarounds.
198 This section is a comment. Do not overwrite or remove it.
199 Also, make sure to start the actual text at the margin.
200 =========================================================
206 .. This section should contain a list of platforms that were tested
211 * <vendor> platform with <vendor> <type of devices> combinations
216 * Other relevant details...
218 This section is a comment. Do not overwrite or remove it.
219 Also, make sure to start the actual text at the margin.
220 =========================================================