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 * **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 testpmd.**
  80
  81   * Added a command line option to configure forced speed for Ethernet port.
  82     ``dpdk-testpmd -- --eth-link-speed N``
  83   * Added command to display Rx queue used descriptor count.
  84     ``show port (port_id) rxq (queue_id) desc used count``
  85
  86
  87 Removed Items
  88 -------------
  89
  90 .. This section should contain removed items in this release. Sample format:
  91
  92    * Add a short 1-2 sentence description of the removed item
  93      in the past tense.
  94
  95    This section is a comment. Do not overwrite or remove it.
  96    Also, make sure to start the actual text at the margin.
  97    =======================================================
  98
  99
 100 API Changes
 101 -----------
 102
 103 .. This section should contain API changes. Sample format:
 104
 105    * sample: Add a short 1-2 sentence description of the API change
 106      which was announced in the previous releases and made in this release.
 107      Start with a scope label like "ethdev:".
 108      Use fixed width quotes for ``function_names`` or ``struct_names``.
 109      Use the past tense.
 110
 111    This section is a comment. Do not overwrite or remove it.
 112    Also, make sure to start the actual text at the margin.
 113    =======================================================
 114
 115
 116 ABI Changes
 117 -----------
 118
 119 .. This section should contain ABI changes. Sample format:
 120
 121    * sample: Add a short 1-2 sentence description of the ABI change
 122      which was announced in the previous releases and made in this release.
 123      Start with a scope label like "ethdev:".
 124      Use fixed width quotes for ``function_names`` or ``struct_names``.
 125      Use the past tense.
 126
 127    This section is a comment. Do not overwrite or remove it.
 128    Also, make sure to start the actual text at the margin.
 129    =======================================================
 130
 131 * No ABI change that would break compatibility with 20.11.
 132
 133
 134 Known Issues
 135 ------------
 136
 137 .. This section should contain new known issues in this release. Sample format:
 138
 139    * **Add title in present tense with full stop.**
 140
 141      Add a short 1-2 sentence description of the known issue
 142      in the present tense. Add information on any known workarounds.
 143
 144    This section is a comment. Do not overwrite or remove it.
 145    Also, make sure to start the actual text at the margin.
 146    =======================================================
 147
 148
 149 Tested Platforms
 150 ----------------
 151
 152 .. This section should contain a list of platforms that were tested
 153    with this release.
 154
 155    The format is:
 156
 157    * <vendor> platform with <vendor> <type of devices> combinations
 158
 159      * List of CPU
 160      * List of OS
 161      * List of devices
 162      * Other relevant details...
 163
 164    This section is a comment. Do not overwrite or remove it.
 165    Also, make sure to start the actual text at the margin.
 166    =======================================================