doc/guides/rel_notes/release_21_02.rst

   1 .. SPDX-License-Identifier: BSD-3-Clause
   2    Copyright 2020 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 21.02
   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_02.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 * **Added new ethdev API for PMD power management.**
  59
  60   Added ``rte_eth_get_monitor_addr()``, to be used in conjunction with
  61   ``rte_power_monitor()`` to enable automatic power management for PMDs.
  62
  63 * **Updated Broadcom bnxt driver.**
  64
  65   Updated the Broadcom bnxt driver with fixes and improvements, including:
  66
  67   * Added support for Stingray2 device.
  68
  69 * **Updated Mellanox mlx5 driver.**
  70
  71   Updated the Mellanox mlx5 driver with new features and improvements, including:
  72
  73   * Introduced basic support on Windows.
  74
  75 * **Updated GSO support.**
  76
  77   * Added inner UDP/IPv4 support for VXLAN IPv4 GSO.
  78
  79
  80 Removed Items
  81 -------------
  82
  83 .. This section should contain removed items in this release. Sample format:
  84
  85    * Add a short 1-2 sentence description of the removed item
  86      in the past tense.
  87
  88    This section is a comment. Do not overwrite or remove it.
  89    Also, make sure to start the actual text at the margin.
  90    =======================================================
  91
  92 * Removed support for NetXtreme devices belonging to ``BCM573xx and
  93   BCM5740x`` families. Specifically the support for the following Broadcom
  94   PCI device IDs ``0x16c8, 0x16c9, 0x16ca, 0x16ce, 0x16cf, 0x16df, 0x16d0,``
  95   ``0x16d1, 0x16d2, 0x16d4, 0x16d5, 0x16e7, 0x16e8, 0x16e9`` has been removed.
  96
  97 API Changes
  98 -----------
  99
 100 .. This section should contain API changes. Sample format:
 101
 102    * sample: Add a short 1-2 sentence description of the API 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
 113 ABI Changes
 114 -----------
 115
 116 .. This section should contain ABI changes. Sample format:
 117
 118    * sample: Add a short 1-2 sentence description of the ABI change
 119      which was announced in the previous releases and made in this release.
 120      Start with a scope label like "ethdev:".
 121      Use fixed width quotes for ``function_names`` or ``struct_names``.
 122      Use the past tense.
 123
 124    This section is a comment. Do not overwrite or remove it.
 125    Also, make sure to start the actual text at the margin.
 126    =======================================================
 127
 128 * No ABI change that would break compatibility with 20.11.
 129
 130
 131 Known Issues
 132 ------------
 133
 134 .. This section should contain new known issues in this release. Sample format:
 135
 136    * **Add title in present tense with full stop.**
 137
 138      Add a short 1-2 sentence description of the known issue
 139      in the present tense. Add information on any known workarounds.
 140
 141    This section is a comment. Do not overwrite or remove it.
 142    Also, make sure to start the actual text at the margin.
 143    =======================================================
 144
 145
 146 Tested Platforms
 147 ----------------
 148
 149 .. This section should contain a list of platforms that were tested
 150    with this release.
 151
 152    The format is:
 153
 154    * <vendor> platform with <vendor> <type of devices> combinations
 155
 156      * List of CPU
 157      * List of OS
 158      * List of devices
 159      * Other relevant details...
 160
 161    This section is a comment. Do not overwrite or remove it.
 162    Also, make sure to start the actual text at the margin.
 163    =======================================================