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 * **Added generic flow API (rte_flow).**
  42
  43   This API provides a generic means to configure hardware to match specific
  44   ingress or egress traffic, alter its fate and query related counters
  45   according to any number of user-defined rules.
  46
  47   It is slightly higher-level than the legacy filtering framework which it
  48   encompasses and supersedes (including all functions and filter types) in
  49   order to expose a single interface with an unambiguous behavior that is
  50   common to all poll-mode drivers (PMDs).
  51
  52   See the :ref:`Generic flow API <Generic_flow_API>` documentation for more
  53   information.
  54
  55
  56 Resolved Issues
  57 ---------------
  58
  59 .. This section should contain bug fixes added to the relevant 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 tense.
  64      The title should contain the code/lib section like a commit message.
  65      Add the entries in alphabetic order in the relevant sections below.
  66
  67    This section is a comment. do not overwrite or remove it.
  68    Also, make sure to start the actual text at the margin.
  69    =========================================================
  70
  71
  72 EAL
  73 ~~~
  74
  75
  76 Drivers
  77 ~~~~~~~
  78
  79
  80 Libraries
  81 ~~~~~~~~~
  82
  83
  84 Examples
  85 ~~~~~~~~
  86
  87 * **examples/ethtool: Fixed crash with non-PCI devices.**
  88
  89   Querying a non-PCI device was dereferencing non-existent PCI data
  90   resulting in a segmentation fault.
  91
  92
  93 Other
  94 ~~~~~
  95
  96
  97 Known Issues
  98 ------------
  99
 100 .. This section should contain new known issues in this release. Sample format:
 101
 102    * **Add title in present tense with full stop.**
 103
 104      Add a short 1-2 sentence description of the known issue in the present
 105      tense. Add information on any known workarounds.
 106
 107    This section is a comment. do not overwrite or remove it.
 108    Also, make sure to start the actual text at the margin.
 109    =========================================================
 110
 111
 112 API Changes
 113 -----------
 114
 115 .. This section should contain API changes. Sample format:
 116
 117    * Add a short 1-2 sentence description of the API change. Use fixed width
 118      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 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 ABI Changes
 126 -----------
 127
 128 .. This section should contain ABI changes. Sample format:
 129
 130    * Add a short 1-2 sentence description of the ABI change that was announced in
 131      the previous releases and made in this release. Use fixed width quotes for
 132      ``rte_function_names`` or ``rte_struct_names``. Use the past 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
 140 Shared Library Versions
 141 -----------------------
 142
 143 .. Update any library version updated in this release and prepend with a ``+``
 144    sign, like this:
 145
 146      librte_acl.so.2
 147    + librte_cfgfile.so.2
 148      librte_cmdline.so.2
 149
 150    This section is a comment. do not overwrite or remove it.
 151    =========================================================
 152
 153
 154 The libraries prepended with a plus sign were incremented in this version.
 155
 156 .. code-block:: diff
 157
 158      librte_acl.so.2
 159      librte_cfgfile.so.2
 160      librte_cmdline.so.2
 161      librte_cryptodev.so.2
 162      librte_distributor.so.1
 163      librte_eal.so.3
 164      librte_ethdev.so.5
 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_lpm.so.2
 171      librte_mbuf.so.2
 172      librte_mempool.so.2
 173      librte_meter.so.1
 174      librte_net.so.1
 175      librte_pdump.so.1
 176      librte_pipeline.so.3
 177      librte_pmd_bond.so.1
 178      librte_pmd_ring.so.2
 179      librte_port.so.3
 180      librte_power.so.1
 181      librte_reorder.so.1
 182      librte_ring.so.1
 183      librte_sched.so.1
 184      librte_table.so.2
 185      librte_timer.so.1
 186      librte_vhost.so.3
 187
 188
 189 Tested Platforms
 190 ----------------
 191
 192 .. This section should contain a list of platforms that were tested with this release.
 193
 194    The format is:
 195
 196    #. Platform name.
 197
 198       * Platform details.
 199       * Platform details.
 200
 201    This section is a comment. do not overwrite or remove it.
 202    Also, make sure to start the actual text at the margin.
 203    =========================================================
 204
 205
 206 Tested NICs
 207 -----------
 208
 209 .. This section should contain a list of NICs that were tested with this release.
 210
 211    The format is:
 212
 213    #. NIC name.
 214
 215       * NIC details.
 216       * NIC details.
 217
 218    This section is a comment. do not overwrite or remove it.
 219    Also, make sure to start the actual text at the margin.
 220    =========================================================
 221
 222
 223 Tested OSes
 224 -----------
 225
 226 .. This section should contain a list of OSes that were tested with this release.
 227    The format is as follows, in alphabetical order:
 228
 229    * CentOS 7.0
 230    * Fedora 23
 231    * Fedora 24
 232    * FreeBSD 10.3
 233    * Red Hat Enterprise Linux 7.2
 234    * SUSE Enterprise Linux 12
 235    * Ubuntu 15.10
 236    * Ubuntu 16.04 LTS
 237    * Wind River Linux 8
 238
 239    This section is a comment. do not overwrite or remove it.
 240    Also, make sure to start the actual text at the margin.
 241    =========================================================