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