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
  45 Resolved Issues
  46 ---------------
  47
  48 .. This section should contain bug fixes added to the relevant
  49    sections. Sample format:
  50
  51    * **code/section Fixed issue in the past tense with a full stop.**
  52
  53      Add a short 1-2 sentence description of the resolved issue in the past
  54      tense.
  55
  56      The title should contain the code/lib section like a commit message.
  57
  58      Add the entries in alphabetic order in the relevant sections below.
  59
  60    This section is a comment. do not overwrite or remove it.
  61    Also, make sure to start the actual text at the margin.
  62    =========================================================
  63
  64
  65 EAL
  66 ~~~
  67
  68 * **Service core fails to call service callback due to atomic lock**
  69
  70   In a specific configuration of multi-thread unsafe services and service
  71   cores, a service core previously did not correctly release the atomic lock
  72   on the service. This would result in the cores polling the service, but it
  73   looked like another thread was executing the service callback. The logic for
  74   atomic locking of the services has been fixed and refactored for readability.
  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
 121 ABI Changes
 122 -----------
 123
 124 .. This section should contain ABI changes. Sample format:
 125
 126    * Add a short 1-2 sentence description of the ABI change that was announced
 127      in the previous releases and made in this release. Use fixed width quotes
 128      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
 136 Shared Library Versions
 137 -----------------------
 138
 139 .. Update any library version updated in this release and prepend with a ``+``
 140    sign, like this:
 141
 142      librte_acl.so.2
 143    + librte_cfgfile.so.2
 144      librte_cmdline.so.2
 145
 146    This section is a comment. do not overwrite or remove it.
 147    =========================================================
 148
 149
 150 The libraries prepended with a plus sign were incremented in this version.
 151
 152 .. code-block:: diff
 153
 154      librte_acl.so.2
 155      librte_bitratestats.so.1
 156      librte_cfgfile.so.2
 157      librte_cmdline.so.2
 158      librte_cryptodev.so.3
 159      librte_distributor.so.1
 160      librte_eal.so.5
 161      librte_ethdev.so.7
 162      librte_eventdev.so.2
 163      librte_gro.so.1
 164      librte_hash.so.2
 165      librte_ip_frag.so.1
 166      librte_jobstats.so.1
 167      librte_kni.so.2
 168      librte_kvargs.so.1
 169      librte_latencystats.so.1
 170      librte_lpm.so.2
 171      librte_mbuf.so.3
 172      librte_mempool.so.2
 173      librte_meter.so.1
 174      librte_metrics.so.1
 175      librte_net.so.1
 176      librte_pdump.so.1
 177      librte_pipeline.so.3
 178      librte_pmd_bond.so.1
 179      librte_pmd_ring.so.2
 180      librte_port.so.3
 181      librte_power.so.1
 182      librte_reorder.so.1
 183      librte_ring.so.1
 184      librte_sched.so.1
 185      librte_table.so.2
 186      librte_timer.so.1
 187      librte_vhost.so.3
 188
 189
 190 Tested Platforms
 191 ----------------
 192
 193 .. This section should contain a list of platforms that were tested with this
 194    release.
 195
 196    The format is:
 197
 198    * <vendor> platform with <vendor> <type of devices> combinations
 199
 200      * List of CPU
 201      * List of OS
 202      * List of devices
 203      * Other relevant details...
 204
 205    This section is a comment. do not overwrite or remove it.
 206    Also, make sure to start the actual text at the margin.
 207    =========================================================