doc/guides/rel_notes/release_22_03.rst

   1 .. SPDX-License-Identifier: BSD-3-Clause
   2    Copyright 2021 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 22.03
   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       ninja -C build doc
  21       xdg-open build/doc/guides/html/rel_notes/release_22_03.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 * **Updated Cisco enic driver.**
  59
  60   * Added rte_flow support for matching GENEVE packets.
  61
  62 * **Updated Marvell cnxk crypto PMD.**
  63
  64   * Added SHA256-HMAC support in lookaside protocol (IPsec) for CN10K.
  65   * Added SHA384-HMAC support in lookaside protocol (IPsec) for CN9K & CN10K.
  66   * Added SHA512-HMAC support in lookaside protocol (IPsec) for CN9K & CN10K.
  67   * Added AES-CTR support in lookaside protocol (IPsec) for CN9K & CN10K.
  68   * Added NULL cipher support in lookaside protocol (IPsec) for CN9K & CN10K.
  69   * Added AES-XCBC support in lookaside protocol (IPsec) for CN9K & CN10K.
  70   * Added AES-CMAC support in CN9K & CN10K.
  71
  72 * **Added an API to retrieve event port id of ethdev Rx adapter.**
  73
  74   The new API ``rte_event_eth_rx_adapter_event_port_get()`` was added.
  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 * **Removed experimental performance thread example application.**
  90
  91
  92 API Changes
  93 -----------
  94
  95 .. This section should contain API changes. Sample format:
  96
  97    * sample: Add a short 1-2 sentence description of the API 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 * ethdev: Old public macros and enumeration constants without ``RTE_ETH_`` prefix,
 108   which are kept for backward compatibility, are marked as deprecated.
 109
 110
 111 ABI Changes
 112 -----------
 113
 114 .. This section should contain ABI changes. Sample format:
 115
 116    * sample: Add a short 1-2 sentence description of the ABI change
 117      which was announced in the previous releases and made in this release.
 118      Start with a scope label like "ethdev:".
 119      Use fixed width quotes for ``function_names`` or ``struct_names``.
 120      Use the past tense.
 121
 122    This section is a comment. Do not overwrite or remove it.
 123    Also, make sure to start the actual text at the margin.
 124    =======================================================
 125
 126 * No ABI change that would break compatibility with 21.11.
 127
 128
 129 Known Issues
 130 ------------
 131
 132 .. This section should contain new known issues in this release. Sample format:
 133
 134    * **Add title in present tense with full stop.**
 135
 136      Add a short 1-2 sentence description of the known issue
 137      in the present tense. Add information on any known workarounds.
 138
 139    This section is a comment. Do not overwrite or remove it.
 140    Also, make sure to start the actual text at the margin.
 141    =======================================================
 142
 143
 144 Tested Platforms
 145 ----------------
 146
 147 .. This section should contain a list of platforms that were tested
 148    with this release.
 149
 150    The format is:
 151
 152    * <vendor> platform with <vendor> <type of devices> combinations
 153
 154      * List of CPU
 155      * List of OS
 156      * List of devices
 157      * Other relevant details...
 158
 159    This section is a comment. Do not overwrite or remove it.
 160    Also, make sure to start the actual text at the margin.
 161    =======================================================