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