doc/guides/rel_notes/release_16_07.rst

   1 DPDK Release 16.07
   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_07.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 * **Removed mempool cache if not needed.**
  38
  39   The size of the mempool structure is reduced if the per-lcore cache is disabled.
  40
  41 * **Changed the memory allocation in mempool library.**
  42
  43   * Added ability to allocate a large mempool in virtually fragmented memory.
  44   * Added new APIs to populate a mempool with memory.
  45   * Added an API to free a mempool.
  46   * Modified the API of rte_mempool_obj_iter() function.
  47   * Dropped specific Xen Dom0 code.
  48   * Dropped specific anonymous mempool code in testpmd.
  49
  50
  51 Resolved Issues
  52 ---------------
  53
  54 .. This section should contain bug fixes added to the relevant sections. Sample format:
  55
  56    * **code/section Fixed issue in the past tense with a full stop.**
  57
  58      Add a short 1-2 sentence description of the resolved issue in the past tense.
  59      The title should contain the code/lib section like a commit message.
  60      Add the entries in alphabetic order in the relevant sections below.
  61
  62
  63 EAL
  64 ~~~
  65
  66
  67 Drivers
  68 ~~~~~~~
  69
  70 * **i40e: Fixed vlan stripping from inner header.**
  71
  72   Previously, for tunnel packets, such as VXLAN/NVGRE, the vlan
  73   tags of the inner header will be stripped without putting vlan
  74   info to descriptor.
  75   Now this issue is fixed by disabling vlan stripping from inner header.
  76
  77
  78 Libraries
  79 ~~~~~~~~~
  80
  81 * **mbuf: Fixed refcnt update when detaching.**
  82
  83   Fix the ``rte_pktmbuf_detach()`` function to decrement the direct
  84   mbuf's reference counter. The previous behavior was not to affect
  85   the reference counter. It lead a memory leak of the direct mbuf.
  86
  87
  88 Examples
  89 ~~~~~~~~
  90
  91
  92 Other
  93 ~~~~~
  94
  95
  96 Known Issues
  97 ------------
  98
  99 .. This section should contain new known issues in this release. Sample format:
 100
 101    * **Add title in present tense with full stop.**
 102
 103      Add a short 1-2 sentence description of the known issue in the present
 104      tense. Add information on any known workarounds.
 105
 106
 107 API Changes
 108 -----------
 109
 110 .. This section should contain API changes. Sample format:
 111
 112    * Add a short 1-2 sentence description of the API change. Use fixed width
 113      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 114
 115 * The following counters are removed from ``rte_eth_stats`` structure:
 116   ibadcrc, ibadlen, imcasts, fdirmatch, fdirmiss,
 117   tx_pause_xon, rx_pause_xon, tx_pause_xoff, rx_pause_xoff.
 118
 119
 120 ABI Changes
 121 -----------
 122
 123 .. * Add a short 1-2 sentence description of the ABI change that was announced in
 124      the previous releases and made in this release. Use fixed width quotes for
 125      ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 126
 127 * The ``rte_port_source_params`` structure has new fields to support PCAP file.
 128   It was already in release 16.04 with ``RTE_NEXT_ABI`` flag.
 129
 130
 131 Shared Library Versions
 132 -----------------------
 133
 134 .. Update any library version updated in this release and prepend with a ``+`` sign.
 135
 136 The libraries prepended with a plus sign were incremented in this version.
 137
 138 .. code-block:: diff
 139
 140    + libethdev.so.4
 141      librte_acl.so.2
 142      librte_cfgfile.so.2
 143      librte_cmdline.so.2
 144      librte_distributor.so.1
 145      librte_eal.so.2
 146      librte_hash.so.2
 147      librte_ip_frag.so.1
 148      librte_ivshmem.so.1
 149      librte_jobstats.so.1
 150      librte_kni.so.2
 151      librte_kvargs.so.1
 152      librte_lpm.so.2
 153      librte_mbuf.so.2
 154    + librte_mempool.so.2
 155      librte_meter.so.1
 156      librte_pipeline.so.3
 157      librte_pmd_bond.so.1
 158      librte_pmd_ring.so.2
 159    + librte_port.so.3
 160      librte_power.so.1
 161      librte_reorder.so.1
 162      librte_ring.so.1
 163      librte_sched.so.1
 164      librte_table.so.2
 165      librte_timer.so.1
 166      librte_vhost.so.2
 167
 168
 169 Tested Platforms
 170 ----------------
 171
 172 .. This section should contain a list of platforms that were tested with this
 173    release.
 174
 175    The format is:
 176
 177    #. Platform name.
 178
 179       - Platform details.
 180       - Platform details.
 181
 182
 183 Tested NICs
 184 -----------
 185
 186 .. This section should contain a list of NICs that were tested with this release.
 187
 188    The format is:
 189
 190    #. NIC name.
 191
 192       - NIC details.
 193       - NIC details.