1.. SPDX-License-Identifier: BSD-3-Clause 2 Copyright 2021 The DPDK contributors 3 4.. include:: <isonum.txt> 5 6DPDK Release 21.05 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 make doc-guides-html 21 xdg-open build/doc/html/guides/rel_notes/release_21_05.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 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 Hisilicon hns3 driver.** 59 60 * Added support for module EEPROM dumping. 61 * Added support for freeing Tx mbuf on demand. 62 * Added support for copper port in Kunpeng930. 63 64* **Updated NXP DPAA driver.** 65 66 * Added support for shared ethernet interface. 67 * Added support for external buffers in Tx. 68 69* **Updated NXP DPAA2 driver.** 70 71 * Added support for traffic management. 72 * Added support for configurable Tx confirmation. 73 * Added support for external buffers in Tx. 74 75* **Updated Wangxun txgbe driver.** 76 77 * Added support for txgbevf PMD. 78 79* **Updated the AF_XDP driver.** 80 81 * Added support for preferred busy polling. 82 83* **Updated testpmd.** 84 85 * Added a command line option to configure forced speed for Ethernet port. 86 ``dpdk-testpmd -- --eth-link-speed N`` 87 * Added command to display Rx queue used descriptor count. 88 ``show port (port_id) rxq (queue_id) desc used count`` 89 90 91Removed Items 92------------- 93 94.. This section should contain removed items in this release. Sample format: 95 96 * Add a short 1-2 sentence description of the removed item 97 in the past tense. 98 99 This section is a comment. Do not overwrite or remove it. 100 Also, make sure to start the actual text at the margin. 101 ======================================================= 102 103 104API Changes 105----------- 106 107.. This section should contain API changes. Sample format: 108 109 * sample: Add a short 1-2 sentence description of the API change 110 which was announced in the previous releases and made in this release. 111 Start with a scope label like "ethdev:". 112 Use fixed width quotes for ``function_names`` or ``struct_names``. 113 Use the past tense. 114 115 This section is a comment. Do not overwrite or remove it. 116 Also, make sure to start the actual text at the margin. 117 ======================================================= 118 119 120ABI Changes 121----------- 122 123.. This section should contain ABI changes. Sample format: 124 125 * sample: Add a short 1-2 sentence description of the ABI change 126 which was announced in the previous releases and made in this release. 127 Start with a scope label like "ethdev:". 128 Use fixed width quotes for ``function_names`` or ``struct_names``. 129 Use the past tense. 130 131 This section is a comment. Do not overwrite or remove it. 132 Also, make sure to start the actual text at the margin. 133 ======================================================= 134 135* No ABI change that would break compatibility with 20.11. 136 137 138Known Issues 139------------ 140 141.. This section should contain new known issues in this release. Sample format: 142 143 * **Add title in present tense with full stop.** 144 145 Add a short 1-2 sentence description of the known issue 146 in the present tense. Add information on any known workarounds. 147 148 This section is a comment. Do not overwrite or remove it. 149 Also, make sure to start the actual text at the margin. 150 ======================================================= 151 152 153Tested Platforms 154---------------- 155 156.. This section should contain a list of platforms that were tested 157 with this release. 158 159 The format is: 160 161 * <vendor> platform with <vendor> <type of devices> combinations 162 163 * List of CPU 164 * List of OS 165 * List of devices 166 * Other relevant details... 167 168 This section is a comment. Do not overwrite or remove it. 169 Also, make sure to start the actual text at the margin. 170 ======================================================= 171