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
  55 Resolved Issues
  56 ---------------
  57
  58 .. This section should contain bug fixes added to the relevant
  59    sections. Sample format:
  60
  61    * **code/section Fixed issue in the past tense with a full stop.**
  62
  63      Add a short 1-2 sentence description of the resolved issue in the past
  64      tense.
  65
  66      The title should contain the code/lib section like a commit message.
  67
  68      Add the entries in alphabetic order in the relevant sections below.
  69
  70    This section is a comment. do not overwrite or remove it.
  71    Also, make sure to start the actual text at the margin.
  72    =========================================================
  73
  74
  75 EAL
  76 ~~~
  77
  78
  79 Drivers
  80 ~~~~~~~
  81
  82
  83 Libraries
  84 ~~~~~~~~~
  85
  86
  87 Examples
  88 ~~~~~~~~
  89
  90
  91 Other
  92 ~~~~~
  93
  94
  95 Known Issues
  96 ------------
  97
  98 .. This section should contain new known issues in this release. Sample format:
  99
 100    * **Add title in present tense with full stop.**
 101
 102      Add a short 1-2 sentence description of the known issue in the present
 103      tense. Add information on any known workarounds.
 104
 105    This section is a comment. do not overwrite or remove it.
 106    Also, make sure to start the actual text at the margin.
 107    =========================================================
 108
 109
 110 API Changes
 111 -----------
 112
 113 .. This section should contain API changes. Sample format:
 114
 115    * Add a short 1-2 sentence description of the API change. Use fixed width
 116      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
 117      tense.
 118
 119    This section is a comment. do not overwrite or remove it.
 120    Also, make sure to start the actual text at the margin.
 121    =========================================================
 122
 123
 124 ABI Changes
 125 -----------
 126
 127 .. This section should contain ABI changes. Sample format:
 128
 129    * Add a short 1-2 sentence description of the ABI change that was announced
 130      in the previous releases and made in this release. Use fixed width quotes
 131      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 132
 133    This section is a comment. do not overwrite or remove it.
 134    Also, make sure to start the actual text at the margin.
 135    =========================================================
 136
 137
 138
 139 Shared Library Versions
 140 -----------------------
 141
 142 .. Update any library version updated in this release and prepend with a ``+``
 143    sign, like this:
 144
 145      librte_acl.so.2
 146    + librte_cfgfile.so.2
 147      librte_cmdline.so.2
 148
 149    This section is a comment. do not overwrite or remove it.
 150    =========================================================
 151
 152
 153 The libraries prepended with a plus sign were incremented in this version.
 154
 155 .. code-block:: diff
 156
 157      librte_acl.so.2
 158      librte_bitratestats.so.1
 159      librte_cfgfile.so.2
 160      librte_cmdline.so.2
 161      librte_cryptodev.so.2
 162      librte_distributor.so.1
 163      librte_eal.so.4
 164      librte_ethdev.so.6
 165      librte_hash.so.2
 166      librte_ip_frag.so.1
 167      librte_jobstats.so.1
 168      librte_kni.so.2
 169      librte_kvargs.so.1
 170      librte_latencystats.so.1
 171      librte_lpm.so.2
 172      librte_mbuf.so.3
 173      librte_mempool.so.2
 174      librte_meter.so.1
 175      librte_metrics.so.1
 176      librte_net.so.1
 177      librte_pdump.so.1
 178      librte_pipeline.so.3
 179      librte_pmd_bond.so.1
 180      librte_pmd_ring.so.2
 181      librte_port.so.3
 182      librte_power.so.1
 183      librte_reorder.so.1
 184      librte_ring.so.1
 185      librte_sched.so.1
 186      librte_table.so.2
 187      librte_timer.so.1
 188      librte_vhost.so.3
 189
 190
 191 Tested Platforms
 192 ----------------
 193
 194 .. This section should contain a list of platforms that were tested with this
 195    release.
 196
 197    The format is:
 198
 199    * <vendor> platform with <vendor> <type of devices> combinations
 200
 201      * List of CPU
 202      * List of OS
 203      * List of devices
 204      * Other relevant details...
 205
 206    This section is a comment. do not overwrite or remove it.
 207    Also, make sure to start the actual text at the margin.
 208    =========================================================