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