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
  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 * Removed ``RTE_KDRV_NONE`` based PCI device driver probing.
  92
  93
  94 API Changes
  95 -----------
  96
  97 .. This section should contain API changes. Sample format:
  98
  99    * sample: Add a short 1-2 sentence description of the API change
 100      which was announced in the previous releases and made in this release.
 101      Start with a scope label like "ethdev:".
 102      Use fixed width quotes for ``function_names`` or ``struct_names``.
 103      Use the past tense.
 104
 105    This section is a comment. Do not overwrite or remove it.
 106    Also, make sure to start the actual text at the margin.
 107    =========================================================
 108
 109 * ``rte_page_sizes`` enumeration is replaced with ``RTE_PGSIZE_xxx`` defines.
 110
 111
 112 ABI Changes
 113 -----------
 114
 115 .. This section should contain ABI changes. Sample format:
 116
 117    * sample: Add a short 1-2 sentence description of the ABI change
 118      which was announced in the previous releases and made in this release.
 119      Start with a scope label like "ethdev:".
 120      Use fixed width quotes for ``function_names`` or ``struct_names``.
 121      Use the past tense.
 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 * No ABI change that would break compatibility with 19.11.
 128
 129
 130 Known Issues
 131 ------------
 132
 133 .. This section should contain new known issues in this release. Sample format:
 134
 135    * **Add title in present tense with full stop.**
 136
 137      Add a short 1-2 sentence description of the known issue
 138      in the present tense. Add information on any known workarounds.
 139
 140    This section is a comment. Do not overwrite or remove it.
 141    Also, make sure to start the actual text at the margin.
 142    =========================================================
 143
 144
 145 Tested Platforms
 146 ----------------
 147
 148 .. This section should contain a list of platforms that were tested
 149    with this release.
 150
 151    The format is:
 152
 153    * <vendor> platform with <vendor> <type of devices> combinations
 154
 155      * List of CPU
 156      * List of OS
 157      * List of devices
 158      * Other relevant details...
 159
 160    This section is a comment. Do not overwrite or remove it.
 161    Also, make sure to start the actual text at the margin.
 162    =========================================================