doc/guides/rel_notes/release_19_02.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright 2018 The DPDK contributors
   3
   4 DPDK Release 19.02
   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_19_02.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 significant)
  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 * **Updated the enic driver.**
  58
  59   * Added support for ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
  60   * Added the handler to get firmware version string.
  61   * Added support for multicast filtering.
  62
  63
  64 Removed Items
  65 -------------
  66
  67 .. This section should contain removed items in this release. Sample format:
  68
  69    * Add a short 1-2 sentence description of the removed item
  70      in the past tense.
  71
  72    This section is a comment. Do not overwrite or remove it.
  73    Also, make sure to start the actual text at the margin.
  74    =========================================================
  75
  76
  77 API Changes
  78 -----------
  79
  80 .. This section should contain API changes. Sample format:
  81
  82    * sample: Add a short 1-2 sentence description of the API change
  83      which was announced in the previous releases and made in this release.
  84      Start with a scope label like "ethdev:".
  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 ABI Changes
  94 -----------
  95
  96 .. This section should contain ABI changes. Sample format:
  97
  98    * sample: Add a short 1-2 sentence description of the ABI change
  99      which was announced in the previous releases and made in this release.
 100      Start with a scope label like "ethdev:".
 101      Use fixed width quotes for ``function_names`` or ``struct_names``.
 102      Use the past tense.
 103
 104    This section is a comment. Do not overwrite or remove it.
 105    Also, make sure to start the actual text at the margin.
 106    =========================================================
 107
 108
 109 Shared Library Versions
 110 -----------------------
 111
 112 .. Update any library version updated in this release
 113    and prepend with a ``+`` sign, like this:
 114
 115      libfoo.so.1
 116    + libupdated.so.2
 117      libbar.so.1
 118
 119    This section is a comment. Do not overwrite or remove it.
 120    =========================================================
 121
 122 The libraries prepended with a plus sign were incremented in this version.
 123
 124 .. code-block:: diff
 125
 126      librte_acl.so.2
 127      librte_bbdev.so.1
 128      librte_bitratestats.so.2
 129      librte_bpf.so.1
 130      librte_bus_dpaa.so.2
 131      librte_bus_fslmc.so.2
 132      librte_bus_ifpga.so.2
 133      librte_bus_pci.so.2
 134      librte_bus_vdev.so.2
 135      librte_bus_vmbus.so.2
 136      librte_cfgfile.so.2
 137      librte_cmdline.so.2
 138      librte_compressdev.so.1
 139      librte_cryptodev.so.5
 140      librte_distributor.so.1
 141      librte_eal.so.9
 142      librte_efd.so.1
 143      librte_ethdev.so.11
 144      librte_eventdev.so.6
 145      librte_flow_classify.so.1
 146      librte_gro.so.1
 147      librte_gso.so.1
 148      librte_hash.so.2
 149      librte_ip_frag.so.1
 150      librte_jobstats.so.1
 151      librte_kni.so.2
 152      librte_kvargs.so.1
 153      librte_latencystats.so.1
 154      librte_lpm.so.2
 155      librte_mbuf.so.4
 156      librte_member.so.1
 157      librte_mempool.so.5
 158      librte_meter.so.2
 159      librte_metrics.so.1
 160      librte_net.so.1
 161      librte_pci.so.1
 162      librte_pdump.so.2
 163      librte_pipeline.so.3
 164      librte_pmd_bnxt.so.2
 165      librte_pmd_bond.so.2
 166      librte_pmd_i40e.so.2
 167      librte_pmd_ixgbe.so.2
 168      librte_pmd_dpaa2_qdma.so.1
 169      librte_pmd_ring.so.2
 170      librte_pmd_softnic.so.1
 171      librte_pmd_vhost.so.2
 172      librte_port.so.3
 173      librte_power.so.1
 174      librte_rawdev.so.1
 175      librte_reorder.so.1
 176      librte_ring.so.2
 177      librte_sched.so.1
 178      librte_security.so.1
 179      librte_table.so.3
 180      librte_timer.so.1
 181      librte_vhost.so.4
 182
 183
 184 Known Issues
 185 ------------
 186
 187 .. This section should contain new known issues in this release. Sample format:
 188
 189    * **Add title in present tense with full stop.**
 190
 191      Add a short 1-2 sentence description of the known issue
 192      in the present tense. Add information on any known workarounds.
 193
 194    This section is a comment. Do not overwrite or remove it.
 195    Also, make sure to start the actual text at the margin.
 196    =========================================================
 197
 198
 199 Tested Platforms
 200 ----------------
 201
 202 .. This section should contain a list of platforms that were tested
 203    with this release.
 204
 205    The format is:
 206
 207    * <vendor> platform with <vendor> <type of devices> combinations
 208
 209      * List of CPU
 210      * List of OS
 211      * List of devices
 212      * Other relevant details...
 213
 214    This section is a comment. Do not overwrite or remove it.
 215    Also, make sure to start the actual text at the margin.
 216    =========================================================