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