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 Wangxun txgbe driver.**
  59
  60   * Added support for txgbevf PMD.
  61
  62 * **Updated testpmd.**
  63
  64   * Added command to display Rx queue used descriptor count.
  65     ``show port (port_id) rxq (queue_id) desc used count``
  66
  67
  68 Removed Items
  69 -------------
  70
  71 .. This section should contain removed items in this release. Sample format:
  72
  73    * Add a short 1-2 sentence description of the removed item
  74      in the past tense.
  75
  76    This section is a comment. Do not overwrite or remove it.
  77    Also, make sure to start the actual text at the margin.
  78    =======================================================
  79
  80
  81 API Changes
  82 -----------
  83
  84 .. This section should contain API changes. Sample format:
  85
  86    * sample: Add a short 1-2 sentence description of the API change
  87      which was announced in the previous releases and made in this release.
  88      Start with a scope label like "ethdev:".
  89      Use fixed width quotes for ``function_names`` or ``struct_names``.
  90      Use the past tense.
  91
  92    This section is a comment. Do not overwrite or remove it.
  93    Also, make sure to start the actual text at the margin.
  94    =======================================================
  95
  96
  97 ABI Changes
  98 -----------
  99
 100 .. This section should contain ABI changes. Sample format:
 101
 102    * sample: Add a short 1-2 sentence description of the ABI change
 103      which was announced in the previous releases and made in this release.
 104      Start with a scope label like "ethdev:".
 105      Use fixed width quotes for ``function_names`` or ``struct_names``.
 106      Use the past tense.
 107
 108    This section is a comment. Do not overwrite or remove it.
 109    Also, make sure to start the actual text at the margin.
 110    =======================================================
 111
 112 * No ABI change that would break compatibility with 20.11.
 113
 114
 115 Known Issues
 116 ------------
 117
 118 .. This section should contain new known issues in this release. Sample format:
 119
 120    * **Add title in present tense with full stop.**
 121
 122      Add a short 1-2 sentence description of the known issue
 123      in the present tense. Add information on any known workarounds.
 124
 125    This section is a comment. Do not overwrite or remove it.
 126    Also, make sure to start the actual text at the margin.
 127    =======================================================
 128
 129
 130 Tested Platforms
 131 ----------------
 132
 133 .. This section should contain a list of platforms that were tested
 134    with this release.
 135
 136    The format is:
 137
 138    * <vendor> platform with <vendor> <type of devices> combinations
 139
 140      * List of CPU
 141      * List of OS
 142      * List of devices
 143      * Other relevant details...
 144
 145    This section is a comment. Do not overwrite or remove it.
 146    Also, make sure to start the actual text at the margin.
 147    =======================================================