doc/guides/rel_notes/release_18_11.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright 2018 The DPDK contributors
   3
   4 DPDK Release 18.11
   5 ==================
   6
   7 .. **Read this first.**
   8
   9    The text in the sections below explains how to update the release notes.
  10
  11    Use proper spelling, capitalization and punctuation in all sections.
  12
  13    Variable and config names should be quoted as fixed width text:
  14    ``LIKE_THIS``.
  15
  16    Build the docs and view the output file to ensure the changes are correct::
  17
  18       make doc-guides-html
  19
  20       xdg-open build/doc/html/guides/rel_notes/release_18_11.html
  21
  22
  23 New Features
  24 ------------
  25
  26 .. This section should contain new features added in this release.
  27    Sample format:
  28
  29    * **Add a title in the past tense with a full stop.**
  30
  31      Add a short 1-2 sentence description in the past tense.
  32      The description should be enough to allow someone scanning
  33      the release notes to understand the new feature.
  34
  35      If the feature adds a lot of sub-features you can use a bullet list
  36      like this:
  37
  38      * Added feature foo to do something.
  39      * Enhanced feature bar to do something else.
  40
  41      Refer to the previous release notes for examples.
  42
  43      Suggested order in release notes items:
  44      * Core libs (EAL, mempool, ring, mbuf, buses)
  45      * Device abstraction libs and PMDs
  46        - ethdev (lib, PMDs)
  47        - cryptodev (lib, PMDs)
  48        - eventdev (lib, PMDs)
  49        - etc
  50      * Other libs
  51      * Apps, Examples, Tools (if significative)
  52
  53      This section is a comment. Do not overwrite or remove it.
  54      Also, make sure to start the actual text at the margin.
  55      =========================================================
  56
  57
  58 API Changes
  59 -----------
  60
  61 .. This section should contain API changes. Sample format:
  62
  63    * Add a short 1-2 sentence description of the API change.
  64      Use fixed width quotes for ``function_names`` or ``struct_names``.
  65      Use the past tense.
  66
  67    This section is a comment. Do not overwrite or remove it.
  68    Also, make sure to start the actual text at the margin.
  69    =========================================================
  70
  71
  72 ABI Changes
  73 -----------
  74
  75 .. This section should contain ABI changes. Sample format:
  76
  77    * Add a short 1-2 sentence description of the ABI change
  78      that was announced in the previous releases and made in this release.
  79      Use fixed width quotes for ``function_names`` or ``struct_names``.
  80      Use the past tense.
  81
  82    This section is a comment. Do not overwrite or remove it.
  83    Also, make sure to start the actual text at the margin.
  84    =========================================================
  85
  86
  87 Removed Items
  88 -------------
  89
  90 .. This section should contain removed items in this release. Sample format:
  91
  92    * Add a short 1-2 sentence description of the removed item
  93      in the past tense.
  94
  95    This section is a comment. Do not overwrite or remove it.
  96    Also, make sure to start the actual text at the margin.
  97    =========================================================
  98
  99
 100 Shared Library Versions
 101 -----------------------
 102
 103 .. Update any library version updated in this release
 104    and prepend with a ``+`` sign, like this:
 105
 106      librte_acl.so.2
 107    + librte_cfgfile.so.2
 108      librte_cmdline.so.2
 109
 110    This section is a comment. Do not overwrite or remove it.
 111    =========================================================
 112
 113 The libraries prepended with a plus sign were incremented in this version.
 114
 115 .. code-block:: diff
 116
 117      librte_acl.so.2
 118      librte_bbdev.so.1
 119      librte_bitratestats.so.2
 120      librte_bpf.so.1
 121      librte_bus_dpaa.so.1
 122      librte_bus_fslmc.so.1
 123      librte_bus_pci.so.1
 124      librte_bus_vdev.so.1
 125      librte_bus_vmbus.so.1
 126      librte_cfgfile.so.2
 127      librte_cmdline.so.2
 128      librte_common_octeontx.so.1
 129      librte_compressdev.so.1
 130      librte_cryptodev.so.5
 131      librte_distributor.so.1
 132      librte_eal.so.8
 133      librte_ethdev.so.10
 134      librte_eventdev.so.4
 135      librte_flow_classify.so.1
 136      librte_gro.so.1
 137      librte_gso.so.1
 138      librte_hash.so.2
 139      librte_ip_frag.so.1
 140      librte_jobstats.so.1
 141      librte_kni.so.2
 142      librte_kvargs.so.1
 143      librte_latencystats.so.1
 144      librte_lpm.so.2
 145      librte_mbuf.so.4
 146      librte_mempool.so.5
 147      librte_meter.so.2
 148      librte_metrics.so.1
 149      librte_net.so.1
 150      librte_pci.so.1
 151      librte_pdump.so.2
 152      librte_pipeline.so.3
 153      librte_pmd_bnxt.so.2
 154      librte_pmd_bond.so.2
 155      librte_pmd_i40e.so.2
 156      librte_pmd_ixgbe.so.2
 157      librte_pmd_dpaa2_cmdif.so.1
 158      librte_pmd_dpaa2_qdma.so.1
 159      librte_pmd_ring.so.2
 160      librte_pmd_softnic.so.1
 161      librte_pmd_vhost.so.2
 162      librte_port.so.3
 163      librte_power.so.1
 164      librte_rawdev.so.1
 165      librte_reorder.so.1
 166      librte_ring.so.2
 167      librte_sched.so.1
 168      librte_security.so.1
 169      librte_table.so.3
 170      librte_timer.so.1
 171      librte_vhost.so.3
 172
 173
 174 Known Issues
 175 ------------
 176
 177 .. This section should contain new known issues in this release. Sample format:
 178
 179    * **Add title in present tense with full stop.**
 180
 181      Add a short 1-2 sentence description of the known issue
 182      in the present tense. Add information on any known workarounds.
 183
 184    This section is a comment. Do not overwrite or remove it.
 185    Also, make sure to start the actual text at the margin.
 186    =========================================================
 187
 188
 189 Tested Platforms
 190 ----------------
 191
 192 .. This section should contain a list of platforms that were tested
 193    with this release.
 194
 195    The format is:
 196
 197    * <vendor> platform with <vendor> <type of devices> combinations
 198
 199      * List of CPU
 200      * List of OS
 201      * List of devices
 202      * Other relevant details...
 203
 204    This section is a comment. Do not overwrite or remove it.
 205    Also, make sure to start the actual text at the margin.
 206    =========================================================
 207