doc/guides/rel_notes/release_22_07.rst

   1 .. SPDX-License-Identifier: BSD-3-Clause
   2    Copyright 2022 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 22.07
   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_07.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 vhost API to get the number of in-flight packets.**
  59
  60   Added an API which can get the number of in-flight packets in
  61   vhost async data path without using lock.
  62
  63 * **Updated Intel iavf driver.**
  64
  65   * Added Tx QoS queue rate limitation support.
  66   * Added quanta size configuration support.
  67
  68 * **Updated Mellanox mlx5 driver.**
  69
  70   * Added support for promiscuous mode on Windows.
  71   * Added support for MTU on Windows.
  72
  73 * **Updated Marvell cnxk crypto driver.**
  74
  75   * Added AH mode support in lookaside protocol (IPsec) for CN9K & CN10K.
  76   * Added AES-GMAC support in lookaside protocol (IPsec) for CN9K & CN10K.
  77
  78
  79 Removed Items
  80 -------------
  81
  82 .. This section should contain removed items in this release. Sample format:
  83
  84    * Add a short 1-2 sentence description of the removed item
  85      in the past tense.
  86
  87    This section is a comment. Do not overwrite or remove it.
  88    Also, make sure to start the actual text at the margin.
  89    =======================================================
  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
 108 ABI Changes
 109 -----------
 110
 111 .. This section should contain ABI changes. Sample format:
 112
 113    * sample: Add a short 1-2 sentence description of the ABI change
 114      which was announced in the previous releases and made in this release.
 115      Start with a scope label like "ethdev:".
 116      Use fixed width quotes for ``function_names`` or ``struct_names``.
 117      Use the past tense.
 118
 119    This section is a comment. Do not overwrite or remove it.
 120    Also, make sure to start the actual text at the margin.
 121    =======================================================
 122
 123 * No ABI change that would break compatibility with 21.11.
 124
 125
 126 Known Issues
 127 ------------
 128
 129 .. This section should contain new known issues in this release. Sample format:
 130
 131    * **Add title in present tense with full stop.**
 132
 133      Add a short 1-2 sentence description of the known issue
 134      in the present tense. Add information on any known workarounds.
 135
 136    This section is a comment. Do not overwrite or remove it.
 137    Also, make sure to start the actual text at the margin.
 138    =======================================================
 139
 140
 141 Tested Platforms
 142 ----------------
 143
 144 .. This section should contain a list of platforms that were tested
 145    with this release.
 146
 147    The format is:
 148
 149    * <vendor> platform with <vendor> <type of devices> combinations
 150
 151      * List of CPU
 152      * List of OS
 153      * List of devices
 154      * Other relevant details...
 155
 156    This section is a comment. Do not overwrite or remove it.
 157    Also, make sure to start the actual text at the margin.
 158    =======================================================