doc/guides/rel_notes/release_20_08.rst

   1 .. SPDX-License-Identifier: BSD-3-Clause
   2    Copyright 2020 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 20.08
   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_08.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 new PMD devarg ``reclaim_mem_mode``.
  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 * ``rte_page_sizes`` enumeration is replaced with ``RTE_PGSIZE_xxx`` defines.
  95
  96
  97 ABI Changes
  98 -----------
  99
 100 .. This section should contain ABI changes. Sample format:
 101
 102    * sample: Add a short 1-2 sentence description of the ABI change
 103      which was announced in the previous releases and made in this release.
 104      Start with a scope label like "ethdev:".
 105      Use fixed width quotes for ``function_names`` or ``struct_names``.
 106      Use the past tense.
 107
 108    This section is a comment. Do not overwrite or remove it.
 109    Also, make sure to start the actual text at the margin.
 110    =========================================================
 111
 112 * No ABI change that would break compatibility with 19.11.
 113
 114
 115 Known Issues
 116 ------------
 117
 118 .. This section should contain new known issues in this release. Sample format:
 119
 120    * **Add title in present tense with full stop.**
 121
 122      Add a short 1-2 sentence description of the known issue
 123      in the present tense. Add information on any known workarounds.
 124
 125    This section is a comment. Do not overwrite or remove it.
 126    Also, make sure to start the actual text at the margin.
 127    =========================================================
 128
 129
 130 Tested Platforms
 131 ----------------
 132
 133 .. This section should contain a list of platforms that were tested
 134    with this release.
 135
 136    The format is:
 137
 138    * <vendor> platform with <vendor> <type of devices> combinations
 139
 140      * List of CPU
 141      * List of OS
 142      * List of devices
 143      * Other relevant details...
 144
 145    This section is a comment. Do not overwrite or remove it.
 146    Also, make sure to start the actual text at the margin.
 147    =========================================================