doc/guides/rel_notes/release_21_05.rst

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