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