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