doc/guides/rel_notes/release_19_08.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright 2019 The DPDK contributors
   3
   4 DPDK Release 19.08
   5 ==================
   6
   7 .. **Read this first.**
   8
   9    The text in the sections below explains how to update the release notes.
  10
  11    Use proper spelling, capitalization and punctuation in all sections.
  12
  13    Variable and config names should be quoted as fixed width text:
  14    ``LIKE_THIS``.
  15
  16    Build the docs and view the output file to ensure the changes are correct::
  17
  18       make doc-guides-html
  19
  20       xdg-open build/doc/html/guides/rel_notes/release_19_08.html
  21
  22
  23 New Features
  24 ------------
  25
  26 .. This section should contain new features added in this release.
  27    Sample format:
  28
  29    * **Add a title in the past tense with a full stop.**
  30
  31      Add a short 1-2 sentence description in the past tense.
  32      The description should be enough to allow someone scanning
  33      the release notes to understand the new feature.
  34
  35      If the feature adds a lot of sub-features you can use a bullet list
  36      like this:
  37
  38      * Added feature foo to do something.
  39      * Enhanced feature bar to do something else.
  40
  41      Refer to the previous release notes for examples.
  42
  43      Suggested order in release notes items:
  44      * Core libs (EAL, mempool, ring, mbuf, buses)
  45      * Device abstraction libs and PMDs
  46        - ethdev (lib, PMDs)
  47        - cryptodev (lib, PMDs)
  48        - eventdev (lib, PMDs)
  49        - etc
  50      * Other libs
  51      * Apps, Examples, Tools (if significant)
  52
  53      This section is a comment. Do not overwrite or remove it.
  54      Also, make sure to start the actual text at the margin.
  55      =========================================================
  56
  57 * **Updated the bnxt PMD.**
  58
  59   Updated the bnxt PMD. The major enhancements include:
  60
  61   * Performance optimizations in non-vector Tx path
  62   * Added support for SSE vector mode
  63   * Updated HWRM API to version 1.10.0.74
  64
  65 * **Added support for Broadcom NetXtreme-E BCM57500 Ethernet controllers.**
  66
  67   Added support to the bnxt PMD for the BCM57500 (a.k.a. "Thor") family
  68   of Ethernet controllers. These controllers support link speeds up to
  69   200Gbps, 50G PAM-4, and PCIe 4.0.
  70
  71 * **Added memif PMD.**
  72
  73   Added the new Shared Memory Packet Interface (``memif``) PMD.
  74   See the :doc:`../nics/memif` guide for more details on this new driver.
  75
  76
  77 Removed Items
  78 -------------
  79
  80 .. This section should contain removed items in this release. Sample format:
  81
  82    * Add a short 1-2 sentence description of the removed item
  83      in the past tense.
  84
  85    This section is a comment. Do not overwrite or remove it.
  86    Also, make sure to start the actual text at the margin.
  87    =========================================================
  88
  89 * Removed KNI ethtool, CONFIG_RTE_KNI_KMOD_ETHTOOL, support.
  90
  91 * build: armv8 crypto extension is disabled.
  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 * The network structures, definitions and functions have
 110   been prefixed by ``rte_`` to resolve conflicts with libc headers.
 111
 112
 113 ABI Changes
 114 -----------
 115
 116 .. This section should contain ABI changes. Sample format:
 117
 118    * sample: Add a short 1-2 sentence description of the ABI change
 119      which was announced in the previous releases and made in this release.
 120      Start with a scope label like "ethdev:".
 121      Use fixed width quotes for ``function_names`` or ``struct_names``.
 122      Use the past tense.
 123
 124    This section is a comment. Do not overwrite or remove it.
 125    Also, make sure to start the actual text at the margin.
 126    =========================================================
 127
 128
 129 Shared Library Versions
 130 -----------------------
 131
 132 .. Update any library version updated in this release
 133    and prepend with a ``+`` sign, like this:
 134
 135      libfoo.so.1
 136    + libupdated.so.2
 137      libbar.so.1
 138
 139    This section is a comment. Do not overwrite or remove it.
 140    =========================================================
 141
 142 The libraries prepended with a plus sign were incremented in this version.
 143
 144 .. code-block:: diff
 145
 146      librte_acl.so.2
 147      librte_bbdev.so.1
 148      librte_bitratestats.so.2
 149      librte_bpf.so.1
 150      librte_bus_dpaa.so.2
 151      librte_bus_fslmc.so.2
 152      librte_bus_ifpga.so.2
 153      librte_bus_pci.so.2
 154      librte_bus_vdev.so.2
 155      librte_bus_vmbus.so.2
 156      librte_cfgfile.so.2
 157      librte_cmdline.so.2
 158      librte_compressdev.so.1
 159      librte_cryptodev.so.7
 160      librte_distributor.so.1
 161      librte_eal.so.10
 162      librte_efd.so.1
 163      librte_ethdev.so.12
 164      librte_eventdev.so.6
 165      librte_flow_classify.so.1
 166      librte_gro.so.1
 167      librte_gso.so.1
 168      librte_hash.so.2
 169      librte_ip_frag.so.1
 170      librte_ipsec.so.1
 171      librte_jobstats.so.1
 172      librte_kni.so.2
 173      librte_kvargs.so.1
 174      librte_latencystats.so.1
 175      librte_lpm.so.2
 176      librte_mbuf.so.5
 177      librte_member.so.1
 178      librte_mempool.so.5
 179      librte_meter.so.3
 180      librte_metrics.so.1
 181      librte_net.so.1
 182      librte_pci.so.1
 183      librte_pdump.so.3
 184      librte_pipeline.so.3
 185      librte_pmd_bnxt.so.2
 186      librte_pmd_bond.so.2
 187      librte_pmd_i40e.so.2
 188      librte_pmd_ixgbe.so.2
 189      librte_pmd_dpaa2_qdma.so.1
 190      librte_pmd_ring.so.2
 191      librte_pmd_softnic.so.1
 192      librte_pmd_vhost.so.2
 193      librte_port.so.3
 194      librte_power.so.1
 195      librte_rawdev.so.1
 196      librte_rcu.so.1
 197      librte_reorder.so.1
 198      librte_ring.so.2
 199      librte_sched.so.2
 200      librte_security.so.2
 201      librte_stack.so.1
 202      librte_table.so.3
 203      librte_timer.so.1
 204      librte_vhost.so.4
 205
 206
 207 Known Issues
 208 ------------
 209
 210 .. This section should contain new known issues in this release. Sample format:
 211
 212    * **Add title in present tense with full stop.**
 213
 214      Add a short 1-2 sentence description of the known issue
 215      in the present tense. Add information on any known workarounds.
 216
 217    This section is a comment. Do not overwrite or remove it.
 218    Also, make sure to start the actual text at the margin.
 219    =========================================================
 220
 221
 222 Tested Platforms
 223 ----------------
 224
 225 .. This section should contain a list of platforms that were tested
 226    with this release.
 227
 228    The format is:
 229
 230    * <vendor> platform with <vendor> <type of devices> combinations
 231
 232      * List of CPU
 233      * List of OS
 234      * List of devices
 235      * Other relevant details...
 236
 237    This section is a comment. Do not overwrite or remove it.
 238    Also, make sure to start the actual text at the margin.
 239    =========================================================
 240