1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright 2021 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_03.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 * **Updated Marvell cnxk crypto PMD.**
60 * Added SHA256-HMAC support in lookaside protocol (IPsec) for CN10K.
62 * **Added an API to retrieve event port id of ethdev Rx adapter.**
64 The new API ``rte_event_eth_rx_adapter_event_port_get()`` was added.
70 .. This section should contain removed items in this release. Sample format:
72 * Add a short 1-2 sentence description of the removed item
75 This section is a comment. Do not overwrite or remove it.
76 Also, make sure to start the actual text at the margin.
77 =======================================================
79 * **Removed experimental performance thread example application.**
85 .. This section should contain API changes. Sample format:
87 * sample: Add a short 1-2 sentence description of the API change
88 which was announced in the previous releases and made in this release.
89 Start with a scope label like "ethdev:".
90 Use fixed width quotes for ``function_names`` or ``struct_names``.
93 This section is a comment. Do not overwrite or remove it.
94 Also, make sure to start the actual text at the margin.
95 =======================================================
101 .. This section should contain ABI changes. Sample format:
103 * sample: Add a short 1-2 sentence description of the ABI change
104 which was announced in the previous releases and made in this release.
105 Start with a scope label like "ethdev:".
106 Use fixed width quotes for ``function_names`` or ``struct_names``.
109 This section is a comment. Do not overwrite or remove it.
110 Also, make sure to start the actual text at the margin.
111 =======================================================
113 * No ABI change that would break compatibility with 21.11.
119 .. This section should contain new known issues in this release. Sample format:
121 * **Add title in present tense with full stop.**
123 Add a short 1-2 sentence description of the known issue
124 in the present tense. Add information on any known workarounds.
126 This section is a comment. Do not overwrite or remove it.
127 Also, make sure to start the actual text at the margin.
128 =======================================================
134 .. This section should contain a list of platforms that were tested
139 * <vendor> platform with <vendor> <type of devices> combinations
144 * Other relevant details...
146 This section is a comment. Do not overwrite or remove it.
147 Also, make sure to start the actual text at the margin.
148 =======================================================