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