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 * **Updated bnxt PMD.**
  60
  61   Major enhancements include:
  62   * Support MTU modification.
  63   * Support LRO.
  64   * Support VLAN filter and strip functionality.
  65   * Other enhancements to add support for more dev_ops.
  66   * Add PMD specific APIs mainly to control VF from PF.
  67   * Update HWRM version to 1.7.7
  68
  69
  70 Resolved Issues
  71 ---------------
  72
  73 .. This section should contain bug fixes added to the relevant
  74    sections. Sample format:
  75
  76    * **code/section Fixed issue in the past tense with a full stop.**
  77
  78      Add a short 1-2 sentence description of the resolved issue in the past
  79      tense.
  80
  81      The title should contain the code/lib section like a commit message.
  82
  83      Add the entries in alphabetic order in the relevant sections below.
  84
  85    This section is a comment. do not overwrite or remove it.
  86    Also, make sure to start the actual text at the margin.
  87    =========================================================
  88
  89
  90 EAL
  91 ~~~
  92
  93
  94 Drivers
  95 ~~~~~~~
  96
  97
  98 Libraries
  99 ~~~~~~~~~
 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    This section is a comment. do not overwrite or remove it.
 121    Also, make sure to start the actual text at the margin.
 122    =========================================================
 123
 124
 125 API Changes
 126 -----------
 127
 128 .. This section should contain API changes. Sample format:
 129
 130    * Add a short 1-2 sentence description of the API change. Use fixed width
 131      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
 132      tense.
 133
 134    This section is a comment. do not overwrite or remove it.
 135    Also, make sure to start the actual text at the margin.
 136    =========================================================
 137
 138
 139 ABI Changes
 140 -----------
 141
 142 .. This section should contain ABI changes. Sample format:
 143
 144    * Add a short 1-2 sentence description of the ABI change that was announced
 145      in the previous releases and made in this release. Use fixed width quotes
 146      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 147
 148    This section is a comment. do not overwrite or remove it.
 149    Also, make sure to start the actual text at the margin.
 150    =========================================================
 151
 152
 153
 154 Shared Library Versions
 155 -----------------------
 156
 157 .. Update any library version updated in this release and prepend with a ``+``
 158    sign, like this:
 159
 160      librte_acl.so.2
 161    + librte_cfgfile.so.2
 162      librte_cmdline.so.2
 163
 164    This section is a comment. do not overwrite or remove it.
 165    =========================================================
 166
 167
 168 The libraries prepended with a plus sign were incremented in this version.
 169
 170 .. code-block:: diff
 171
 172      librte_acl.so.2
 173      librte_bitratestats.so.1
 174      librte_cfgfile.so.2
 175      librte_cmdline.so.2
 176      librte_cryptodev.so.2
 177      librte_distributor.so.1
 178      librte_eal.so.4
 179      librte_ethdev.so.6
 180      librte_hash.so.2
 181      librte_ip_frag.so.1
 182      librte_jobstats.so.1
 183      librte_kni.so.2
 184      librte_kvargs.so.1
 185      librte_latencystats.so.1
 186      librte_lpm.so.2
 187      librte_mbuf.so.3
 188      librte_mempool.so.2
 189      librte_meter.so.1
 190      librte_metrics.so.1
 191      librte_net.so.1
 192      librte_pdump.so.1
 193      librte_pipeline.so.3
 194      librte_pmd_bond.so.1
 195      librte_pmd_ring.so.2
 196      librte_port.so.3
 197      librte_power.so.1
 198      librte_reorder.so.1
 199      librte_ring.so.1
 200      librte_sched.so.1
 201      librte_table.so.2
 202      librte_timer.so.1
 203      librte_vhost.so.3
 204
 205
 206 Tested Platforms
 207 ----------------
 208
 209 .. This section should contain a list of platforms that were tested with this
 210    release.
 211
 212    The format is:
 213
 214    * <vendor> platform with <vendor> <type of devices> combinations
 215
 216      * List of CPU
 217      * List of OS
 218      * List of devices
 219      * Other relevant details...
 220
 221    This section is a comment. do not overwrite or remove it.
 222    Also, make sure to start the actual text at the margin.
 223    =========================================================