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/html/guides/rel_notes/release_21_08.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 auxiliary bus support.**
60 Auxiliary bus provides a way to split function into child-devices
61 representing sub-domains of functionality. Each auxiliary device
62 represents a part of its parent functionality.
64 * **Updated Intel iavf driver.**
66 * Added Tx QoS VF queue TC mapping.
68 * **Updated Intel ice driver.**
70 * In AVX2 code, added the new RX and TX paths to use the HW offload
71 features. When the HW offload features are configured to be used, the
72 offload paths are chosen automatically. In parallel the support for HW
73 offload features was removed from the legacy AVX2 paths.
74 * Added Tx QoS TC bandwidth configuration in DCF.
76 * **Added support for Marvell CN10K SoC ethernet device.**
78 * Added net/cnxk driver which provides the support for the integrated ethernet
81 * **Added Baseband PHY CNXK PMD.**
83 Added Baseband PHY PMD which allows to configure BPHY hardware block
84 comprising accelerators and DSPs specifically tailored for 5G/LTE inline
85 usecases. Configuration happens via standard rawdev enq/deq operations. See
86 the :doc:`../rawdevs/cnxk_bphy` rawdev guide for more details on this driver.
92 .. This section should contain removed items in this release. Sample format:
94 * Add a short 1-2 sentence description of the removed item
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 =======================================================
105 .. This section should contain API changes. Sample format:
107 * sample: Add a short 1-2 sentence description of the API 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``.
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 =======================================================
117 * eal: ``rte_strscpy`` sets ``rte_errno`` to ``E2BIG`` in case of string
124 .. This section should contain ABI changes. Sample format:
126 * sample: Add a short 1-2 sentence description of the ABI 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 * No ABI change that would break compatibility with 20.11.
142 .. This section should contain new known issues in this release. Sample format:
144 * **Add title in present tense with full stop.**
146 Add a short 1-2 sentence description of the known issue
147 in the present tense. Add information on any known workarounds.
149 This section is a comment. Do not overwrite or remove it.
150 Also, make sure to start the actual text at the margin.
151 =======================================================
157 .. This section should contain a list of platforms that were tested
162 * <vendor> platform with <vendor> <type of devices> combinations
167 * Other relevant details...
169 This section is a comment. Do not overwrite or remove it.
170 Also, make sure to start the actual text at the margin.
171 =======================================================