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