xref: /dpdk/doc/guides/rel_notes/release_23_03.rst (revision 3a80d7fb2ecdd6e8e48e56e3726b26980fa2a089)
1.. SPDX-License-Identifier: BSD-3-Clause
2   Copyright 2022 The DPDK contributors
3
4.. include:: <isonum.txt>
5
6DPDK Release 23.03
7==================
8
9.. **Read this first.**
10
11   The text in the sections below explains how to update the release notes.
12
13   Use proper spelling, capitalization and punctuation in all sections.
14
15   Variable and config names should be quoted as fixed width text:
16   ``LIKE_THIS``.
17
18   Build the docs and view the output file to ensure the changes are correct::
19
20      ninja -C build doc
21      xdg-open build/doc/guides/html/rel_notes/release_23_03.html
22
23
24New Features
25------------
26
27.. This section should contain new features added in this release.
28   Sample format:
29
30   * **Add a title in the past tense with a full stop.**
31
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.
35
36     If the feature adds a lot of sub-features you can use a bullet list
37     like this:
38
39     * Added feature foo to do something.
40     * Enhanced feature bar to do something else.
41
42     Refer to the previous release notes for examples.
43
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)
47       - ethdev (lib, PMDs)
48       - cryptodev (lib, PMDs)
49       - eventdev (lib, PMDs)
50       - etc
51     * Other libs
52     * Apps, Examples, Tools (if significant)
53
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     =======================================================
57
58* **Updated Intel QuickAssist Technology (QAT) crypto driver.**
59
60  * Added support for SHA3 224/256/384/512 plain hash in QAT GEN 3.
61  * Added support for SHA3 256 plain hash in QAT GEN 2.
62
63* **Updated the eventdev reconfigure logic for service based adapters.**
64
65  * eventdev reconfig logic is enhanced to increment the
66    ``rte_event_dev_config::nb_single_link_event_port_queues`` parameter
67    if event port config is of type ``RTE_EVENT_PORT_CFG_SINGLE_LINK``.
68  * With this change, the application no longer needs to account for the
69    ``rte_event_dev_config::nb_single_link_event_port_queues`` parameter
70    required for eth_rx, eth_tx, crypto and timer eventdev adapters.
71
72
73Removed Items
74-------------
75
76.. This section should contain removed items in this release. Sample format:
77
78   * Add a short 1-2 sentence description of the removed item
79     in the past tense.
80
81   This section is a comment. Do not overwrite or remove it.
82   Also, make sure to start the actual text at the margin.
83   =======================================================
84
85
86API Changes
87-----------
88
89.. This section should contain API changes. Sample format:
90
91   * sample: Add a short 1-2 sentence description of the API change
92     which was announced in the previous releases and made in this release.
93     Start with a scope label like "ethdev:".
94     Use fixed width quotes for ``function_names`` or ``struct_names``.
95     Use the past tense.
96
97   This section is a comment. Do not overwrite or remove it.
98   Also, make sure to start the actual text at the margin.
99   =======================================================
100
101
102ABI Changes
103-----------
104
105.. This section should contain ABI changes. Sample format:
106
107   * sample: Add a short 1-2 sentence description of the ABI change
108     which was announced in the previous releases and made in this release.
109     Start with a scope label like "ethdev:".
110     Use fixed width quotes for ``function_names`` or ``struct_names``.
111     Use the past tense.
112
113   This section is a comment. Do not overwrite or remove it.
114   Also, make sure to start the actual text at the margin.
115   =======================================================
116
117* No ABI change that would break compatibility with 22.11.
118
119
120Known Issues
121------------
122
123.. This section should contain new known issues in this release. Sample format:
124
125   * **Add title in present tense with full stop.**
126
127     Add a short 1-2 sentence description of the known issue
128     in the present tense. Add information on any known workarounds.
129
130   This section is a comment. Do not overwrite or remove it.
131   Also, make sure to start the actual text at the margin.
132   =======================================================
133
134
135Tested Platforms
136----------------
137
138.. This section should contain a list of platforms that were tested
139   with this release.
140
141   The format is:
142
143   * <vendor> platform with <vendor> <type of devices> combinations
144
145     * List of CPU
146     * List of OS
147     * List of devices
148     * Other relevant details...
149
150   This section is a comment. Do not overwrite or remove it.
151   Also, make sure to start the actual text at the margin.
152   =======================================================
153