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 * **Added APIs for MACsec offload support to the ixgbe PMD.**
  56
  57   Six new APIs have been added to the ixgbe PMD for MACsec offload support.
  58   The declarations for the APIs can be found in ``rte_pmd_ixgbe.h``.
  59
  60
  61 Resolved Issues
  62 ---------------
  63
  64 .. This section should contain bug fixes added to the relevant sections. Sample format:
  65
  66    * **code/section Fixed issue in the past tense with a full stop.**
  67
  68      Add a short 1-2 sentence description of the resolved issue in the past tense.
  69      The title should contain the code/lib section like a commit message.
  70      Add the entries in alphabetic order in the relevant sections below.
  71
  72    This section is a comment. do not overwrite or remove it.
  73    Also, make sure to start the actual text at the margin.
  74    =========================================================
  75
  76
  77 EAL
  78 ~~~
  79
  80
  81 Drivers
  82 ~~~~~~~
  83
  84
  85 Libraries
  86 ~~~~~~~~~
  87
  88
  89 Examples
  90 ~~~~~~~~
  91
  92 * **examples/ethtool: Fixed crash with non-PCI devices.**
  93
  94   Querying a non-PCI device was dereferencing non-existent PCI data
  95   resulting in a segmentation fault.
  96
  97
  98 Other
  99 ~~~~~
 100
 101
 102 Known Issues
 103 ------------
 104
 105 .. This section should contain new known issues in this release. Sample format:
 106
 107    * **Add title in present tense with full stop.**
 108
 109      Add a short 1-2 sentence description of the known issue in the present
 110      tense. Add information on any known workarounds.
 111
 112    This section is a comment. do not overwrite or remove it.
 113    Also, make sure to start the actual text at the margin.
 114    =========================================================
 115
 116
 117 API Changes
 118 -----------
 119
 120 .. This section should contain API changes. Sample format:
 121
 122    * Add a short 1-2 sentence description of the API change. Use fixed width
 123      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 124
 125    This section is a comment. do not overwrite or remove it.
 126    Also, make sure to start the actual text at the margin.
 127    =========================================================
 128
 129
 130 ABI Changes
 131 -----------
 132
 133 .. This section should contain ABI changes. Sample format:
 134
 135    * Add a short 1-2 sentence description of the ABI change that was announced in
 136      the previous releases and made in this release. Use fixed width quotes for
 137      ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 138
 139    This section is a comment. do not overwrite or remove it.
 140    Also, make sure to start the actual text at the margin.
 141    =========================================================
 142
 143
 144
 145 Shared Library Versions
 146 -----------------------
 147
 148 .. Update any library version updated in this release and prepend with a ``+``
 149    sign, like this:
 150
 151      librte_acl.so.2
 152    + librte_cfgfile.so.2
 153      librte_cmdline.so.2
 154
 155    This section is a comment. do not overwrite or remove it.
 156    =========================================================
 157
 158
 159 The libraries prepended with a plus sign were incremented in this version.
 160
 161 .. code-block:: diff
 162
 163      librte_acl.so.2
 164      librte_cfgfile.so.2
 165      librte_cmdline.so.2
 166      librte_cryptodev.so.2
 167      librte_distributor.so.1
 168      librte_eal.so.3
 169      librte_ethdev.so.5
 170      librte_hash.so.2
 171      librte_ip_frag.so.1
 172      librte_jobstats.so.1
 173      librte_kni.so.2
 174      librte_kvargs.so.1
 175      librte_lpm.so.2
 176      librte_mbuf.so.2
 177      librte_mempool.so.2
 178      librte_meter.so.1
 179      librte_net.so.1
 180      librte_pdump.so.1
 181      librte_pipeline.so.3
 182      librte_pmd_bond.so.1
 183      librte_pmd_ring.so.2
 184      librte_port.so.3
 185      librte_power.so.1
 186      librte_reorder.so.1
 187      librte_ring.so.1
 188      librte_sched.so.1
 189      librte_table.so.2
 190      librte_timer.so.1
 191      librte_vhost.so.3
 192
 193
 194 Tested Platforms
 195 ----------------
 196
 197 .. This section should contain a list of platforms that were tested with this release.
 198
 199    The format is:
 200
 201    #. Platform name.
 202
 203       * Platform details.
 204       * Platform 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    =========================================================
 209
 210
 211 Tested NICs
 212 -----------
 213
 214 .. This section should contain a list of NICs that were tested with this release.
 215
 216    The format is:
 217
 218    #. NIC name.
 219
 220       * NIC details.
 221       * NIC details.
 222
 223    This section is a comment. do not overwrite or remove it.
 224    Also, make sure to start the actual text at the margin.
 225    =========================================================
 226
 227
 228 Tested OSes
 229 -----------
 230
 231 .. This section should contain a list of OSes that were tested with this release.
 232    The format is as follows, in alphabetical order:
 233
 234    * CentOS 7.0
 235    * Fedora 23
 236    * Fedora 24
 237    * FreeBSD 10.3
 238    * Red Hat Enterprise Linux 7.2
 239    * SUSE Enterprise Linux 12
 240    * Ubuntu 15.10
 241    * Ubuntu 16.04 LTS
 242    * Wind River Linux 8
 243
 244    This section is a comment. do not overwrite or remove it.
 245    Also, make sure to start the actual text at the margin.
 246    =========================================================