doc/guides/rel_notes/release_16_11.rst

   1 DPDK Release 16.11
   2 ==================
   3
   4 .. **Read this first.**
   5
   6    The text 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: ``LIKE_THIS``.
  11
  12    Build the docs and view the output file to ensure the changes are correct::
  13
  14       make doc-guides-html
  15
  16       firefox build/doc/html/guides/rel_notes/release_16_11.html
  17
  18
  19 New Features
  20 ------------
  21
  22 .. This section should contain new features added in this release. Sample format:
  23
  24    * **Add a title in the past tense with a full stop.**
  25
  26      Add a short 1-2 sentence description in the past tense. The description
  27      should be enough to allow someone scanning the release notes to understand
  28      the new feature.
  29
  30      If the feature adds a lot of sub-features you can use a bullet list like this.
  31
  32      * Added feature foo to do something.
  33      * Enhanced feature bar to do something else.
  34
  35      Refer to the previous release notes for examples.
  36
  37      This section is a comment. Make sure to start the actual text at the margin.
  38
  39
  40 Resolved Issues
  41 ---------------
  42
  43 .. This section should contain bug fixes added to the relevant sections. Sample format:
  44
  45    * **code/section Fixed issue in the past tense with a full stop.**
  46
  47      Add a short 1-2 sentence description of the resolved issue in the past tense.
  48      The title should contain the code/lib section like a commit message.
  49      Add the entries in alphabetic order in the relevant sections below.
  50
  51    This section is a comment. Make sure to start the actual text at the margin.
  52
  53
  54 EAL
  55 ~~~
  56
  57
  58 Drivers
  59 ~~~~~~~
  60
  61
  62 Libraries
  63 ~~~~~~~~~
  64
  65
  66 Examples
  67 ~~~~~~~~
  68
  69
  70 Other
  71 ~~~~~
  72
  73
  74 Known Issues
  75 ------------
  76
  77 .. This section should contain new known issues in this release. Sample format:
  78
  79    * **Add title in present tense with full stop.**
  80
  81      Add a short 1-2 sentence description of the known issue in the present
  82      tense. Add information on any known workarounds.
  83
  84    This section is a comment. Make sure to start the actual text at the margin.
  85
  86
  87 API Changes
  88 -----------
  89
  90 .. This section should contain API changes. Sample format:
  91
  92    * Add a short 1-2 sentence description of the API change. Use fixed width
  93      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
  94
  95    This section is a comment. Make sure to start the actual text at the margin.
  96
  97
  98 ABI Changes
  99 -----------
 100
 101 .. This section should contain ABI changes. Sample format:
 102
 103    * Add a short 1-2 sentence description of the ABI change that was announced in
 104      the previous releases and made in this release. Use fixed width quotes for
 105      ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 106
 107    This section is a comment. Make sure to start the actual text at the margin.
 108
 109
 110
 111 Shared Library Versions
 112 -----------------------
 113
 114 .. Update any library version updated in this release and prepend with a ``+``
 115    sign, like this:
 116
 117      libethdev.so.4
 118      librte_acl.so.2
 119    + librte_cfgfile.so.2
 120      librte_cmdline.so.2
 121
 122
 123
 124 The libraries prepended with a plus sign were incremented in this version.
 125
 126 .. code-block:: diff
 127
 128      libethdev.so.4
 129      librte_acl.so.2
 130      librte_cfgfile.so.2
 131      librte_cmdline.so.2
 132      librte_cryptodev.so.1
 133      librte_distributor.so.1
 134      librte_eal.so.2
 135      librte_hash.so.2
 136      librte_ip_frag.so.1
 137      librte_ivshmem.so.1
 138      librte_jobstats.so.1
 139      librte_kni.so.2
 140      librte_kvargs.so.1
 141      librte_lpm.so.2
 142      librte_mbuf.so.2
 143      librte_mempool.so.2
 144      librte_meter.so.1
 145      librte_pdump.so.1
 146      librte_pipeline.so.3
 147      librte_pmd_bond.so.1
 148      librte_pmd_ring.so.2
 149      librte_port.so.3
 150      librte_power.so.1
 151      librte_reorder.so.1
 152      librte_ring.so.1
 153      librte_sched.so.1
 154      librte_table.so.2
 155      librte_timer.so.1
 156      librte_vhost.so.3
 157
 158
 159 Tested Platforms
 160 ----------------
 161
 162 .. This section should contain a list of platforms that were tested with this release.
 163
 164    The format is:
 165
 166    #. Platform name.
 167
 168       * Platform details.
 169       * Platform details.
 170
 171    This section is a comment. Make sure to start the actual text at the margin.
 172
 173
 174 Tested NICs
 175 -----------
 176
 177 .. This section should contain a list of NICs that were tested with this release.
 178
 179    The format is:
 180
 181    #. NIC name.
 182
 183       * NIC details.
 184       * NIC details.
 185
 186    This section is a comment. Make sure to start the actual text at the margin.
 187
 188
 189 Tested OSes
 190 -----------
 191
 192 .. This section should contain a list of OSes that were tested with this release.
 193    The format is as follows, in alphabetical order:
 194
 195    * CentOS 7.0
 196    * Fedora 23
 197    * Fedora 24
 198    * FreeBSD 10.3
 199    * Red Hat Enterprise Linux 7.2
 200    * SUSE Enterprise Linux 12
 201    * Ubuntu 15.10
 202    * Ubuntu 16.04 LTS
 203    * Wind River Linux 8
 204
 205    This section is a comment. Make sure to start the actual text at the margin.