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