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