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