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 for ARM.**
  48
  49   Enabled virtio support for armv7/v8. Tested for arm64.
  50   Virtio for arm support VFIO-noiommu mode only.
  51   Virtio can work with other non-x86 arch too like powerpc.
  52
  53 * **Supported virtio offload in vhost-user.**
  54
  55   Add the offload and negotiation of checksum and TSO between vhost-user and
  56   vanilla Linux virtio guest.
  57
  58 * **Added vhost-user live migration support.**
  59
  60
  61 Resolved Issues
  62 ---------------
  63
  64 This section should contain bug fixes added to the relevant sections. Sample format:
  65
  66 * **code/section Fixed issue in the past tense with a full stop.**
  67
  68   Add a short 1-2 sentence description of the resolved issue in the past tense.
  69   The title should contain the code/lib section like a commit message.
  70   Add the entries in alphabetic order in the relevant sections below.
  71
  72 * **examples/vhost: Fixed frequent mbuf allocation failure.**
  73
  74   vhost-switch often fails to allocate mbuf when dequeue from vring because it
  75   wrongly calculates the number of mbufs needed.
  76
  77
  78 EAL
  79 ~~~
  80
  81
  82 Drivers
  83 ~~~~~~~
  84
  85 * **aesni_mb: Fixed wrong return value when creating a device.**
  86
  87   cryptodev_aesni_mb_init() was returning the device id of the device created,
  88   instead of 0 (when success), that rte_eal_vdev_init() expects.
  89   This made impossible the creation of more than one aesni_mb device
  90   from command line.
  91
  92
  93 Libraries
  94 ~~~~~~~~~
  95
  96 * **hash: Fixed CRC32c hash computation for non multiple of 4 bytes sizes.**
  97
  98   Fix crc32c hash functions to return a valid crc32c value for data lengths
  99   not multiple of 4 bytes.
 100
 101
 102 Examples
 103 ~~~~~~~~
 104
 105
 106 Other
 107 ~~~~~
 108
 109
 110 Known Issues
 111 ------------
 112
 113 This section should contain new known issues in this release. Sample format:
 114
 115 * **Add title in present tense with full stop.**
 116
 117   Add a short 1-2 sentence description of the known issue in the present
 118   tense. Add information on any known workarounds.
 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
 130 ABI Changes
 131 -----------
 132
 133 * Add a short 1-2 sentence description of the ABI change that was announced in
 134   the previous releases and made in this release. Use fixed width quotes for
 135   ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 136
 137
 138 Shared Library Versions
 139 -----------------------
 140
 141 Update any library version updated in this release and prepend with a ``+`` sign.
 142
 143 The libraries prepended with a plus sign were incremented in this version.
 144
 145 .. code-block:: diff
 146
 147      libethdev.so.2
 148      librte_acl.so.2
 149      librte_cfgfile.so.2
 150      librte_cmdline.so.1
 151      librte_distributor.so.1
 152      librte_eal.so.2
 153      librte_hash.so.2
 154      librte_ip_frag.so.1
 155      librte_ivshmem.so.1
 156      librte_jobstats.so.1
 157      librte_kni.so.2
 158      librte_kvargs.so.1
 159      librte_lpm.so.2
 160      librte_mbuf.so.2
 161      librte_mempool.so.1
 162      librte_meter.so.1
 163      librte_pipeline.so.2
 164      librte_pmd_bond.so.1
 165      librte_pmd_ring.so.2
 166      librte_port.so.2
 167      librte_power.so.1
 168      librte_reorder.so.1
 169      librte_ring.so.1
 170      librte_sched.so.1
 171      librte_table.so.2
 172      librte_timer.so.1
 173      librte_vhost.so.2