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 PCAP driver.**
  60
  61   Updated PCAP driver with new features and improvements, including:
  62
  63   * Support software Tx nanosecond timestamps precision.
  64
  65 * **Updated Mellanox mlx5 driver.**
  66
  67   Updated Mellanox mlx5 driver with new features and improvements, including:
  68
  69   * Added new PMD devarg ``reclaim_mem_mode``.
  70
  71 * **Added support for BPF_ABS/BPF_IND load instructions.**
  72
  73   Added support for two BPF non-generic instructions:
  74   ``(BPF_ABS | <size> | BPF_LD)`` and ``(BPF_IND | <size> | BPF_LD)``
  75   which are used to access packet data in a safe manner. Currently JIT support
  76   for these instructions is implemented for x86 only.
  77
  78 * **Added flow performance test application.**
  79
  80   Added new application to test ``rte_flow`` performance, including:
  81
  82   * Measure ``rte_flow`` insertion rate.
  83   * Measure ``rte_flow`` deletion rate.
  84
  85
  86 Removed Items
  87 -------------
  88
  89 .. This section should contain removed items in this release. Sample format:
  90
  91    * Add a short 1-2 sentence description of the removed item
  92      in the past tense.
  93
  94    This section is a comment. Do not overwrite or remove it.
  95    Also, make sure to start the actual text at the margin.
  96    =========================================================
  97
  98 * Removed ``RTE_KDRV_NONE`` based PCI device driver probing.
  99
 100
 101 API Changes
 102 -----------
 103
 104 .. This section should contain API changes. Sample format:
 105
 106    * sample: Add a short 1-2 sentence description of the API change
 107      which was announced in the previous releases and made in this release.
 108      Start with a scope label like "ethdev:".
 109      Use fixed width quotes for ``function_names`` or ``struct_names``.
 110      Use the past tense.
 111
 112    This section is a comment. Do not overwrite or remove it.
 113    Also, make sure to start the actual text at the margin.
 114    =========================================================
 115
 116 * ``rte_page_sizes`` enumeration is replaced with ``RTE_PGSIZE_xxx`` defines.
 117
 118
 119 ABI Changes
 120 -----------
 121
 122 .. This section should contain ABI changes. Sample format:
 123
 124    * sample: Add a short 1-2 sentence description of the ABI change
 125      which was announced in the previous releases and made in this release.
 126      Start with a scope label like "ethdev:".
 127      Use fixed width quotes for ``function_names`` or ``struct_names``.
 128      Use the past tense.
 129
 130    This section is a comment. Do not overwrite or remove it.
 131    Also, make sure to start the actual text at the margin.
 132    =========================================================
 133
 134 * No ABI change that would break compatibility with 19.11.
 135
 136
 137 Known Issues
 138 ------------
 139
 140 .. This section should contain new known issues in this release. Sample format:
 141
 142    * **Add title in present tense with full stop.**
 143
 144      Add a short 1-2 sentence description of the known issue
 145      in the present tense. Add information on any known workarounds.
 146
 147    This section is a comment. Do not overwrite or remove it.
 148    Also, make sure to start the actual text at the margin.
 149    =========================================================
 150
 151
 152 Tested Platforms
 153 ----------------
 154
 155 .. This section should contain a list of platforms that were tested
 156    with this release.
 157
 158    The format is:
 159
 160    * <vendor> platform with <vendor> <type of devices> combinations
 161
 162      * List of CPU
 163      * List of OS
 164      * List of devices
 165      * Other relevant details...
 166
 167    This section is a comment. Do not overwrite or remove it.
 168    Also, make sure to start the actual text at the margin.
 169    =========================================================