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 * A new device flag, RTE_ETH_DEV_NOLIVE_MAC_ADDR, changes the order of
  72   actions inside rte_eth_dev_start regarding MAC set. Some NICs do not
  73   support MAC changes once the port has started and with this new device
  74   flag the MAC can be properly configured in any case. This is particularly
  75   important for bonding.
  76
  77
  78 ABI Changes
  79 -----------
  80
  81 .. This section should contain ABI changes. Sample format:
  82
  83    * Add a short 1-2 sentence description of the ABI change
  84      that was announced in the previous releases and made in this release.
  85      Use fixed width quotes for ``function_names`` or ``struct_names``.
  86      Use the past tense.
  87
  88    This section is a comment. Do not overwrite or remove it.
  89    Also, make sure to start the actual text at the margin.
  90    =========================================================
  91
  92
  93 Removed Items
  94 -------------
  95
  96 .. This section should contain removed items in this release. Sample format:
  97
  98    * Add a short 1-2 sentence description of the removed item
  99      in the past tense.
 100
 101    This section is a comment. Do not overwrite or remove it.
 102    Also, make sure to start the actual text at the margin.
 103    =========================================================
 104
 105
 106 Shared Library Versions
 107 -----------------------
 108
 109 .. Update any library version updated in this release
 110    and prepend with a ``+`` sign, like this:
 111
 112      librte_acl.so.2
 113    + librte_cfgfile.so.2
 114      librte_cmdline.so.2
 115
 116    This section is a comment. Do not overwrite or remove it.
 117    =========================================================
 118
 119 The libraries prepended with a plus sign were incremented in this version.
 120
 121 .. code-block:: diff
 122
 123      librte_acl.so.2
 124      librte_bbdev.so.1
 125      librte_bitratestats.so.2
 126      librte_bpf.so.1
 127      librte_bus_dpaa.so.1
 128      librte_bus_fslmc.so.1
 129      librte_bus_pci.so.1
 130      librte_bus_vdev.so.1
 131      librte_bus_vmbus.so.1
 132      librte_cfgfile.so.2
 133      librte_cmdline.so.2
 134      librte_common_octeontx.so.1
 135      librte_compressdev.so.1
 136      librte_cryptodev.so.5
 137      librte_distributor.so.1
 138      librte_eal.so.8
 139      librte_ethdev.so.10
 140      librte_eventdev.so.4
 141      librte_flow_classify.so.1
 142      librte_gro.so.1
 143      librte_gso.so.1
 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_latencystats.so.1
 150      librte_lpm.so.2
 151      librte_mbuf.so.4
 152      librte_mempool.so.5
 153      librte_meter.so.2
 154      librte_metrics.so.1
 155      librte_net.so.1
 156      librte_pci.so.1
 157      librte_pdump.so.2
 158      librte_pipeline.so.3
 159      librte_pmd_bnxt.so.2
 160      librte_pmd_bond.so.2
 161      librte_pmd_i40e.so.2
 162      librte_pmd_ixgbe.so.2
 163      librte_pmd_dpaa2_cmdif.so.1
 164      librte_pmd_dpaa2_qdma.so.1
 165      librte_pmd_ring.so.2
 166      librte_pmd_softnic.so.1
 167      librte_pmd_vhost.so.2
 168      librte_port.so.3
 169      librte_power.so.1
 170      librte_rawdev.so.1
 171      librte_reorder.so.1
 172      librte_ring.so.2
 173      librte_sched.so.1
 174      librte_security.so.1
 175      librte_table.so.3
 176      librte_timer.so.1
 177      librte_vhost.so.3
 178
 179
 180 Known Issues
 181 ------------
 182
 183 .. This section should contain new known issues in this release. Sample format:
 184
 185    * **Add title in present tense with full stop.**
 186
 187      Add a short 1-2 sentence description of the known issue
 188      in the present tense. Add information on any known workarounds.
 189
 190    This section is a comment. Do not overwrite or remove it.
 191    Also, make sure to start the actual text at the margin.
 192    =========================================================
 193
 194
 195 Tested Platforms
 196 ----------------
 197
 198 .. This section should contain a list of platforms that were tested
 199    with this release.
 200
 201    The format is:
 202
 203    * <vendor> platform with <vendor> <type of devices> combinations
 204
 205      * List of CPU
 206      * List of OS
 207      * List of devices
 208      * Other relevant details...
 209
 210    This section is a comment. Do not overwrite or remove it.
 211    Also, make sure to start the actual text at the margin.
 212    =========================================================
 213