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