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