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 * **Added ability to reuse hugepages in Linux.**
  59
  60   It is possible to reuse files in hugetlbfs to speed up hugepage mapping,
  61   which may be useful for fast restart and large allocations.
  62   The new mode is activated with ``--huge-unlink=never``
  63   and has security implications, refer to the user and programmer guides.
  64
  65 * **Updated Cisco enic driver.**
  66
  67   * Added rte_flow support for matching GENEVE packets.
  68
  69 * **Updated Marvell cnxk crypto PMD.**
  70
  71   * Added SHA256-HMAC support in lookaside protocol (IPsec) for CN10K.
  72   * Added SHA384-HMAC support in lookaside protocol (IPsec) for CN9K & CN10K.
  73   * Added SHA512-HMAC support in lookaside protocol (IPsec) for CN9K & CN10K.
  74   * Added AES-CTR support in lookaside protocol (IPsec) for CN9K & CN10K.
  75   * Added NULL cipher support in lookaside protocol (IPsec) for CN9K & CN10K.
  76   * Added AES-XCBC support in lookaside protocol (IPsec) for CN9K & CN10K.
  77   * Added AES-CMAC support in CN9K & CN10K.
  78
  79 * **Added an API to retrieve event port id of ethdev Rx adapter.**
  80
  81   The new API ``rte_event_eth_rx_adapter_event_port_get()`` was added.
  82
  83
  84 Removed Items
  85 -------------
  86
  87 .. This section should contain removed items in this release. Sample format:
  88
  89    * Add a short 1-2 sentence description of the removed item
  90      in the past tense.
  91
  92    This section is a comment. Do not overwrite or remove it.
  93    Also, make sure to start the actual text at the margin.
  94    =======================================================
  95
  96 * **Removed experimental performance thread example application.**
  97
  98
  99 API Changes
 100 -----------
 101
 102 .. This section should contain API changes. Sample format:
 103
 104    * sample: Add a short 1-2 sentence description of the API change
 105      which was announced in the previous releases and made in this release.
 106      Start with a scope label like "ethdev:".
 107      Use fixed width quotes for ``function_names`` or ``struct_names``.
 108      Use the past tense.
 109
 110    This section is a comment. Do not overwrite or remove it.
 111    Also, make sure to start the actual text at the margin.
 112    =======================================================
 113
 114 * ethdev: Old public macros and enumeration constants without ``RTE_ETH_`` prefix,
 115   which are kept for backward compatibility, are marked as deprecated.
 116
 117
 118 ABI Changes
 119 -----------
 120
 121 .. This section should contain ABI changes. Sample format:
 122
 123    * sample: Add a short 1-2 sentence description of the ABI change
 124      which was announced in the previous releases and made in this release.
 125      Start with a scope label like "ethdev:".
 126      Use fixed width quotes for ``function_names`` or ``struct_names``.
 127      Use the past tense.
 128
 129    This section is a comment. Do not overwrite or remove it.
 130    Also, make sure to start the actual text at the margin.
 131    =======================================================
 132
 133 * No ABI change that would break compatibility with 21.11.
 134
 135
 136 Known Issues
 137 ------------
 138
 139 .. This section should contain new known issues in this release. Sample format:
 140
 141    * **Add title in present tense with full stop.**
 142
 143      Add a short 1-2 sentence description of the known issue
 144      in the present tense. Add information on any known workarounds.
 145
 146    This section is a comment. Do not overwrite or remove it.
 147    Also, make sure to start the actual text at the margin.
 148    =======================================================
 149
 150
 151 Tested Platforms
 152 ----------------
 153
 154 .. This section should contain a list of platforms that were tested
 155    with this release.
 156
 157    The format is:
 158
 159    * <vendor> platform with <vendor> <type of devices> combinations
 160
 161      * List of CPU
 162      * List of OS
 163      * List of devices
 164      * Other relevant details...
 165
 166    This section is a comment. Do not overwrite or remove it.
 167    Also, make sure to start the actual text at the margin.
 168    =======================================================