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   * Added limited support for RAW.
  83   * Added limited support for RSS.
  84   * Added limited support for PASSTHRU.
  85
  86
  87 Removed Items
  88 -------------
  89
  90 .. This section should contain removed items in this release. Sample format:
  91
  92    * Add a short 1-2 sentence description of the removed item
  93      in the past tense.
  94
  95    This section is a comment. Do not overwrite or remove it.
  96    Also, make sure to start the actual text at the margin.
  97    =========================================================
  98
  99
 100 API Changes
 101 -----------
 102
 103 .. This section should contain API changes. Sample format:
 104
 105    * sample: Add a short 1-2 sentence description of the API change
 106      which was announced in the previous releases and made in this release.
 107      Start with a scope label like "ethdev:".
 108      Use fixed width quotes for ``function_names`` or ``struct_names``.
 109      Use the past tense.
 110
 111    This section is a comment. Do not overwrite or remove it.
 112    Also, make sure to start the actual text at the margin.
 113    =========================================================
 114
 115
 116 ABI Changes
 117 -----------
 118
 119 .. This section should contain ABI changes. Sample format:
 120
 121    * sample: Add a short 1-2 sentence description of the ABI change
 122      which was announced in the previous releases and made in this release.
 123      Start with a scope label like "ethdev:".
 124      Use fixed width quotes for ``function_names`` or ``struct_names``.
 125      Use the past tense.
 126
 127    This section is a comment. Do not overwrite or remove it.
 128    Also, make sure to start the actual text at the margin.
 129    =========================================================
 130
 131
 132 Shared Library Versions
 133 -----------------------
 134
 135 .. Update any library version updated in this release
 136    and prepend with a ``+`` sign, like this:
 137
 138      libfoo.so.1
 139    + libupdated.so.2
 140      libbar.so.1
 141
 142    This section is a comment. Do not overwrite or remove it.
 143    =========================================================
 144
 145 The libraries prepended with a plus sign were incremented in this version.
 146
 147 .. code-block:: diff
 148
 149      librte_acl.so.2
 150      librte_bbdev.so.1
 151      librte_bitratestats.so.2
 152      librte_bpf.so.1
 153      librte_bus_dpaa.so.2
 154      librte_bus_fslmc.so.2
 155      librte_bus_ifpga.so.2
 156      librte_bus_pci.so.2
 157      librte_bus_vdev.so.2
 158      librte_bus_vmbus.so.2
 159      librte_cfgfile.so.2
 160      librte_cmdline.so.2
 161      librte_compressdev.so.1
 162      librte_cryptodev.so.6
 163      librte_distributor.so.1
 164      librte_eal.so.9
 165      librte_efd.so.1
 166      librte_ethdev.so.11
 167      librte_eventdev.so.6
 168      librte_flow_classify.so.1
 169      librte_gro.so.1
 170      librte_gso.so.1
 171      librte_hash.so.2
 172      librte_ip_frag.so.1
 173      librte_jobstats.so.1
 174      librte_kni.so.2
 175      librte_kvargs.so.1
 176      librte_latencystats.so.1
 177      librte_lpm.so.2
 178      librte_mbuf.so.5
 179      librte_member.so.1
 180      librte_mempool.so.5
 181      librte_meter.so.2
 182      librte_metrics.so.1
 183      librte_net.so.1
 184      librte_pci.so.1
 185      librte_pdump.so.3
 186      librte_pipeline.so.3
 187      librte_pmd_bnxt.so.2
 188      librte_pmd_bond.so.2
 189      librte_pmd_i40e.so.2
 190      librte_pmd_ixgbe.so.2
 191      librte_pmd_dpaa2_qdma.so.1
 192      librte_pmd_ring.so.2
 193      librte_pmd_softnic.so.1
 194      librte_pmd_vhost.so.2
 195      librte_port.so.3
 196      librte_power.so.1
 197      librte_rawdev.so.1
 198      librte_reorder.so.1
 199      librte_ring.so.2
 200      librte_sched.so.2
 201      librte_security.so.2
 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    =========================================================