doc/guides/rel_notes/release_17_11.rst

   1 DPDK Release 17.11
   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_11.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 * **nfp: Added PF support.**
  45
  46   Previously Netronome's NFP PMD had just support for VFs. PF support is
  47   just as a basic DPDK port and has no VF management yet.
  48
  49   PF support comes with firmware upload support which allows the PMD to
  50   independently work from kernel netdev NFP drivers.
  51
  52   NFP 4000 devices are also now supported along with previous 6000 devices.
  53
  54 * **Updated bnxt PMD.**
  55
  56   Major enhancements include:
  57
  58    * Support for Flow API
  59    * Support for Tx and Rx descriptor status functions
  60
  61
  62 Resolved Issues
  63 ---------------
  64
  65 .. This section should contain bug fixes added to the relevant
  66    sections. Sample format:
  67
  68    * **code/section Fixed issue in the past tense with a full stop.**
  69
  70      Add a short 1-2 sentence description of the resolved issue in the past
  71      tense.
  72
  73      The title should contain the code/lib section like a commit message.
  74
  75      Add the entries in alphabetic order in the relevant sections below.
  76
  77    This section is a comment. do not overwrite or remove it.
  78    Also, make sure to start the actual text at the margin.
  79    =========================================================
  80
  81
  82 EAL
  83 ~~~
  84
  85 * **Service core fails to call service callback due to atomic lock**
  86
  87   In a specific configuration of multi-thread unsafe services and service
  88   cores, a service core previously did not correctly release the atomic lock
  89   on the service. This would result in the cores polling the service, but it
  90   looked like another thread was executing the service callback. The logic for
  91   atomic locking of the services has been fixed and refactored for readability.
  92
  93 Drivers
  94 ~~~~~~~
  95
  96
  97 Libraries
  98 ~~~~~~~~~
  99
 100
 101 Examples
 102 ~~~~~~~~
 103
 104
 105 Other
 106 ~~~~~
 107
 108
 109 Known Issues
 110 ------------
 111
 112 .. This section should contain new known issues in this release. Sample format:
 113
 114    * **Add title in present tense with full stop.**
 115
 116      Add a short 1-2 sentence description of the known issue in the present
 117      tense. Add information on any known workarounds.
 118
 119    This section is a comment. do not overwrite or remove it.
 120    Also, make sure to start the actual text at the margin.
 121    =========================================================
 122
 123
 124 API Changes
 125 -----------
 126
 127 .. This section should contain API changes. Sample format:
 128
 129    * Add a short 1-2 sentence description of the API change. Use fixed width
 130      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
 131      tense.
 132
 133    This section is a comment. do not overwrite or remove it.
 134    Also, make sure to start the actual text at the margin.
 135    =========================================================
 136
 137 * **Service cores API updated for usability**
 138
 139   The service cores API has been changed, removing pointers from the API
 140   where possible, instead using integer IDs to identify each service. This
 141   simplifed application code, aids debugging, and provides better
 142   encapsulation. A summary of the main changes made is as follows:
 143
 144   * Services identified by ID not by ``rte_service_spec`` pointer
 145   * Reduced API surface by using ``set`` functions instead of enable/disable
 146   * Reworked ``rte_service_register`` to provide the service ID to registrar
 147   * Rework start and stop APIs into ``rte_service_runstate_set``
 148   * Added API to set runstate of service implementation to indicate readyness
 149
 150
 151 ABI Changes
 152 -----------
 153
 154 .. This section should contain ABI changes. Sample format:
 155
 156    * Add a short 1-2 sentence description of the ABI change that was announced
 157      in the previous releases and made in this release. Use fixed width quotes
 158      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 159
 160    This section is a comment. do not overwrite or remove it.
 161    Also, make sure to start the actual text at the margin.
 162    =========================================================
 163
 164
 165
 166 Shared Library Versions
 167 -----------------------
 168
 169 .. Update any library version updated in this release and prepend with a ``+``
 170    sign, like this:
 171
 172      librte_acl.so.2
 173    + librte_cfgfile.so.2
 174      librte_cmdline.so.2
 175
 176    This section is a comment. do not overwrite or remove it.
 177    =========================================================
 178
 179
 180 The libraries prepended with a plus sign were incremented in this version.
 181
 182 .. code-block:: diff
 183
 184      librte_acl.so.2
 185      librte_bitratestats.so.1
 186      librte_cfgfile.so.2
 187      librte_cmdline.so.2
 188      librte_cryptodev.so.3
 189      librte_distributor.so.1
 190      librte_eal.so.5
 191      librte_ethdev.so.7
 192      librte_eventdev.so.2
 193      librte_gro.so.1
 194      librte_hash.so.2
 195      librte_ip_frag.so.1
 196      librte_jobstats.so.1
 197      librte_kni.so.2
 198      librte_kvargs.so.1
 199      librte_latencystats.so.1
 200      librte_lpm.so.2
 201      librte_mbuf.so.3
 202      librte_mempool.so.2
 203      librte_meter.so.1
 204      librte_metrics.so.1
 205      librte_net.so.1
 206      librte_pdump.so.1
 207      librte_pipeline.so.3
 208      librte_pmd_bnxt.so.1
 209      librte_pmd_bond.so.1
 210      librte_pmd_i40e.so.1
 211      librte_pmd_ixgbe.so.1
 212      librte_pmd_ring.so.2
 213      librte_pmd_vhost.so.1
 214      librte_port.so.3
 215      librte_power.so.1
 216      librte_reorder.so.1
 217      librte_ring.so.1
 218      librte_sched.so.1
 219      librte_table.so.2
 220      librte_timer.so.1
 221      librte_vhost.so.3
 222
 223
 224 Tested Platforms
 225 ----------------
 226
 227 .. This section should contain a list of platforms that were tested with this
 228    release.
 229
 230    The format is:
 231
 232    * <vendor> platform with <vendor> <type of devices> combinations
 233
 234      * List of CPU
 235      * List of OS
 236      * List of devices
 237      * Other relevant details...
 238
 239    This section is a comment. do not overwrite or remove it.
 240    Also, make sure to start the actual text at the margin.
 241    =========================================================