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 * The driver names have been changed. It especially impacts ``--vdev`` arguments.
  98   Examples: ``eth_pcap`` becomes ``net_pcap``
  99   and ``cryptodev_aesni_mb_pmd`` becomes ``crypto_aesni_mb``.
 100
 101 * The log history is removed.
 102
 103 * The ``rte_ivshmem`` feature (including library and EAL code) has been removed
 104   in 16.11 because it had some design issues which were not planned to be fixed.
 105
 106
 107 ABI Changes
 108 -----------
 109
 110 .. This section should contain ABI changes. Sample format:
 111
 112    * Add a short 1-2 sentence description of the ABI change that was announced in
 113      the previous releases and made in this release. Use fixed width quotes for
 114      ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 115
 116    This section is a comment. Make sure to start the actual text at the margin.
 117
 118
 119
 120 Shared Library Versions
 121 -----------------------
 122
 123 .. Update any library version updated in this release and prepend with a ``+``
 124    sign, like this:
 125
 126      libethdev.so.4
 127      librte_acl.so.2
 128    + librte_cfgfile.so.2
 129      librte_cmdline.so.2
 130
 131
 132
 133 The libraries prepended with a plus sign were incremented in this version.
 134
 135 .. code-block:: diff
 136
 137      libethdev.so.4
 138      librte_acl.so.2
 139      librte_cfgfile.so.2
 140      librte_cmdline.so.2
 141      librte_cryptodev.so.1
 142      librte_distributor.so.1
 143    + librte_eal.so.3
 144      librte_hash.so.2
 145      librte_ip_frag.so.1
 146      librte_jobstats.so.1
 147      librte_kni.so.2
 148      librte_kvargs.so.1
 149      librte_lpm.so.2
 150      librte_mbuf.so.2
 151      librte_mempool.so.2
 152      librte_meter.so.1
 153      librte_pdump.so.1
 154      librte_pipeline.so.3
 155      librte_pmd_bond.so.1
 156      librte_pmd_ring.so.2
 157      librte_port.so.3
 158      librte_power.so.1
 159      librte_reorder.so.1
 160      librte_ring.so.1
 161      librte_sched.so.1
 162      librte_table.so.2
 163      librte_timer.so.1
 164      librte_vhost.so.3
 165
 166
 167 Tested Platforms
 168 ----------------
 169
 170 .. This section should contain a list of platforms that were tested with this release.
 171
 172    The format is:
 173
 174    #. Platform name.
 175
 176       * Platform details.
 177       * Platform details.
 178
 179    This section is a comment. Make sure to start the actual text at the margin.
 180
 181
 182 Tested NICs
 183 -----------
 184
 185 .. This section should contain a list of NICs that were tested with this release.
 186
 187    The format is:
 188
 189    #. NIC name.
 190
 191       * NIC details.
 192       * NIC details.
 193
 194    This section is a comment. Make sure to start the actual text at the margin.
 195
 196
 197 Tested OSes
 198 -----------
 199
 200 .. This section should contain a list of OSes that were tested with this release.
 201    The format is as follows, in alphabetical order:
 202
 203    * CentOS 7.0
 204    * Fedora 23
 205    * Fedora 24
 206    * FreeBSD 10.3
 207    * Red Hat Enterprise Linux 7.2
 208    * SUSE Enterprise Linux 12
 209    * Ubuntu 15.10
 210    * Ubuntu 16.04 LTS
 211    * Wind River Linux 8
 212
 213    This section is a comment. Make sure to start the actual text at the margin.