doc/guides/rel_notes/release_19_05.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright 2019 The DPDK contributors
   3
   4 DPDK Release 19.05
   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_05.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 Solarflare network PMD.**
  58
  59   Updated the sfc_efx driver including the following changes:
  60
  61   * Added support for Rx descriptor status and related API in a secondary
  62     process.
  63   * Added support for Tx descriptor status API in a secondary process.
  64   * Added support for RSS RETA and hash configuration get API in a secondary
  65     process.
  66   * Added support for Rx packet types list in a secondary process.
  67
  68 * **Updated Mellanox drivers.**
  69
  70    New features and improvements were done in mlx4 and mlx5 PMDs:
  71
  72    * Added firmware version reading.
  73
  74 * **Renamed avf to iavf.**
  75
  76   Renamed Intel Ethernet Adaptive Virtual Function driver ``avf`` to ``iavf``,
  77   which includes the directory name, lib name, filenames, makefile, docs,
  78   macros, functions, structs and any other strings in the code.
  79
  80 * **Updated the enic driver.**
  81
  82   * Fixed several flow (director) bugs related to MARK, SCTP, VLAN, VXLAN, and
  83     inner packet matching.
  84   * Added limited support for RAW.
  85   * Added limited support for RSS.
  86   * Added limited support for PASSTHRU.
  87
  88 * **Updated the ixgbe driver.**
  89
  90   New features for VF:
  91
  92   * Added promiscuous mode support.
  93
  94 * **Updated the testpmd application.**
  95
  96   Improved testpmd application performance on ARM platform. For ``macswap``
  97   forwarding mode, NEON intrinsics were used to do swap to save CPU cycles.
  98
  99
 100 Removed Items
 101 -------------
 102
 103 .. This section should contain removed items in this release. Sample format:
 104
 105    * Add a short 1-2 sentence description of the removed item
 106      in 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
 113 API Changes
 114 -----------
 115
 116 .. This section should contain API changes. Sample format:
 117
 118    * sample: Add a short 1-2 sentence description of the API 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 ABI Changes
 130 -----------
 131
 132 .. This section should contain ABI changes. Sample format:
 133
 134    * sample: Add a short 1-2 sentence description of the ABI change
 135      which was announced in the previous releases and made in this release.
 136      Start with a scope label like "ethdev:".
 137      Use fixed width quotes for ``function_names`` or ``struct_names``.
 138      Use the past tense.
 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 Shared Library Versions
 146 -----------------------
 147
 148 .. Update any library version updated in this release
 149    and prepend with a ``+`` sign, like this:
 150
 151      libfoo.so.1
 152    + libupdated.so.2
 153      libbar.so.1
 154
 155    This section is a comment. Do not overwrite or remove it.
 156    =========================================================
 157
 158 The libraries prepended with a plus sign were incremented in this version.
 159
 160 .. code-block:: diff
 161
 162      librte_acl.so.2
 163      librte_bbdev.so.1
 164      librte_bitratestats.so.2
 165      librte_bpf.so.1
 166      librte_bus_dpaa.so.2
 167      librte_bus_fslmc.so.2
 168      librte_bus_ifpga.so.2
 169      librte_bus_pci.so.2
 170      librte_bus_vdev.so.2
 171      librte_bus_vmbus.so.2
 172      librte_cfgfile.so.2
 173      librte_cmdline.so.2
 174      librte_compressdev.so.1
 175      librte_cryptodev.so.6
 176      librte_distributor.so.1
 177      librte_eal.so.9
 178      librte_efd.so.1
 179      librte_ethdev.so.11
 180      librte_eventdev.so.6
 181      librte_flow_classify.so.1
 182      librte_gro.so.1
 183      librte_gso.so.1
 184      librte_hash.so.2
 185      librte_ip_frag.so.1
 186      librte_jobstats.so.1
 187      librte_kni.so.2
 188      librte_kvargs.so.1
 189      librte_latencystats.so.1
 190      librte_lpm.so.2
 191      librte_mbuf.so.5
 192      librte_member.so.1
 193      librte_mempool.so.5
 194      librte_meter.so.2
 195      librte_metrics.so.1
 196      librte_net.so.1
 197      librte_pci.so.1
 198      librte_pdump.so.3
 199      librte_pipeline.so.3
 200      librte_pmd_bnxt.so.2
 201      librte_pmd_bond.so.2
 202      librte_pmd_i40e.so.2
 203      librte_pmd_ixgbe.so.2
 204      librte_pmd_dpaa2_qdma.so.1
 205      librte_pmd_ring.so.2
 206      librte_pmd_softnic.so.1
 207      librte_pmd_vhost.so.2
 208      librte_port.so.3
 209      librte_power.so.1
 210      librte_rawdev.so.1
 211      librte_reorder.so.1
 212      librte_ring.so.2
 213      librte_sched.so.2
 214      librte_security.so.2
 215      librte_table.so.3
 216      librte_timer.so.1
 217      librte_vhost.so.4
 218
 219
 220 Known Issues
 221 ------------
 222
 223 .. This section should contain new known issues in this release. Sample format:
 224
 225    * **Add title in present tense with full stop.**
 226
 227      Add a short 1-2 sentence description of the known issue
 228      in the present tense. Add information on any known workarounds.
 229
 230    This section is a comment. Do not overwrite or remove it.
 231    Also, make sure to start the actual text at the margin.
 232    =========================================================
 233
 234
 235 Tested Platforms
 236 ----------------
 237
 238 .. This section should contain a list of platforms that were tested
 239    with this release.
 240
 241    The format is:
 242
 243    * <vendor> platform with <vendor> <type of devices> combinations
 244
 245      * List of CPU
 246      * List of OS
 247      * List of devices
 248      * Other relevant details...
 249
 250    This section is a comment. Do not overwrite or remove it.
 251    Also, make sure to start the actual text at the margin.
 252    =========================================================