1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright 2022 The DPDK contributors
4 .. include:: <isonum.txt>
9 .. **Read this first.**
11 The text in the sections below explains how to update the release notes.
13 Use proper spelling, capitalization and punctuation in all sections.
15 Variable and config names should be quoted as fixed width text:
18 Build the docs and view the output file to ensure the changes are correct::
21 xdg-open build/doc/guides/html/rel_notes/release_22_07.html
27 .. This section should contain new features added in this release.
30 * **Add a title in the past tense with a full stop.**
32 Add a short 1-2 sentence description in the past tense.
33 The description should be enough to allow someone scanning
34 the release notes to understand the new feature.
36 If the feature adds a lot of sub-features you can use a bullet list
39 * Added feature foo to do something.
40 * Enhanced feature bar to do something else.
42 Refer to the previous release notes for examples.
44 Suggested order in release notes items:
45 * Core libs (EAL, mempool, ring, mbuf, buses)
46 * Device abstraction libs and PMDs (ordered alphabetically by vendor name)
48 - cryptodev (lib, PMDs)
49 - eventdev (lib, PMDs)
52 * Apps, Examples, Tools (if significant)
54 This section is a comment. Do not overwrite or remove it.
55 Also, make sure to start the actual text at the margin.
56 =======================================================
58 * **Added vhost API to get the number of in-flight packets.**
60 Added an API which can get the number of in-flight packets in
61 vhost async data path without using lock.
63 * **Updated Intel iavf driver.**
65 * Added Tx QoS queue rate limitation support.
66 * Added quanta size configuration support.
67 * Added ``DEV_RX_OFFLOAD_TIMESTAMP`` support.
69 * **Updated Intel ice driver.**
71 * Added support for RSS RETA configure in DCF mode.
72 * Added support for RSS HASH configure in DCF mode.
73 * Added support for MTU configure in DCF mode.
74 * Added support for promisc configuration in DCF mode.
75 * Added support for MAC configuration in DCF mode.
76 * Added support for VLAN filter and offload configuration in DCF mode.
78 * **Updated Mellanox mlx5 driver.**
80 * Added support for promiscuous mode on Windows.
81 * Added support for MTU on Windows.
82 * Added matching and RSS on IPsec ESP.
84 * **Updated Marvell cnxk crypto driver.**
86 * Added AH mode support in lookaside protocol (IPsec) for CN9K & CN10K.
87 * Added AES-GMAC support in lookaside protocol (IPsec) for CN9K & CN10K.
89 * **Added eventdev API to quiesce an event port.**
91 Added the function ``rte_event_port_quiesce()``
92 to quiesce any lcore-specific resources consumed by the event port,
93 when the lcore is no more associated with an event port.
95 * **Added support for setting queue attributes at runtime in eventdev.**
97 Added new API ``rte_event_queue_attr_set()``, to set event queue attributes
100 * **Added new queues attributes weight and affinity in eventdev.**
102 Defined new event queue attributes weight and affinity as below:
104 * ``RTE_EVENT_QUEUE_ATTR_WEIGHT``
105 * ``RTE_EVENT_QUEUE_ATTR_AFFINITY``
111 .. This section should contain removed items in this release. Sample format:
113 * Add a short 1-2 sentence description of the removed item
116 This section is a comment. Do not overwrite or remove it.
117 Also, make sure to start the actual text at the margin.
118 =======================================================
124 .. This section should contain API changes. Sample format:
126 * sample: Add a short 1-2 sentence description of the API change
127 which was announced in the previous releases and made in this release.
128 Start with a scope label like "ethdev:".
129 Use fixed width quotes for ``function_names`` or ``struct_names``.
132 This section is a comment. Do not overwrite or remove it.
133 Also, make sure to start the actual text at the margin.
134 =======================================================
136 * The DPDK header file ``rte_altivec.h``,
137 which is a wrapper for the PPC header file ``altivec.h``,
138 undefines the AltiVec keyword ``vector``.
139 The alternative keyword ``__vector`` should be used instead.
145 .. This section should contain ABI changes. Sample format:
147 * sample: Add a short 1-2 sentence description of the ABI change
148 which was announced in the previous releases and made in this release.
149 Start with a scope label like "ethdev:".
150 Use fixed width quotes for ``function_names`` or ``struct_names``.
153 This section is a comment. Do not overwrite or remove it.
154 Also, make sure to start the actual text at the margin.
155 =======================================================
157 * No ABI change that would break compatibility with 21.11.
163 .. This section should contain new known issues in this release. Sample format:
165 * **Add title in present tense with full stop.**
167 Add a short 1-2 sentence description of the known issue
168 in the present tense. Add information on any known workarounds.
170 This section is a comment. Do not overwrite or remove it.
171 Also, make sure to start the actual text at the margin.
172 =======================================================
178 .. This section should contain a list of platforms that were tested
183 * <vendor> platform with <vendor> <type of devices> combinations
188 * Other relevant details...
190 This section is a comment. Do not overwrite or remove it.
191 Also, make sure to start the actual text at the margin.
192 =======================================================