doc/guides/rel_notes/release_19_11.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright 2019 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 19.11
   7 ==================
   8
   9 .. **Read this first.**
  10
  11    The text in the sections below explains how to update the release notes.
  12
  13    Use proper spelling, capitalization and punctuation in all sections.
  14
  15    Variable and config names should be quoted as fixed width text:
  16    ``LIKE_THIS``.
  17
  18    Build the docs and view the output file to ensure the changes are correct::
  19
  20       make doc-guides-html
  21
  22       xdg-open build/doc/html/guides/rel_notes/release_19_11.html
  23
  24
  25 New Features
  26 ------------
  27
  28 .. This section should contain new features added in this release.
  29    Sample format:
  30
  31    * **Add a title in the past tense with a full stop.**
  32
  33      Add a short 1-2 sentence description in the past tense.
  34      The description should be enough to allow someone scanning
  35      the release notes to understand the new feature.
  36
  37      If the feature adds a lot of sub-features you can use a bullet list
  38      like this:
  39
  40      * Added feature foo to do something.
  41      * Enhanced feature bar to do something else.
  42
  43      Refer to the previous release notes for examples.
  44
  45      Suggested order in release notes items:
  46      * Core libs (EAL, mempool, ring, mbuf, buses)
  47      * Device abstraction libs and PMDs
  48        - ethdev (lib, PMDs)
  49        - cryptodev (lib, PMDs)
  50        - eventdev (lib, PMDs)
  51        - etc
  52      * Other libs
  53      * Apps, Examples, Tools (if significant)
  54
  55      This section is a comment. Do not overwrite or remove it.
  56      Also, make sure to start the actual text at the margin.
  57      =========================================================
  58
  59
  60 Removed Items
  61 -------------
  62
  63 .. This section should contain removed items in this release. Sample format:
  64
  65    * Add a short 1-2 sentence description of the removed item
  66      in the past tense.
  67
  68    This section is a comment. Do not overwrite or remove it.
  69    Also, make sure to start the actual text at the margin.
  70    =========================================================
  71
  72    * Removed duplicated set of commands for RX offloading configuration from app/testpmd:
  73      “port config all crc-strip|scatter|rx-cksum|rx-timestamp|hw-vlan|hw-vlan-filter|
  74      hw-vlan-strip|hw-vlan-extend on|off”.
  75
  76      The testpmd commands set that can be used instead in order to enable or disable Rx
  77      offloading on all Rx queues of a port is:
  78      "port config <port_id> rx_offload crc_strip|scatter|ipv4_cksum|udp_cksum|tcp_cksum|
  79      timestamp|vlan_strip|vlan_filter|vlan_extend on|off"
  80
  81
  82 API Changes
  83 -----------
  84
  85 .. This section should contain API changes. Sample format:
  86
  87    * sample: Add a short 1-2 sentence description of the API change
  88      which was announced in the previous releases and made in this release.
  89      Start with a scope label like "ethdev:".
  90      Use fixed width quotes for ``function_names`` or ``struct_names``.
  91      Use the past tense.
  92
  93    This section is a comment. Do not overwrite or remove it.
  94    Also, make sure to start the actual text at the margin.
  95    =========================================================
  96
  97
  98 ABI Changes
  99 -----------
 100
 101 .. This section should contain ABI changes. Sample format:
 102
 103    * sample: Add a short 1-2 sentence description of the ABI change
 104      which was announced in the previous releases and made in this release.
 105      Start with a scope label like "ethdev:".
 106      Use fixed width quotes for ``function_names`` or ``struct_names``.
 107      Use the past tense.
 108
 109    This section is a comment. Do not overwrite or remove it.
 110    Also, make sure to start the actual text at the margin.
 111    =========================================================
 112
 113
 114 Shared Library Versions
 115 -----------------------
 116
 117 .. Update any library version updated in this release
 118    and prepend with a ``+`` sign, like this:
 119
 120      libfoo.so.1
 121    + libupdated.so.2
 122      libbar.so.1
 123
 124    This section is a comment. Do not overwrite or remove it.
 125    =========================================================
 126
 127 The libraries prepended with a plus sign were incremented in this version.
 128
 129 .. code-block:: diff
 130
 131      librte_acl.so.2
 132      librte_bbdev.so.1
 133      librte_bitratestats.so.2
 134      librte_bpf.so.1
 135      librte_bus_dpaa.so.2
 136      librte_bus_fslmc.so.2
 137      librte_bus_ifpga.so.2
 138      librte_bus_pci.so.2
 139      librte_bus_vdev.so.2
 140      librte_bus_vmbus.so.2
 141      librte_cfgfile.so.2
 142      librte_cmdline.so.2
 143      librte_compressdev.so.1
 144      librte_cryptodev.so.8
 145      librte_distributor.so.1
 146      librte_eal.so.11
 147      librte_efd.so.1
 148      librte_ethdev.so.12
 149      librte_eventdev.so.7
 150      librte_flow_classify.so.1
 151      librte_gro.so.1
 152      librte_gso.so.1
 153      librte_hash.so.2
 154      librte_ip_frag.so.1
 155      librte_ipsec.so.1
 156      librte_jobstats.so.1
 157      librte_kni.so.2
 158      librte_kvargs.so.1
 159      librte_latencystats.so.1
 160      librte_lpm.so.2
 161      librte_mbuf.so.5
 162      librte_member.so.1
 163      librte_mempool.so.5
 164      librte_meter.so.3
 165      librte_metrics.so.1
 166      librte_net.so.1
 167      librte_pci.so.1
 168      librte_pdump.so.3
 169      librte_pipeline.so.3
 170      librte_pmd_bnxt.so.2
 171      librte_pmd_bond.so.2
 172      librte_pmd_i40e.so.2
 173      librte_pmd_ixgbe.so.2
 174      librte_pmd_dpaa2_qdma.so.1
 175      librte_pmd_ring.so.2
 176      librte_pmd_softnic.so.1
 177      librte_pmd_vhost.so.2
 178      librte_port.so.3
 179      librte_power.so.1
 180      librte_rawdev.so.1
 181      librte_rcu.so.1
 182      librte_reorder.so.1
 183      librte_ring.so.2
 184      librte_sched.so.3
 185      librte_security.so.2
 186      librte_stack.so.1
 187      librte_table.so.3
 188      librte_timer.so.1
 189      librte_vhost.so.4
 190
 191
 192 Known Issues
 193 ------------
 194
 195 .. This section should contain new known issues in this release. Sample format:
 196
 197    * **Add title in present tense with full stop.**
 198
 199      Add a short 1-2 sentence description of the known issue
 200      in the present tense. Add information on any known workarounds.
 201
 202    This section is a comment. Do not overwrite or remove it.
 203    Also, make sure to start the actual text at the margin.
 204    =========================================================
 205
 206
 207 Tested Platforms
 208 ----------------
 209
 210 .. This section should contain a list of platforms that were tested
 211    with this release.
 212
 213    The format is:
 214
 215    * <vendor> platform with <vendor> <type of devices> combinations
 216
 217      * List of CPU
 218      * List of OS
 219      * List of devices
 220      * Other relevant details...
 221
 222    This section is a comment. Do not overwrite or remove it.
 223    Also, make sure to start the actual text at the margin.
 224    =========================================================
 225