doc/guides/rel_notes/release_17_05.rst

   1 DPDK Release 17.05
   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_05.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 free Tx mbuf on demand API.**
  45
  46   Added a new function ``rte_eth_tx_done_cleanup()`` which allows an application
  47   to request the driver to release mbufs from their Tx ring that are no longer
  48   in use, independent of whether or not the ``tx_rs_thresh`` has been crossed.
  49
  50 * **Increased number of next hops for LPM IPv6 to 2^21.**
  51
  52   The next_hop field is extended from 8 bits to 21 bits for IPv6.
  53
  54 * **Added powerpc support in pci probing for vfio-pci devices.**
  55
  56   sPAPR IOMMU based pci probing enabled for vfio-pci devices.
  57
  58
  59 Resolved Issues
  60 ---------------
  61
  62 .. This section should contain bug fixes added to the relevant
  63    sections. Sample format:
  64
  65    * **code/section Fixed issue in the past tense with a full stop.**
  66
  67      Add a short 1-2 sentence description of the resolved issue in the past
  68      tense.
  69
  70      The title should contain the code/lib section like a commit message.
  71
  72      Add the entries in alphabetic order in the relevant sections below.
  73
  74    This section is a comment. do not overwrite or remove it.
  75    Also, make sure to start the actual text at the margin.
  76    =========================================================
  77
  78
  79 EAL
  80 ~~~
  81
  82
  83 Drivers
  84 ~~~~~~~
  85
  86
  87 Libraries
  88 ~~~~~~~~~
  89
  90
  91 Examples
  92 ~~~~~~~~
  93
  94
  95 Other
  96 ~~~~~
  97
  98
  99 Known Issues
 100 ------------
 101
 102 .. This section should contain new known issues in this release. Sample format:
 103
 104    * **Add title in present tense with full stop.**
 105
 106      Add a short 1-2 sentence description of the known issue in the present
 107      tense. Add information on any known workarounds.
 108
 109    This section is a comment. do not overwrite or remove it.
 110    Also, make sure to start the actual text at the margin.
 111    =========================================================
 112
 113
 114 API Changes
 115 -----------
 116
 117 .. This section should contain API changes. Sample format:
 118
 119    * Add a short 1-2 sentence description of the API change. Use fixed width
 120      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
 121      tense.
 122
 123    This section is a comment. do not overwrite or remove it.
 124    Also, make sure to start the actual text at the margin.
 125    =========================================================
 126
 127 * The LPM ``next_hop`` field is extended from 8 bits to 21 bits for IPv6
 128   while keeping ABI compatibility.
 129
 130 * **Reworked rte_ring library**
 131
 132   The rte_ring library has been reworked and updated. The following changes
 133   have been made to it:
 134
 135   * removed the build-time setting ``CONFIG_RTE_RING_SPLIT_PROD_CONS``
 136   * removed the build-time setting ``CONFIG_RTE_LIBRTE_RING_DEBUG``
 137   * removed the build-time setting ``CONFIG_RTE_RING_PAUSE_REP_COUNT``
 138   * removed the function ``rte_ring_set_water_mark`` as part of a general
 139     removal of watermarks support in the library.
 140
 141 ABI Changes
 142 -----------
 143
 144 .. This section should contain ABI changes. Sample format:
 145
 146    * Add a short 1-2 sentence description of the ABI change that was announced
 147      in the previous releases and made in this release. Use fixed width quotes
 148      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 149
 150    This section is a comment. do not overwrite or remove it.
 151    Also, make sure to start the actual text at the margin.
 152    =========================================================
 153
 154
 155 Removed Items
 156 -------------
 157
 158 .. This section should contain removed items in this release. Sample format:
 159
 160    * Add a short 1-2 sentence description of the removed item in the past
 161      tense.
 162
 163    This section is a comment. do not overwrite or remove it.
 164    Also, make sure to start the actual text at the margin.
 165    =========================================================
 166
 167 * KNI vhost support removed.
 168
 169
 170 Shared Library Versions
 171 -----------------------
 172
 173 .. Update any library version updated in this release and prepend with a ``+``
 174    sign, like this:
 175
 176      librte_acl.so.2
 177    + librte_cfgfile.so.2
 178      librte_cmdline.so.2
 179
 180    This section is a comment. do not overwrite or remove it.
 181    =========================================================
 182
 183
 184 The libraries prepended with a plus sign were incremented in this version.
 185
 186 .. code-block:: diff
 187
 188      librte_acl.so.2
 189      librte_cfgfile.so.2
 190      librte_cmdline.so.2
 191      librte_cryptodev.so.2
 192      librte_distributor.so.1
 193      librte_eal.so.3
 194      librte_ethdev.so.6
 195      librte_hash.so.2
 196      librte_ip_frag.so.1
 197      librte_jobstats.so.1
 198      librte_kni.so.2
 199      librte_kvargs.so.1
 200      librte_lpm.so.2
 201      librte_mbuf.so.2
 202      librte_mempool.so.2
 203      librte_meter.so.1
 204      librte_net.so.1
 205      librte_pdump.so.1
 206      librte_pipeline.so.3
 207      librte_pmd_bond.so.1
 208      librte_pmd_ring.so.2
 209      librte_port.so.3
 210      librte_power.so.1
 211      librte_reorder.so.1
 212      librte_ring.so.1
 213      librte_sched.so.1
 214      librte_table.so.2
 215      librte_timer.so.1
 216      librte_vhost.so.3
 217
 218
 219 Tested Platforms
 220 ----------------
 221
 222 .. This section should contain a list of platforms that were tested with this
 223    release.
 224
 225    The format is:
 226
 227    * <vendor> platform with <vendor> <type of devices> combinations
 228
 229      * List of CPU
 230      * List of OS
 231      * List of devices
 232      * Other relevant details...
 233
 234    This section is a comment. do not overwrite or remove it.
 235    Also, make sure to start the actual text at the margin.
 236    =========================================================