doc/guides/rel_notes/release_16_04.rst

   1 DPDK Release 16.04
   2 ==================
   3
   4
   5 **Read this first**
   6
   7 The text below explains how to update the release notes.
   8
   9 Use proper spelling, capitalization and punctuation in all sections.
  10
  11 Variable and config names should be quoted as fixed width text: ``LIKE_THIS``.
  12
  13 Build the docs and view the output file to ensure the changes are correct::
  14
  15    make doc-guides-html
  16
  17    firefox build/doc/html/guides/rel_notes/release_16_04.html
  18
  19
  20 New Features
  21 ------------
  22
  23 This section should contain new features added in this release. Sample format:
  24
  25 * **Add a title in the past tense with a full stop.**
  26
  27   Add a short 1-2 sentence description in the past tense. The description
  28   should be enough to allow someone scanning the release notes to understand
  29   the new feature.
  30
  31   If the feature adds a lot of sub-features you can use a bullet list like this.
  32
  33   * Added feature foo to do something.
  34   * Enhanced feature bar to do something else.
  35
  36   Refer to the previous release notes for examples.
  37
  38 * **Enabled bulk allocation of mbufs.**
  39
  40   A new function ``rte_pktmbuf_alloc_bulk()`` has been added to allow the user
  41   to allocate a bulk of mbufs.
  42
  43 * **Virtio 1.0.**
  44
  45   Enabled virtio 1.0 support for virtio pmd driver.
  46
  47 * **Supported virtio offload in vhost-user.**
  48
  49   Add the offload and negotiation of checksum and TSO between vhost-user and
  50   vanilla Linux virtio guest.
  51
  52 * **Added vhost-user live migration support.**
  53
  54
  55 Resolved Issues
  56 ---------------
  57
  58 This section should contain bug fixes added to the relevant sections. Sample format:
  59
  60 * **code/section Fixed issue in the past tense with a full stop.**
  61
  62   Add a short 1-2 sentence description of the resolved issue in the past tense.
  63   The title should contain the code/lib section like a commit message.
  64   Add the entries in alphabetic order in the relevant sections below.
  65
  66 * **examples/vhost: Fixed frequent mbuf allocation failure.**
  67
  68   vhost-switch often fails to allocate mbuf when dequeue from vring because it
  69   wrongly calculates the number of mbufs needed.
  70
  71
  72 EAL
  73 ~~~
  74
  75
  76 Drivers
  77 ~~~~~~~
  78
  79 * **aesni_mb: Fixed wrong return value when creating a device.**
  80
  81   cryptodev_aesni_mb_init() was returning the device id of the device created,
  82   instead of 0 (when success), that rte_eal_vdev_init() expects.
  83   This made impossible the creation of more than one aesni_mb device
  84   from command line.
  85
  86
  87 Libraries
  88 ~~~~~~~~~
  89
  90
  91 Examples
  92 ~~~~~~~~
  93
  94
  95 Other
  96 ~~~~~
  97
  98
  99 Known Issues
 100 ------------
 101
 102 This section should contain new known issues in this release. Sample format:
 103
 104 * **Add title in present tense with full stop.**
 105
 106   Add a short 1-2 sentence description of the known issue in the present
 107   tense. Add information on any known workarounds.
 108
 109
 110 API Changes
 111 -----------
 112
 113 This section should contain API changes. Sample format:
 114
 115 * Add a short 1-2 sentence description of the API change. Use fixed width
 116   quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 117
 118
 119 ABI Changes
 120 -----------
 121
 122 * Add a short 1-2 sentence description of the ABI change that was announced in
 123   the previous releases and made in this release. Use fixed width quotes for
 124   ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 125
 126
 127 Shared Library Versions
 128 -----------------------
 129
 130 Update any library version updated in this release and prepend with a ``+`` sign.
 131
 132 The libraries prepended with a plus sign were incremented in this version.
 133
 134 .. code-block:: diff
 135
 136      libethdev.so.2
 137      librte_acl.so.2
 138      librte_cfgfile.so.2
 139      librte_cmdline.so.1
 140      librte_distributor.so.1
 141      librte_eal.so.2
 142      librte_hash.so.2
 143      librte_ip_frag.so.1
 144      librte_ivshmem.so.1
 145      librte_jobstats.so.1
 146      librte_kni.so.2
 147      librte_kvargs.so.1
 148      librte_lpm.so.2
 149      librte_mbuf.so.2
 150      librte_mempool.so.1
 151      librte_meter.so.1
 152      librte_pipeline.so.2
 153      librte_pmd_bond.so.1
 154      librte_pmd_ring.so.2
 155      librte_port.so.2
 156      librte_power.so.1
 157      librte_reorder.so.1
 158      librte_ring.so.1
 159      librte_sched.so.1
 160      librte_table.so.2
 161      librte_timer.so.1
 162      librte_vhost.so.2