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