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 * **Add support of support dynamic fields and flags in mbuf.**
  60
  61   This new feature adds the ability to dynamically register some room
  62   for a field or a flag in the mbuf structure. This is typically used
  63   for specific offload features, where adding a static field or flag
  64   in the mbuf is not justified.
  65
  66
  67 Removed Items
  68 -------------
  69
  70 .. This section should contain removed items in this release. Sample format:
  71
  72    * Add a short 1-2 sentence description of the removed item
  73      in the past tense.
  74
  75    This section is a comment. Do not overwrite or remove it.
  76    Also, make sure to start the actual text at the margin.
  77    =========================================================
  78
  79    * Removed duplicated set of commands for RX offloading configuration from app/testpmd:
  80      “port config all crc-strip|scatter|rx-cksum|rx-timestamp|hw-vlan|hw-vlan-filter|
  81      hw-vlan-strip|hw-vlan-extend on|off”.
  82
  83      The testpmd commands set that can be used instead in order to enable or disable Rx
  84      offloading on all Rx queues of a port is:
  85      "port config <port_id> rx_offload crc_strip|scatter|ipv4_cksum|udp_cksum|tcp_cksum|
  86      timestamp|vlan_strip|vlan_filter|vlan_extend on|off"
  87
  88
  89 API Changes
  90 -----------
  91
  92 .. This section should contain API changes. Sample format:
  93
  94    * sample: Add a short 1-2 sentence description of the API change
  95      which was announced in the previous releases and made in this release.
  96      Start with a scope label like "ethdev:".
  97      Use fixed width quotes for ``function_names`` or ``struct_names``.
  98      Use the past tense.
  99
 100    This section is a comment. Do not overwrite or remove it.
 101    Also, make sure to start the actual text at the margin.
 102    =========================================================
 103
 104
 105 ABI Changes
 106 -----------
 107
 108 .. This section should contain ABI changes. Sample format:
 109
 110    * sample: Add a short 1-2 sentence description of the ABI change
 111      which was announced in the previous releases and made in this release.
 112      Start with a scope label like "ethdev:".
 113      Use fixed width quotes for ``function_names`` or ``struct_names``.
 114      Use the past tense.
 115
 116    This section is a comment. Do not overwrite or remove it.
 117    Also, make sure to start the actual text at the margin.
 118    =========================================================
 119
 120
 121 Shared Library Versions
 122 -----------------------
 123
 124 .. Update any library version updated in this release
 125    and prepend with a ``+`` sign, like this:
 126
 127      libfoo.so.1
 128    + libupdated.so.2
 129      libbar.so.1
 130
 131    This section is a comment. Do not overwrite or remove it.
 132    =========================================================
 133
 134 The libraries prepended with a plus sign were incremented in this version.
 135
 136 .. code-block:: diff
 137
 138      librte_acl.so.2
 139      librte_bbdev.so.1
 140      librte_bitratestats.so.2
 141      librte_bpf.so.1
 142      librte_bus_dpaa.so.2
 143      librte_bus_fslmc.so.2
 144      librte_bus_ifpga.so.2
 145      librte_bus_pci.so.2
 146      librte_bus_vdev.so.2
 147      librte_bus_vmbus.so.2
 148      librte_cfgfile.so.2
 149      librte_cmdline.so.2
 150      librte_compressdev.so.1
 151      librte_cryptodev.so.8
 152      librte_distributor.so.1
 153      librte_eal.so.11
 154      librte_efd.so.1
 155      librte_ethdev.so.12
 156      librte_eventdev.so.7
 157      librte_flow_classify.so.1
 158      librte_gro.so.1
 159      librte_gso.so.1
 160      librte_hash.so.2
 161      librte_ip_frag.so.1
 162      librte_ipsec.so.1
 163      librte_jobstats.so.1
 164      librte_kni.so.2
 165      librte_kvargs.so.1
 166      librte_latencystats.so.1
 167      librte_lpm.so.2
 168      librte_mbuf.so.5
 169      librte_member.so.1
 170      librte_mempool.so.5
 171      librte_meter.so.3
 172      librte_metrics.so.1
 173      librte_net.so.1
 174      librte_pci.so.1
 175      librte_pdump.so.3
 176      librte_pipeline.so.3
 177      librte_pmd_bnxt.so.2
 178      librte_pmd_bond.so.2
 179      librte_pmd_i40e.so.2
 180      librte_pmd_ixgbe.so.2
 181      librte_pmd_dpaa2_qdma.so.1
 182      librte_pmd_ring.so.2
 183      librte_pmd_softnic.so.1
 184      librte_pmd_vhost.so.2
 185      librte_port.so.3
 186      librte_power.so.1
 187      librte_rawdev.so.1
 188      librte_rcu.so.1
 189      librte_reorder.so.1
 190      librte_ring.so.2
 191      librte_sched.so.3
 192      librte_security.so.2
 193      librte_stack.so.1
 194      librte_table.so.3
 195      librte_timer.so.1
 196      librte_vhost.so.4
 197
 198
 199 Known Issues
 200 ------------
 201
 202 .. This section should contain new known issues in this release. Sample format:
 203
 204    * **Add title in present tense with full stop.**
 205
 206      Add a short 1-2 sentence description of the known issue
 207      in the present tense. Add information on any known workarounds.
 208
 209    This section is a comment. Do not overwrite or remove it.
 210    Also, make sure to start the actual text at the margin.
 211    =========================================================
 212
 213
 214 Tested Platforms
 215 ----------------
 216
 217 .. This section should contain a list of platforms that were tested
 218    with this release.
 219
 220    The format is:
 221
 222    * <vendor> platform with <vendor> <type of devices> combinations
 223
 224      * List of CPU
 225      * List of OS
 226      * List of devices
 227      * Other relevant details...
 228
 229    This section is a comment. Do not overwrite or remove it.
 230    Also, make sure to start the actual text at the margin.
 231    =========================================================
 232