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
  75
  76 Resolved Issues
  77 ---------------
  78
  79 .. This section should contain bug fixes added to the relevant sections. Sample format:
  80
  81    * **code/section Fixed issue in the past tense with a full stop.**
  82
  83      Add a short 1-2 sentence description of the resolved issue in the past tense.
  84      The title should contain the code/lib section like a commit message.
  85      Add the entries in alphabetic order in the relevant sections below.
  86
  87    This section is a comment. Make sure to start the actual text at the margin.
  88
  89
  90 EAL
  91 ~~~
  92
  93
  94 Drivers
  95 ~~~~~~~
  96
  97
  98 Libraries
  99 ~~~~~~~~~
 100
 101
 102 Examples
 103 ~~~~~~~~
 104
 105
 106 Other
 107 ~~~~~
 108
 109
 110 Known Issues
 111 ------------
 112
 113 .. This section should contain new known issues in this release. Sample format:
 114
 115    * **Add title in present tense with full stop.**
 116
 117      Add a short 1-2 sentence description of the known issue in the present
 118      tense. Add information on any known workarounds.
 119
 120    This section is a comment. Make sure to start the actual text at the margin.
 121
 122
 123 API Changes
 124 -----------
 125
 126 .. This section should contain API changes. Sample format:
 127
 128    * Add a short 1-2 sentence description of the API change. Use fixed width
 129      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 130
 131    This section is a comment. Make sure to start the actual text at the margin.
 132
 133 * The driver names have been changed. It especially impacts ``--vdev`` arguments.
 134   Examples: ``eth_pcap`` becomes ``net_pcap``
 135   and ``cryptodev_aesni_mb_pmd`` becomes ``crypto_aesni_mb``.
 136
 137 * The log history is removed.
 138
 139 * The ``rte_ivshmem`` feature (including library and EAL code) has been removed
 140   in 16.11 because it had some design issues which were not planned to be fixed.
 141
 142
 143 ABI Changes
 144 -----------
 145
 146 .. This section should contain ABI changes. Sample format:
 147
 148    * Add a short 1-2 sentence description of the ABI change that was announced in
 149      the previous releases and made in this release. Use fixed width quotes for
 150      ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 151
 152    This section is a comment. Make sure to start the actual text at the margin.
 153
 154
 155
 156 Shared Library Versions
 157 -----------------------
 158
 159 .. Update any library version updated in this release and prepend with a ``+``
 160    sign, like this:
 161
 162      libethdev.so.4
 163      librte_acl.so.2
 164    + librte_cfgfile.so.2
 165      librte_cmdline.so.2
 166
 167
 168
 169 The libraries prepended with a plus sign were incremented in this version.
 170
 171 .. code-block:: diff
 172
 173      libethdev.so.4
 174      librte_acl.so.2
 175      librte_cfgfile.so.2
 176      librte_cmdline.so.2
 177      librte_cryptodev.so.1
 178      librte_distributor.so.1
 179    + librte_eal.so.3
 180      librte_hash.so.2
 181      librte_ip_frag.so.1
 182      librte_jobstats.so.1
 183      librte_kni.so.2
 184      librte_kvargs.so.1
 185      librte_lpm.so.2
 186      librte_mbuf.so.2
 187      librte_mempool.so.2
 188      librte_meter.so.1
 189      librte_pdump.so.1
 190      librte_pipeline.so.3
 191      librte_pmd_bond.so.1
 192      librte_pmd_ring.so.2
 193      librte_port.so.3
 194      librte_power.so.1
 195      librte_reorder.so.1
 196      librte_ring.so.1
 197      librte_sched.so.1
 198      librte_table.so.2
 199      librte_timer.so.1
 200      librte_vhost.so.3
 201
 202
 203 Tested Platforms
 204 ----------------
 205
 206 .. This section should contain a list of platforms that were tested with this release.
 207
 208    The format is:
 209
 210    #. Platform name.
 211
 212       * Platform details.
 213       * Platform details.
 214
 215    This section is a comment. Make sure to start the actual text at the margin.
 216
 217
 218 Tested NICs
 219 -----------
 220
 221 .. This section should contain a list of NICs that were tested with this release.
 222
 223    The format is:
 224
 225    #. NIC name.
 226
 227       * NIC details.
 228       * NIC details.
 229
 230    This section is a comment. Make sure to start the actual text at the margin.
 231
 232
 233 Tested OSes
 234 -----------
 235
 236 .. This section should contain a list of OSes that were tested with this release.
 237    The format is as follows, in alphabetical order:
 238
 239    * CentOS 7.0
 240    * Fedora 23
 241    * Fedora 24
 242    * FreeBSD 10.3
 243    * Red Hat Enterprise Linux 7.2
 244    * SUSE Enterprise Linux 12
 245    * Ubuntu 15.10
 246    * Ubuntu 16.04 LTS
 247    * Wind River Linux 8
 248
 249    This section is a comment. Make sure to start the actual text at the margin.