doc/guides/rel_notes/release_16_11.rst

   1 DPDK Release 16.11
   2 ==================
   3
   4 .. **Read this first.**
   5
   6    The text below explains how to update the release notes.
   7
   8    Use proper spelling, capitalization and punctuation in all sections.
   9
  10    Variable and config names should be quoted as fixed width text: ``LIKE_THIS``.
  11
  12    Build the docs and view the output file to ensure the changes are correct::
  13
  14       make doc-guides-html
  15
  16       firefox build/doc/html/guides/rel_notes/release_16_11.html
  17
  18
  19 New Features
  20 ------------
  21
  22 .. This section should contain new features added in this release. Sample format:
  23
  24    * **Add a title in the past tense with a full stop.**
  25
  26      Add a short 1-2 sentence description in the past tense. The description
  27      should be enough to allow someone scanning the release notes to understand
  28      the new feature.
  29
  30      If the feature adds a lot of sub-features you can use a bullet list like this.
  31
  32      * Added feature foo to do something.
  33      * Enhanced feature bar to do something else.
  34
  35      Refer to the previous release notes for examples.
  36
  37      This section is a comment. Make sure to start the actual text at the margin.
  38
  39 * **Added vhost-user indirect descriptors support.**
  40
  41   If indirect descriptor feature is negotiated, each packet sent by the guest
  42   will take exactly one slot in the enqueue virtqueue. Without the feature, in
  43   current version, even 64 bytes packets take two slots with Virtio PMD on guest
  44   side.
  45
  46   The main impact is better performance for 0% packet loss use-cases, as it
  47   behaves as if the virtqueue size was enlarged, so more packets can be buffered
  48   in case of system perturbations. On the downside, small performance degradation
  49   is measured when running micro-benchmarks.
  50
  51 * **Added vhost PMD xstats.**
  52
  53   Added extended statistics to vhost PMD from per port perspective.
  54
  55 * **Added virtio NEON support for ARM.**
  56
  57 * **Updated the ixgbe base driver.**
  58
  59   Updated the ixgbe base driver, including the following changes:
  60
  61   * add X550em_a 10G PHY support
  62   * support flow control auto negotiation for X550em_a 1G PHY
  63   * add X550em_a FW ALEF support
  64   * increase mailbox version to ixgbe_mbox_api_13
  65   * add two MAC ops for Hyper-V support
  66
  67 * **Updated the QAT PMD.**
  68
  69   The QAT PMD was updated with following support:
  70
  71   * MD5_HMAC algorithm
  72   * SHA224-HMAC algorithm
  73   * SHA384-HMAC algorithm
  74   * GMAC algorithm
  75   * KASUMI (F8 and F9) algorithm
  76   * 3DES algorithm
  77   * NULL algorithm
  78   * C3XXX device
  79   * C62XX device
  80
  81
  82 Resolved Issues
  83 ---------------
  84
  85 .. This section should contain bug fixes added to the relevant sections. Sample format:
  86
  87    * **code/section Fixed issue in the past tense with a full stop.**
  88
  89      Add a short 1-2 sentence description of the resolved issue in the past tense.
  90      The title should contain the code/lib section like a commit message.
  91      Add the entries in alphabetic order in the relevant sections below.
  92
  93    This section is a comment. Make sure to start the actual text at the margin.
  94
  95
  96 EAL
  97 ~~~
  98
  99
 100 Drivers
 101 ~~~~~~~
 102
 103
 104 Libraries
 105 ~~~~~~~~~
 106
 107
 108 Examples
 109 ~~~~~~~~
 110
 111
 112 Other
 113 ~~~~~
 114
 115
 116 Known Issues
 117 ------------
 118
 119 .. This section should contain new known issues in this release. Sample format:
 120
 121    * **Add title in present tense with full stop.**
 122
 123      Add a short 1-2 sentence description of the known issue in the present
 124      tense. Add information on any known workarounds.
 125
 126    This section is a comment. Make sure to start the actual text at the margin.
 127
 128
 129 API Changes
 130 -----------
 131
 132 .. This section should contain API changes. Sample format:
 133
 134    * Add a short 1-2 sentence description of the API change. Use fixed width
 135      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 136
 137    This section is a comment. Make sure to start the actual text at the margin.
 138
 139 * The driver names have been changed. It especially impacts ``--vdev`` arguments.
 140   Examples: ``eth_pcap`` becomes ``net_pcap``
 141   and ``cryptodev_aesni_mb_pmd`` becomes ``crypto_aesni_mb``.
 142
 143 * The log history is removed.
 144
 145 * The ``rte_ivshmem`` feature (including library and EAL code) has been removed
 146   in 16.11 because it had some design issues which were not planned to be fixed.
 147
 148
 149 ABI Changes
 150 -----------
 151
 152 .. This section should contain ABI changes. Sample format:
 153
 154    * Add a short 1-2 sentence description of the ABI change that was announced in
 155      the previous releases and made in this release. Use fixed width quotes for
 156      ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 157
 158    This section is a comment. Make sure to start the actual text at the margin.
 159
 160
 161
 162 Shared Library Versions
 163 -----------------------
 164
 165 .. Update any library version updated in this release and prepend with a ``+``
 166    sign, like this:
 167
 168      libethdev.so.4
 169      librte_acl.so.2
 170    + librte_cfgfile.so.2
 171      librte_cmdline.so.2
 172
 173
 174
 175 The libraries prepended with a plus sign were incremented in this version.
 176
 177 .. code-block:: diff
 178
 179      libethdev.so.4
 180      librte_acl.so.2
 181      librte_cfgfile.so.2
 182      librte_cmdline.so.2
 183      librte_cryptodev.so.1
 184      librte_distributor.so.1
 185    + librte_eal.so.3
 186      librte_hash.so.2
 187      librte_ip_frag.so.1
 188      librte_jobstats.so.1
 189      librte_kni.so.2
 190      librte_kvargs.so.1
 191      librte_lpm.so.2
 192      librte_mbuf.so.2
 193      librte_mempool.so.2
 194      librte_meter.so.1
 195      librte_pdump.so.1
 196      librte_pipeline.so.3
 197      librte_pmd_bond.so.1
 198      librte_pmd_ring.so.2
 199      librte_port.so.3
 200      librte_power.so.1
 201      librte_reorder.so.1
 202      librte_ring.so.1
 203      librte_sched.so.1
 204      librte_table.so.2
 205      librte_timer.so.1
 206      librte_vhost.so.3
 207
 208
 209 Tested Platforms
 210 ----------------
 211
 212 .. This section should contain a list of platforms that were tested with this release.
 213
 214    The format is:
 215
 216    #. Platform name.
 217
 218       * Platform details.
 219       * Platform details.
 220
 221    This section is a comment. Make sure to start the actual text at the margin.
 222
 223
 224 Tested NICs
 225 -----------
 226
 227 .. This section should contain a list of NICs that were tested with this release.
 228
 229    The format is:
 230
 231    #. NIC name.
 232
 233       * NIC details.
 234       * NIC details.
 235
 236    This section is a comment. Make sure to start the actual text at the margin.
 237
 238
 239 Tested OSes
 240 -----------
 241
 242 .. This section should contain a list of OSes that were tested with this release.
 243    The format is as follows, in alphabetical order:
 244
 245    * CentOS 7.0
 246    * Fedora 23
 247    * Fedora 24
 248    * FreeBSD 10.3
 249    * Red Hat Enterprise Linux 7.2
 250    * SUSE Enterprise Linux 12
 251    * Ubuntu 15.10
 252    * Ubuntu 16.04 LTS
 253    * Wind River Linux 8
 254
 255    This section is a comment. Make sure to start the actual text at the margin.