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