doc/guides/rel_notes/release_18_08.rst

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