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