1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright 2020 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_02.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
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 new ethdev API for PMD power management.**
60 Added ``rte_eth_get_monitor_addr()``, to be used in conjunction with
61 ``rte_power_monitor()`` to enable automatic power management for PMDs.
63 * **Updated Broadcom bnxt driver.**
65 Updated the Broadcom bnxt driver with fixes and improvements, including:
67 * Added support for Stingray2 device.
69 * **Updated Mellanox mlx5 driver.**
71 Updated the Mellanox mlx5 driver with new features and improvements, including:
73 * Introduced basic support on Windows.
75 * **Updated GSO support.**
77 * Added inner UDP/IPv4 support for VXLAN IPv4 GSO.
79 * **Updated the OCTEON TX2 crypto PMD.**
81 * Updated the OCTEON TX2 crypto PMD lookaside protocol offload for IPsec with
82 ESN and anti-replay support.
83 * Updated the OCTEON TX2 crypto PMD with CN98xx support.
84 * Added support for aes-cbc sha1-hmac cipher combination in OCTEON TX2 crypto
85 PMD lookaside protocol offload for IPsec.
91 .. This section should contain removed items in this release. Sample format:
93 * Add a short 1-2 sentence description of the removed item
96 This section is a comment. Do not overwrite or remove it.
97 Also, make sure to start the actual text at the margin.
98 =======================================================
100 * Removed support for NetXtreme devices belonging to ``BCM573xx and
101 BCM5740x`` families. Specifically the support for the following Broadcom
102 PCI device IDs ``0x16c8, 0x16c9, 0x16ca, 0x16ce, 0x16cf, 0x16df, 0x16d0,``
103 ``0x16d1, 0x16d2, 0x16d4, 0x16d5, 0x16e7, 0x16e8, 0x16e9`` has been removed.
108 .. This section should contain API changes. Sample format:
110 * sample: Add a short 1-2 sentence description of the API change
111 which was announced in the previous releases and made in this release.
112 Start with a scope label like "ethdev:".
113 Use fixed width quotes for ``function_names`` or ``struct_names``.
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 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 =======================================================