doc/guides/rel_notes/release_17_02.rst

   1 DPDK Release 17.02
   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_17_02.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      This section is a comment. do not overwrite or remove it.
  38      Also, make sure to start the actual text at the margin.
  39      =========================================================
  40
  41
  42 Resolved Issues
  43 ---------------
  44
  45 .. This section should contain bug fixes added to the relevant sections. Sample format:
  46
  47    * **code/section Fixed issue in the past tense with a full stop.**
  48
  49      Add a short 1-2 sentence description of the resolved issue in the past tense.
  50      The title should contain the code/lib section like a commit message.
  51      Add the entries in alphabetic order in the relevant sections below.
  52
  53    This section is a comment. do not overwrite or remove it.
  54    Also, make sure to start the actual text at the margin.
  55    =========================================================
  56
  57
  58 EAL
  59 ~~~
  60
  61
  62 Drivers
  63 ~~~~~~~
  64
  65
  66 Libraries
  67 ~~~~~~~~~
  68
  69
  70 Examples
  71 ~~~~~~~~
  72
  73
  74 Other
  75 ~~~~~
  76
  77
  78 Known Issues
  79 ------------
  80
  81 .. This section should contain new known issues in this release. Sample format:
  82
  83    * **Add title in present tense with full stop.**
  84
  85      Add a short 1-2 sentence description of the known issue in the present
  86      tense. Add information on any known workarounds.
  87
  88    This section is a comment. do not overwrite or remove it.
  89    Also, make sure to start the actual text at the margin.
  90    =========================================================
  91
  92
  93 API Changes
  94 -----------
  95
  96 .. This section should contain API changes. Sample format:
  97
  98    * Add a short 1-2 sentence description of the API change. Use fixed width
  99      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 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 ABI Changes
 107 -----------
 108
 109 .. This section should contain ABI changes. Sample format:
 110
 111    * Add a short 1-2 sentence description of the ABI change that was announced in
 112      the previous releases and made in this release. Use fixed width quotes for
 113      ``rte_function_names`` or ``rte_struct_names``. Use the past 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
 121 Shared Library Versions
 122 -----------------------
 123
 124 .. Update any library version updated in this release and prepend with a ``+``
 125    sign, like this:
 126
 127      librte_acl.so.2
 128    + librte_cfgfile.so.2
 129      librte_cmdline.so.2
 130
 131    This section is a comment. do not overwrite or remove it.
 132    =========================================================
 133
 134
 135 The libraries prepended with a plus sign were incremented in this version.
 136
 137 .. code-block:: diff
 138
 139      librte_acl.so.2
 140      librte_cfgfile.so.2
 141      librte_cmdline.so.2
 142      librte_cryptodev.so.2
 143      librte_distributor.so.1
 144      librte_eal.so.3
 145      librte_ethdev.so.5
 146      librte_hash.so.2
 147      librte_ip_frag.so.1
 148      librte_jobstats.so.1
 149      librte_kni.so.2
 150      librte_kvargs.so.1
 151      librte_lpm.so.2
 152      librte_mbuf.so.2
 153      librte_mempool.so.2
 154      librte_meter.so.1
 155      librte_net.so.1
 156      librte_pdump.so.1
 157      librte_pipeline.so.3
 158      librte_pmd_bond.so.1
 159      librte_pmd_ring.so.2
 160      librte_port.so.3
 161      librte_power.so.1
 162      librte_reorder.so.1
 163      librte_ring.so.1
 164      librte_sched.so.1
 165      librte_table.so.2
 166      librte_timer.so.1
 167      librte_vhost.so.3
 168
 169
 170 Tested Platforms
 171 ----------------
 172
 173 .. This section should contain a list of platforms that were tested with this release.
 174
 175    The format is:
 176
 177    #. Platform name.
 178
 179       * Platform details.
 180       * Platform details.
 181
 182    This section is a comment. do not overwrite or remove it.
 183    Also, make sure to start the actual text at the margin.
 184    =========================================================
 185
 186
 187 Tested NICs
 188 -----------
 189
 190 .. This section should contain a list of NICs that were tested with this release.
 191
 192    The format is:
 193
 194    #. NIC name.
 195
 196       * NIC details.
 197       * NIC details.
 198
 199    This section is a comment. do not overwrite or remove it.
 200    Also, make sure to start the actual text at the margin.
 201    =========================================================
 202
 203
 204 Tested OSes
 205 -----------
 206
 207 .. This section should contain a list of OSes that were tested with this release.
 208    The format is as follows, in alphabetical order:
 209
 210    * CentOS 7.0
 211    * Fedora 23
 212    * Fedora 24
 213    * FreeBSD 10.3
 214    * Red Hat Enterprise Linux 7.2
 215    * SUSE Enterprise Linux 12
 216    * Ubuntu 15.10
 217    * Ubuntu 16.04 LTS
 218    * Wind River Linux 8
 219
 220    This section is a comment. do not overwrite or remove it.
 221    Also, make sure to start the actual text at the margin.
 222    =========================================================