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 * **Updated Broadcom bnxt driver.**
  59
  60   Updated the Broadcom bnxt driver with fixes and improvements, including:
  61
  62   * Added support for Stingray2 device.
  63
  64
  65 Removed Items
  66 -------------
  67
  68 .. This section should contain removed items in this release. Sample format:
  69
  70    * Add a short 1-2 sentence description of the removed item
  71      in the past tense.
  72
  73    This section is a comment. Do not overwrite or remove it.
  74    Also, make sure to start the actual text at the margin.
  75    =======================================================
  76
  77 * Removed support for NetXtreme devices belonging to ``BCM573xx and
  78   BCM5740x`` families. Specifically the support for the following Broadcom
  79   PCI device IDs ``0x16c8, 0x16c9, 0x16ca, 0x16ce, 0x16cf, 0x16df, 0x16d0,``
  80   ``0x16d1, 0x16d2, 0x16d4, 0x16d5, 0x16e7, 0x16e8, 0x16e9`` has been removed.
  81
  82 API Changes
  83 -----------
  84
  85 .. This section should contain API changes. Sample format:
  86
  87    * sample: Add a short 1-2 sentence description of the API change
  88      which was announced in the previous releases and made in this release.
  89      Start with a scope label like "ethdev:".
  90      Use fixed width quotes for ``function_names`` or ``struct_names``.
  91      Use the past tense.
  92
  93    This section is a comment. Do not overwrite or remove it.
  94    Also, make sure to start the actual text at the margin.
  95    =======================================================
  96
  97
  98 ABI Changes
  99 -----------
 100
 101 .. This section should contain ABI changes. Sample format:
 102
 103    * sample: Add a short 1-2 sentence description of the ABI change
 104      which was announced in the previous releases and made in this release.
 105      Start with a scope label like "ethdev:".
 106      Use fixed width quotes for ``function_names`` or ``struct_names``.
 107      Use the past tense.
 108
 109    This section is a comment. Do not overwrite or remove it.
 110    Also, make sure to start the actual text at the margin.
 111    =======================================================
 112
 113 * No ABI change that would break compatibility with 20.11.
 114
 115
 116 Known Issues
 117 ------------
 118
 119 .. This section should contain new known issues in this release. Sample format:
 120
 121    * **Add title in present tense with full stop.**
 122
 123      Add a short 1-2 sentence description of the known issue
 124      in the present tense. Add information on any known workarounds.
 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 Tested Platforms
 132 ----------------
 133
 134 .. This section should contain a list of platforms that were tested
 135    with this release.
 136
 137    The format is:
 138
 139    * <vendor> platform with <vendor> <type of devices> combinations
 140
 141      * List of CPU
 142      * List of OS
 143      * List of devices
 144      * Other relevant details...
 145
 146    This section is a comment. Do not overwrite or remove it.
 147    Also, make sure to start the actual text at the margin.
 148    =======================================================