doc/guides/rel_notes/release_20_05.rst

   1 .. SPDX-License-Identifier: BSD-3-Clause
   2    Copyright 2020 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 20.05
   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
  22       xdg-open build/doc/html/guides/rel_notes/release_20_05.html
  23
  24
  25 New Features
  26 ------------
  27
  28 .. This section should contain new features added in this release.
  29    Sample format:
  30
  31    * **Add a title in the past tense with a full stop.**
  32
  33      Add a short 1-2 sentence description in the past tense.
  34      The description should be enough to allow someone scanning
  35      the release notes to understand the new feature.
  36
  37      If the feature adds a lot of sub-features you can use a bullet list
  38      like this:
  39
  40      * Added feature foo to do something.
  41      * Enhanced feature bar to do something else.
  42
  43      Refer to the previous release notes for examples.
  44
  45      Suggested order in release notes items:
  46      * Core libs (EAL, mempool, ring, mbuf, buses)
  47      * Device abstraction libs and PMDs
  48        - ethdev (lib, PMDs)
  49        - cryptodev (lib, PMDs)
  50        - eventdev (lib, PMDs)
  51        - etc
  52      * Other libs
  53      * Apps, Examples, Tools (if significant)
  54
  55      This section is a comment. Do not overwrite or remove it.
  56      Also, make sure to start the actual text at the margin.
  57      =========================================================
  58
  59 * **Updated Mellanox mlx5 driver.**
  60
  61   Updated Mellanox mlx5 driver with new features and improvements, including:
  62
  63   * Added support for matching on IPv4 Time To Live and IPv6 Hop Limit.
  64
  65 * **Updated the turbo_sw bbdev PMD.**
  66
  67   Supported large size code blocks which does not fit in one mbuf segment.
  68
  69 * **Added event mode to ipsec-secgw application.**
  70
  71   Updated ipsec-secgw application to add event based packet processing. The worker
  72   thread(s) would receive events and submit them back to the event device after
  73   the processing. This way, multicore scaling and HW assisted scheduling is achieved
  74   by making use of the event device capabilities. The event mode currently supports
  75   only inline IPsec protocol offload.
  76
  77
  78 Removed Items
  79 -------------
  80
  81 .. This section should contain removed items in this release. Sample format:
  82
  83    * Add a short 1-2 sentence description of the removed item
  84      in the past tense.
  85
  86    This section is a comment. Do not overwrite or remove it.
  87    Also, make sure to start the actual text at the margin.
  88    =========================================================
  89
  90
  91 API Changes
  92 -----------
  93
  94 .. This section should contain API changes. Sample format:
  95
  96    * sample: Add a short 1-2 sentence description of the API change
  97      which was announced in the previous releases and made in this release.
  98      Start with a scope label like "ethdev:".
  99      Use fixed width quotes for ``function_names`` or ``struct_names``.
 100      Use the past tense.
 101
 102    This section is a comment. Do not overwrite or remove it.
 103    Also, make sure to start the actual text at the margin.
 104    =========================================================
 105
 106
 107 ABI Changes
 108 -----------
 109
 110 .. This section should contain ABI changes. Sample format:
 111
 112    * sample: Add a short 1-2 sentence description of the ABI change
 113      which was announced in the previous releases and made in this release.
 114      Start with a scope label like "ethdev:".
 115      Use fixed width quotes for ``function_names`` or ``struct_names``.
 116      Use the past tense.
 117
 118    This section is a comment. Do not overwrite or remove it.
 119    Also, make sure to start the actual text at the margin.
 120    =========================================================
 121
 122 * No ABI change that would break compatibility with DPDK 20.02 and 19.11.
 123
 124
 125 Known Issues
 126 ------------
 127
 128 .. This section should contain new known issues in this release. Sample format:
 129
 130    * **Add title in present tense with full stop.**
 131
 132      Add a short 1-2 sentence description of the known issue
 133      in the present tense. Add information on any known workarounds.
 134
 135    This section is a comment. Do not overwrite or remove it.
 136    Also, make sure to start the actual text at the margin.
 137    =========================================================
 138
 139
 140 Tested Platforms
 141 ----------------
 142
 143 .. This section should contain a list of platforms that were tested
 144    with this release.
 145
 146    The format is:
 147
 148    * <vendor> platform with <vendor> <type of devices> combinations
 149
 150      * List of CPU
 151      * List of OS
 152      * List of devices
 153      * Other relevant details...
 154
 155    This section is a comment. Do not overwrite or remove it.
 156    Also, make sure to start the actual text at the margin.
 157    =========================================================