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 memif PMD.**
  66
  67   Added the new Shared Memory Packet Interface (``memif``) PMD.
  68   See the :doc:`../nics/memif` guide for more details on this new driver.
  69
  70
  71 Removed Items
  72 -------------
  73
  74 .. This section should contain removed items in this release. Sample format:
  75
  76    * Add a short 1-2 sentence description of the removed item
  77      in the past tense.
  78
  79    This section is a comment. Do not overwrite or remove it.
  80    Also, make sure to start the actual text at the margin.
  81    =========================================================
  82
  83 * Removed KNI ethtool, CONFIG_RTE_KNI_KMOD_ETHTOOL, support.
  84
  85 * build: armv8 crypto extension is disabled.
  86
  87
  88 API Changes
  89 -----------
  90
  91 .. This section should contain API changes. Sample format:
  92
  93    * sample: Add a short 1-2 sentence description of the API change
  94      which was announced in the previous releases and made in this release.
  95      Start with a scope label like "ethdev:".
  96      Use fixed width quotes for ``function_names`` or ``struct_names``.
  97      Use the past tense.
  98
  99    This section is a comment. Do not overwrite or remove it.
 100    Also, make sure to start the actual text at the margin.
 101    =========================================================
 102
 103 * The network structures, definitions and functions have
 104   been prefixed by ``rte_`` to resolve conflicts with libc headers.
 105
 106
 107 ABI Changes
 108 -----------
 109
 110 .. This section should contain ABI changes. Sample format:
 111
 112    * sample: Add a short 1-2 sentence description of the ABI change
 113      which was announced in the previous releases and made in this release.
 114      Start with a scope label like "ethdev:".
 115      Use fixed width quotes for ``function_names`` or ``struct_names``.
 116      Use the past tense.
 117
 118    This section is a comment. Do not overwrite or remove it.
 119    Also, make sure to start the actual text at the margin.
 120    =========================================================
 121
 122
 123 Shared Library Versions
 124 -----------------------
 125
 126 .. Update any library version updated in this release
 127    and prepend with a ``+`` sign, like this:
 128
 129      libfoo.so.1
 130    + libupdated.so.2
 131      libbar.so.1
 132
 133    This section is a comment. Do not overwrite or remove it.
 134    =========================================================
 135
 136 The libraries prepended with a plus sign were incremented in this version.
 137
 138 .. code-block:: diff
 139
 140      librte_acl.so.2
 141      librte_bbdev.so.1
 142      librte_bitratestats.so.2
 143      librte_bpf.so.1
 144      librte_bus_dpaa.so.2
 145      librte_bus_fslmc.so.2
 146      librte_bus_ifpga.so.2
 147      librte_bus_pci.so.2
 148      librte_bus_vdev.so.2
 149      librte_bus_vmbus.so.2
 150      librte_cfgfile.so.2
 151      librte_cmdline.so.2
 152      librte_compressdev.so.1
 153      librte_cryptodev.so.7
 154      librte_distributor.so.1
 155      librte_eal.so.10
 156      librte_efd.so.1
 157      librte_ethdev.so.12
 158      librte_eventdev.so.6
 159      librte_flow_classify.so.1
 160      librte_gro.so.1
 161      librte_gso.so.1
 162      librte_hash.so.2
 163      librte_ip_frag.so.1
 164      librte_ipsec.so.1
 165      librte_jobstats.so.1
 166      librte_kni.so.2
 167      librte_kvargs.so.1
 168      librte_latencystats.so.1
 169      librte_lpm.so.2
 170      librte_mbuf.so.5
 171      librte_member.so.1
 172      librte_mempool.so.5
 173      librte_meter.so.3
 174      librte_metrics.so.1
 175      librte_net.so.1
 176      librte_pci.so.1
 177      librte_pdump.so.3
 178      librte_pipeline.so.3
 179      librte_pmd_bnxt.so.2
 180      librte_pmd_bond.so.2
 181      librte_pmd_i40e.so.2
 182      librte_pmd_ixgbe.so.2
 183      librte_pmd_dpaa2_qdma.so.1
 184      librte_pmd_ring.so.2
 185      librte_pmd_softnic.so.1
 186      librte_pmd_vhost.so.2
 187      librte_port.so.3
 188      librte_power.so.1
 189      librte_rawdev.so.1
 190      librte_rcu.so.1
 191      librte_reorder.so.1
 192      librte_ring.so.2
 193      librte_sched.so.2
 194      librte_security.so.2
 195      librte_stack.so.1
 196      librte_table.so.3
 197      librte_timer.so.1
 198      librte_vhost.so.4
 199
 200
 201 Known Issues
 202 ------------
 203
 204 .. This section should contain new known issues in this release. Sample format:
 205
 206    * **Add title in present tense with full stop.**
 207
 208      Add a short 1-2 sentence description of the known issue
 209      in the present tense. Add information on any known workarounds.
 210
 211    This section is a comment. Do not overwrite or remove it.
 212    Also, make sure to start the actual text at the margin.
 213    =========================================================
 214
 215
 216 Tested Platforms
 217 ----------------
 218
 219 .. This section should contain a list of platforms that were tested
 220    with this release.
 221
 222    The format is:
 223
 224    * <vendor> platform with <vendor> <type of devices> combinations
 225
 226      * List of CPU
 227      * List of OS
 228      * List of devices
 229      * Other relevant details...
 230
 231    This section is a comment. Do not overwrite or remove it.
 232    Also, make sure to start the actual text at the margin.
 233    =========================================================
 234