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 * **Increased number of next hops for LPM IPv6 to 2^21.**
  45
  46   The next_hop field is extended from 8 bits to 21 bits for IPv6.
  47
  48 * **Added powerpc support in pci probing for vfio-pci devices.**
  49
  50   sPAPR IOMMU based pci probing enabled for vfio-pci devices.
  51
  52 Resolved Issues
  53 ---------------
  54
  55 .. This section should contain bug fixes added to the relevant
  56    sections. Sample format:
  57
  58    * **code/section Fixed issue in the past tense with a full stop.**
  59
  60      Add a short 1-2 sentence description of the resolved issue in the past
  61      tense.
  62
  63      The title should contain the code/lib section like a commit message.
  64
  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
  88 Other
  89 ~~~~~
  90
  91
  92 Known Issues
  93 ------------
  94
  95 .. This section should contain new known issues in this release. Sample format:
  96
  97    * **Add title in present tense with full stop.**
  98
  99      Add a short 1-2 sentence description of the known issue in the present
 100      tense. Add information on any known workarounds.
 101
 102    This section is a comment. do not overwrite or remove it.
 103    Also, make sure to start the actual text at the margin.
 104    =========================================================
 105
 106
 107 API Changes
 108 -----------
 109
 110 .. This section should contain API changes. Sample format:
 111
 112    * Add a short 1-2 sentence description of the API change. Use fixed width
 113      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
 114      tense.
 115
 116    This section is a comment. do not overwrite or remove it.
 117    Also, make sure to start the actual text at the margin.
 118    =========================================================
 119
 120 * The LPM ``next_hop`` field is extended from 8 bits to 21 bits for IPv6
 121   while keeping ABI compatibility.
 122
 123 ABI Changes
 124 -----------
 125
 126 .. This section should contain ABI changes. Sample format:
 127
 128    * Add a short 1-2 sentence description of the ABI change that was announced
 129      in the previous releases and made in this release. Use fixed width quotes
 130      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 131
 132    This section is a comment. do not overwrite or remove it.
 133    Also, make sure to start the actual text at the margin.
 134    =========================================================
 135
 136
 137 Removed Items
 138 -------------
 139
 140 .. This section should contain removed items in this release. Sample format:
 141
 142    * Add a short 1-2 sentence description of the removed item in the past
 143      tense.
 144
 145    This section is a comment. do not overwrite or remove it.
 146    Also, make sure to start the actual text at the margin.
 147    =========================================================
 148
 149 * KNI vhost support removed.
 150
 151
 152 Shared Library Versions
 153 -----------------------
 154
 155 .. Update any library version updated in this release and prepend with a ``+``
 156    sign, like this:
 157
 158      librte_acl.so.2
 159    + librte_cfgfile.so.2
 160      librte_cmdline.so.2
 161
 162    This section is a comment. do not overwrite or remove it.
 163    =========================================================
 164
 165
 166 The libraries prepended with a plus sign were incremented in this version.
 167
 168 .. code-block:: diff
 169
 170      librte_acl.so.2
 171      librte_cfgfile.so.2
 172      librte_cmdline.so.2
 173      librte_cryptodev.so.2
 174      librte_distributor.so.1
 175      librte_eal.so.3
 176      librte_ethdev.so.6
 177      librte_hash.so.2
 178      librte_ip_frag.so.1
 179      librte_jobstats.so.1
 180      librte_kni.so.2
 181      librte_kvargs.so.1
 182      librte_lpm.so.2
 183      librte_mbuf.so.2
 184      librte_mempool.so.2
 185      librte_meter.so.1
 186      librte_net.so.1
 187      librte_pdump.so.1
 188      librte_pipeline.so.3
 189      librte_pmd_bond.so.1
 190      librte_pmd_ring.so.2
 191      librte_port.so.3
 192      librte_power.so.1
 193      librte_reorder.so.1
 194      librte_ring.so.1
 195      librte_sched.so.1
 196      librte_table.so.2
 197      librte_timer.so.1
 198      librte_vhost.so.3
 199
 200
 201 Tested Platforms
 202 ----------------
 203
 204 .. This section should contain a list of platforms that were tested with this
 205    release.
 206
 207    The format is:
 208
 209    * <vendor> platform with <vendor> <type of devices> combinations
 210
 211      * List of CPU
 212      * List of OS
 213      * List of devices
 214      * Other relevant details...
 215
 216    This section is a comment. do not overwrite or remove it.
 217    Also, make sure to start the actual text at the margin.
 218    =========================================================