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.
73 * **Updated Mellanox mlx5 driver.**
75 * Added support for promiscuous mode on Windows.
76 * Added support for MTU on Windows.
78 * **Updated Marvell cnxk crypto driver.**
80 * Added AH mode support in lookaside protocol (IPsec) for CN9K & CN10K.
81 * Added AES-GMAC support in lookaside protocol (IPsec) for CN9K & CN10K.
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 =======================================================
116 .. This section should contain ABI changes. Sample format:
118 * sample: Add a short 1-2 sentence description of the ABI change
119 which was announced in the previous releases and made in this release.
120 Start with a scope label like "ethdev:".
121 Use fixed width quotes for ``function_names`` or ``struct_names``.
124 This section is a comment. Do not overwrite or remove it.
125 Also, make sure to start the actual text at the margin.
126 =======================================================
128 * No ABI change that would break compatibility with 21.11.
134 .. This section should contain new known issues in this release. Sample format:
136 * **Add title in present tense with full stop.**
138 Add a short 1-2 sentence description of the known issue
139 in the present tense. Add information on any known workarounds.
141 This section is a comment. Do not overwrite or remove it.
142 Also, make sure to start the actual text at the margin.
143 =======================================================
149 .. This section should contain a list of platforms that were tested
154 * <vendor> platform with <vendor> <type of devices> combinations
159 * Other relevant details...
161 This section is a comment. Do not overwrite or remove it.
162 Also, make sure to start the actual text at the margin.
163 =======================================================