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