doc/guides/rel_notes/release_17_08.rst

   1 DPDK Release 17.08
   2 ==================
   3
   4 .. **Read this first.**
   5
   6    The text in the sections 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:
  11    ``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       xdg-open build/doc/html/guides/rel_notes/release_17_08.html
  18
  19
  20 New Features
  21 ------------
  22
  23 .. This section should contain new features added in this release. Sample
  24    format:
  25
  26    * **Add a title in the past tense with a full stop.**
  27
  28      Add a short 1-2 sentence description in the past tense. The description
  29      should be enough to allow someone scanning the release notes to
  30      understand the new feature.
  31
  32      If the feature adds a lot of sub-features you can use a bullet list like
  33      this:
  34
  35      * Added feature foo to do something.
  36      * Enhanced feature bar to do something else.
  37
  38      Refer to the previous release notes for examples.
  39
  40      This section is a comment. do not overwrite or remove it.
  41      Also, make sure to start the actual text at the margin.
  42      =========================================================
  43
  44 * **Added Generic Flow API support to enic.**
  45
  46   Flow API support for outer Ethernet, VLAN, IPv4, IPv6, UDP, TCP, SCTP, VxLAN
  47   and inner Ethernet, VLAN, IPv4, IPv6, UDP and TCP pattern items with QUEUE,
  48   MARK, FLAG and VOID actions for ingress traffic.
  49
  50 * **Added support for Chelsio T6 family of adapters**
  51
  52   CXGBE PMD updated to run Chelsio T6 family of adapters.
  53
  54 * **Added latency and performance improvements for cxgbe**
  55
  56   TX and RX path reworked to improve performance.  Also reduced latency
  57   for slow traffic.
  58
  59
  60 Resolved Issues
  61 ---------------
  62
  63 .. This section should contain bug fixes added to the relevant
  64    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
  69      tense.
  70
  71      The title should contain the code/lib section like a commit message.
  72
  73      Add the entries in alphabetic order in the relevant sections below.
  74
  75    This section is a comment. do not overwrite or remove it.
  76    Also, make sure to start the actual text at the margin.
  77    =========================================================
  78
  79
  80 EAL
  81 ~~~
  82
  83
  84 Drivers
  85 ~~~~~~~
  86
  87
  88 Libraries
  89 ~~~~~~~~~
  90
  91
  92 Examples
  93 ~~~~~~~~
  94
  95
  96 Other
  97 ~~~~~
  98
  99
 100 Known Issues
 101 ------------
 102
 103 .. This section should contain new known issues in this release. Sample format:
 104
 105    * **Add title in present tense with full stop.**
 106
 107      Add a short 1-2 sentence description of the known issue in the present
 108      tense. Add information on any known workarounds.
 109
 110    This section is a comment. do not overwrite or remove it.
 111    Also, make sure to start the actual text at the margin.
 112    =========================================================
 113
 114
 115 API Changes
 116 -----------
 117
 118 .. This section should contain API changes. Sample format:
 119
 120    * Add a short 1-2 sentence description of the API change. Use fixed width
 121      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
 122      tense.
 123
 124    This section is a comment. do not overwrite or remove it.
 125    Also, make sure to start the actual text at the margin.
 126    =========================================================
 127
 128
 129 ABI Changes
 130 -----------
 131
 132 .. This section should contain ABI changes. Sample format:
 133
 134    * Add a short 1-2 sentence description of the ABI change that was announced
 135      in the previous releases and made in this release. Use fixed width quotes
 136      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 137
 138    This section is a comment. do not overwrite or remove it.
 139    Also, make sure to start the actual text at the margin.
 140    =========================================================
 141
 142
 143
 144 Shared Library Versions
 145 -----------------------
 146
 147 .. Update any library version updated in this release and prepend with a ``+``
 148    sign, like this:
 149
 150      librte_acl.so.2
 151    + librte_cfgfile.so.2
 152      librte_cmdline.so.2
 153
 154    This section is a comment. do not overwrite or remove it.
 155    =========================================================
 156
 157
 158 The libraries prepended with a plus sign were incremented in this version.
 159
 160 .. code-block:: diff
 161
 162      librte_acl.so.2
 163      librte_bitratestats.so.1
 164      librte_cfgfile.so.2
 165      librte_cmdline.so.2
 166      librte_cryptodev.so.2
 167      librte_distributor.so.1
 168      librte_eal.so.4
 169      librte_ethdev.so.6
 170      librte_hash.so.2
 171      librte_ip_frag.so.1
 172      librte_jobstats.so.1
 173      librte_kni.so.2
 174      librte_kvargs.so.1
 175      librte_latencystats.so.1
 176      librte_lpm.so.2
 177      librte_mbuf.so.3
 178      librte_mempool.so.2
 179      librte_meter.so.1
 180      librte_metrics.so.1
 181      librte_net.so.1
 182      librte_pdump.so.1
 183      librte_pipeline.so.3
 184      librte_pmd_bond.so.1
 185      librte_pmd_ring.so.2
 186      librte_port.so.3
 187      librte_power.so.1
 188      librte_reorder.so.1
 189      librte_ring.so.1
 190      librte_sched.so.1
 191      librte_table.so.2
 192      librte_timer.so.1
 193      librte_vhost.so.3
 194
 195
 196 Tested Platforms
 197 ----------------
 198
 199 .. This section should contain a list of platforms that were tested with this
 200    release.
 201
 202    The format is:
 203
 204    * <vendor> platform with <vendor> <type of devices> combinations
 205
 206      * List of CPU
 207      * List of OS
 208      * List of devices
 209      * Other relevant details...
 210
 211    This section is a comment. do not overwrite or remove it.
 212    Also, make sure to start the actual text at the margin.
 213    =========================================================