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 Baseband PHY CNXK PMD.**
  65
  66   Added Baseband PHY PMD which allows to configure BPHY hardware block
  67   comprising accelerators and DSPs specifically tailored for 5G/LTE inline
  68   usecases. Configuration happens via standard rawdev enq/deq operations. See
  69   the :doc:`../rawdevs/cnxk_bphy` rawdev guide for more details on this driver.
  70
  71
  72 Removed Items
  73 -------------
  74
  75 .. This section should contain removed items in this release. Sample format:
  76
  77    * Add a short 1-2 sentence description of the removed item
  78      in the past tense.
  79
  80    This section is a comment. Do not overwrite or remove it.
  81    Also, make sure to start the actual text at the margin.
  82    =======================================================
  83
  84
  85 API Changes
  86 -----------
  87
  88 .. This section should contain API changes. Sample format:
  89
  90    * sample: Add a short 1-2 sentence description of the API change
  91      which was announced in the previous releases and made in this release.
  92      Start with a scope label like "ethdev:".
  93      Use fixed width quotes for ``function_names`` or ``struct_names``.
  94      Use the past tense.
  95
  96    This section is a comment. Do not overwrite or remove it.
  97    Also, make sure to start the actual text at the margin.
  98    =======================================================
  99
 100 * eal: ``rte_strscpy`` sets ``rte_errno`` to ``E2BIG`` in case of string
 101   truncation.
 102
 103
 104 ABI Changes
 105 -----------
 106
 107 .. This section should contain ABI changes. Sample format:
 108
 109    * sample: Add a short 1-2 sentence description of the ABI change
 110      which was announced in the previous releases and made in this release.
 111      Start with a scope label like "ethdev:".
 112      Use fixed width quotes for ``function_names`` or ``struct_names``.
 113      Use the past tense.
 114
 115    This section is a comment. Do not overwrite or remove it.
 116    Also, make sure to start the actual text at the margin.
 117    =======================================================
 118
 119 * No ABI change that would break compatibility with 20.11.
 120
 121
 122 Known Issues
 123 ------------
 124
 125 .. This section should contain new known issues in this release. Sample format:
 126
 127    * **Add title in present tense with full stop.**
 128
 129      Add a short 1-2 sentence description of the known issue
 130      in the present tense. Add information on any known workarounds.
 131
 132    This section is a comment. Do not overwrite or remove it.
 133    Also, make sure to start the actual text at the margin.
 134    =======================================================
 135
 136
 137 Tested Platforms
 138 ----------------
 139
 140 .. This section should contain a list of platforms that were tested
 141    with this release.
 142
 143    The format is:
 144
 145    * <vendor> platform with <vendor> <type of devices> combinations
 146
 147      * List of CPU
 148      * List of OS
 149      * List of devices
 150      * Other relevant details...
 151
 152    This section is a comment. Do not overwrite or remove it.
 153    Also, make sure to start the actual text at the margin.
 154    =======================================================