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
  66 Removed Items
  67 -------------
  68
  69 .. This section should contain removed items in this release. Sample format:
  70
  71    * Add a short 1-2 sentence description of the removed item
  72      in the past tense.
  73
  74    This section is a comment. Do not overwrite or remove it.
  75    Also, make sure to start the actual text at the margin.
  76    =========================================================
  77
  78
  79 API Changes
  80 -----------
  81
  82 .. This section should contain API changes. Sample format:
  83
  84    * sample: Add a short 1-2 sentence description of the API change
  85      which was announced in the previous releases and made in this release.
  86      Start with a scope label like "ethdev:".
  87      Use fixed width quotes for ``function_names`` or ``struct_names``.
  88      Use the past tense.
  89
  90    This section is a comment. Do not overwrite or remove it.
  91    Also, make sure to start the actual text at the margin.
  92    =========================================================
  93
  94
  95 ABI Changes
  96 -----------
  97
  98 .. This section should contain ABI changes. Sample format:
  99
 100    * sample: Add a short 1-2 sentence description of the ABI change
 101      which was announced in the previous releases and made in this release.
 102      Start with a scope label like "ethdev:".
 103      Use fixed width quotes for ``function_names`` or ``struct_names``.
 104      Use the past tense.
 105
 106    This section is a comment. Do not overwrite or remove it.
 107    Also, make sure to start the actual text at the margin.
 108    =========================================================
 109
 110 * No ABI change that would break compatibility with DPDK 20.02 and 19.11.
 111
 112
 113 Known Issues
 114 ------------
 115
 116 .. This section should contain new known issues in this release. Sample format:
 117
 118    * **Add title in present tense with full stop.**
 119
 120      Add a short 1-2 sentence description of the known issue
 121      in the present tense. Add information on any known workarounds.
 122
 123    This section is a comment. Do not overwrite or remove it.
 124    Also, make sure to start the actual text at the margin.
 125    =========================================================
 126
 127
 128 Tested Platforms
 129 ----------------
 130
 131 .. This section should contain a list of platforms that were tested
 132    with this release.
 133
 134    The format is:
 135
 136    * <vendor> platform with <vendor> <type of devices> combinations
 137
 138      * List of CPU
 139      * List of OS
 140      * List of devices
 141      * Other relevant details...
 142
 143    This section is a comment. Do not overwrite or remove it.
 144    Also, make sure to start the actual text at the margin.
 145    =========================================================