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