doc/guides/rel_notes/release_21_08.rst

   1 .. SPDX-License-Identifier: BSD-3-Clause
   2    Copyright 2021 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 21.08
   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_08.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 (ordered alphabetically by vendor name)
  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 auxiliary bus support.**
  59
  60   Auxiliary bus provides a way to split function into child-devices
  61   representing sub-domains of functionality. Each auxiliary device
  62   represents a part of its parent functionality.
  63
  64 * **Added support for Marvell CN10K SoC ethernet device.**
  65
  66   * Added net/cnxk driver which provides the support for the integrated ethernet
  67     device.
  68
  69 * **Added Baseband PHY CNXK PMD.**
  70
  71   Added Baseband PHY PMD which allows to configure BPHY hardware block
  72   comprising accelerators and DSPs specifically tailored for 5G/LTE inline
  73   usecases. Configuration happens via standard rawdev enq/deq operations. See
  74   the :doc:`../rawdevs/cnxk_bphy` rawdev guide for more details on this driver.
  75
  76
  77 Removed Items
  78 -------------
  79
  80 .. This section should contain removed items in this release. Sample format:
  81
  82    * Add a short 1-2 sentence description of the removed item
  83      in the past tense.
  84
  85    This section is a comment. Do not overwrite or remove it.
  86    Also, make sure to start the actual text at the margin.
  87    =======================================================
  88
  89
  90 API Changes
  91 -----------
  92
  93 .. This section should contain API changes. Sample format:
  94
  95    * sample: Add a short 1-2 sentence description of the API change
  96      which was announced in the previous releases and made in this release.
  97      Start with a scope label like "ethdev:".
  98      Use fixed width quotes for ``function_names`` or ``struct_names``.
  99      Use the past tense.
 100
 101    This section is a comment. Do not overwrite or remove it.
 102    Also, make sure to start the actual text at the margin.
 103    =======================================================
 104
 105 * eal: ``rte_strscpy`` sets ``rte_errno`` to ``E2BIG`` in case of string
 106   truncation.
 107
 108
 109 ABI Changes
 110 -----------
 111
 112 .. This section should contain ABI changes. Sample format:
 113
 114    * sample: Add a short 1-2 sentence description of the ABI change
 115      which was announced in the previous releases and made in this release.
 116      Start with a scope label like "ethdev:".
 117      Use fixed width quotes for ``function_names`` or ``struct_names``.
 118      Use the past tense.
 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 * No ABI change that would break compatibility with 20.11.
 125
 126
 127 Known Issues
 128 ------------
 129
 130 .. This section should contain new known issues in this release. Sample format:
 131
 132    * **Add title in present tense with full stop.**
 133
 134      Add a short 1-2 sentence description of the known issue
 135      in the present tense. Add information on any known workarounds.
 136
 137    This section is a comment. Do not overwrite or remove it.
 138    Also, make sure to start the actual text at the margin.
 139    =======================================================
 140
 141
 142 Tested Platforms
 143 ----------------
 144
 145 .. This section should contain a list of platforms that were tested
 146    with this release.
 147
 148    The format is:
 149
 150    * <vendor> platform with <vendor> <type of devices> combinations
 151
 152      * List of CPU
 153      * List of OS
 154      * List of devices
 155      * Other relevant details...
 156
 157    This section is a comment. Do not overwrite or remove it.
 158    Also, make sure to start the actual text at the margin.
 159    =======================================================