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   * Added support for lookaside protocol (IPsec) offload for CN9K.
  71
  72 * **Added support for event crypto adapter on Marvell CN10K and CN9K.**
  73
  74   * Added event crypto adapter OP_FORWARD mode support.
  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 * cryptodev: The API rte_cryptodev_pmd_is_valid_dev is modified to
 106   rte_cryptodev_is_valid_dev as it can be used by the application as
 107   well as PMD to check whether the device is valid or not.
 108
 109 * cryptodev: The rte_cryptodev_pmd.* files are renamed as cryptodev_pmd.*
 110   as it is for drivers only and should be private to DPDK, and not
 111   installed for app use.
 112
 113
 114 ABI Changes
 115 -----------
 116
 117 .. This section should contain ABI changes. Sample format:
 118
 119    * sample: Add a short 1-2 sentence description of the ABI change
 120      which was announced in the previous releases and made in this release.
 121      Start with a scope label like "ethdev:".
 122      Use fixed width quotes for ``function_names`` or ``struct_names``.
 123      Use the past tense.
 124
 125    This section is a comment. Do not overwrite or remove it.
 126    Also, make sure to start the actual text at the margin.
 127    =======================================================
 128
 129
 130 Known Issues
 131 ------------
 132
 133 .. This section should contain new known issues in this release. Sample format:
 134
 135    * **Add title in present tense with full stop.**
 136
 137      Add a short 1-2 sentence description of the known issue
 138      in the present tense. Add information on any known workarounds.
 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    =======================================================
 143
 144
 145 Tested Platforms
 146 ----------------
 147
 148 .. This section should contain a list of platforms that were tested
 149    with this release.
 150
 151    The format is:
 152
 153    * <vendor> platform with <vendor> <type of devices> combinations
 154
 155      * List of CPU
 156      * List of OS
 157      * List of devices
 158      * Other relevant details...
 159
 160    This section is a comment. Do not overwrite or remove it.
 161    Also, make sure to start the actual text at the margin.
 162    =======================================================