doc/guides/rel_notes/release_21_11.rst

   1 .. SPDX-License-Identifier: BSD-3-Clause
   2    Copyright 2021 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 21.11
   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_11.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 * **Enabled new devargs parser.**
  59
  60   * Enabled devargs syntax
  61     ``bus=X,paramX=x/class=Y,paramY=y/driver=Z,paramZ=z``
  62   * Added bus-level parsing of the devargs syntax.
  63   * Kept compatibility with the legacy syntax as parsing fallback.
  64
  65 * **Updated Marvell cnxk crypto PMD.**
  66
  67   * Added AES-CBC SHA1-HMAC support in lookaside protocol (IPsec) for CN10K.
  68   * Added Transport mode support in lookaside protocol (IPsec) for CN10K.
  69   * Added UDP encapsulation support in lookaside protocol (IPsec) for CN10K.
  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
 101 ABI Changes
 102 -----------
 103
 104 .. This section should contain ABI changes. Sample format:
 105
 106    * sample: Add a short 1-2 sentence description of the ABI change
 107      which was announced in the previous releases and made in this release.
 108      Start with a scope label like "ethdev:".
 109      Use fixed width quotes for ``function_names`` or ``struct_names``.
 110      Use the past tense.
 111
 112    This section is a comment. Do not overwrite or remove it.
 113    Also, make sure to start the actual text at the margin.
 114    =======================================================
 115
 116
 117 Known Issues
 118 ------------
 119
 120 .. This section should contain new known issues in this release. Sample format:
 121
 122    * **Add title in present tense with full stop.**
 123
 124      Add a short 1-2 sentence description of the known issue
 125      in the present tense. Add information on any known workarounds.
 126
 127    This section is a comment. Do not overwrite or remove it.
 128    Also, make sure to start the actual text at the margin.
 129    =======================================================
 130
 131
 132 Tested Platforms
 133 ----------------
 134
 135 .. This section should contain a list of platforms that were tested
 136    with this release.
 137
 138    The format is:
 139
 140    * <vendor> platform with <vendor> <type of devices> combinations
 141
 142      * List of CPU
 143      * List of OS
 144      * List of devices
 145      * Other relevant details...
 146
 147    This section is a comment. Do not overwrite or remove it.
 148    Also, make sure to start the actual text at the margin.
 149    =======================================================