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