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