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