doc/guides/rel_notes/release_18_05.rst

   1 DPDK Release 18.05
   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_05.html
  18
  19
  20 New Features
  21 ------------
  22
  23 .. This section should contain new features added in this release. Sample
  24    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. The description
  29      should be enough to allow someone scanning the release notes to
  30      understand the new feature.
  31
  32      If the feature adds a lot of sub-features you can use a bullet list like
  33      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. Use fixed width
  51      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
  52      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 that was announced
  65      in the previous releases and made in this release. Use fixed width quotes
  66      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
  67
  68    This section is a comment. Do not overwrite or remove it.
  69    Also, make sure to start the actual text at the margin.
  70    =========================================================
  71
  72
  73 Removed Items
  74 -------------
  75
  76 .. This section should contain removed items in this release. Sample format:
  77
  78    * Add a short 1-2 sentence description of the removed item in the past
  79      tense.
  80
  81    This section is a comment. Do not overwrite or remove it.
  82    Also, make sure to start the actual text at the margin.
  83    =========================================================
  84
  85
  86 Known Issues
  87 ------------
  88
  89 .. This section should contain new known issues in this release. Sample format:
  90
  91    * **Add title in present tense with full stop.**
  92
  93      Add a short 1-2 sentence description of the known issue in the present
  94      tense. Add information on any known workarounds.
  95
  96    This section is a comment. Do not overwrite or remove it.
  97    Also, make sure to start the actual text at the margin.
  98    =========================================================
  99
 100
 101 Shared Library Versions
 102 -----------------------
 103
 104 .. Update any library version updated in this release and prepend with a ``+``
 105    sign, like this:
 106
 107      librte_acl.so.2
 108    + librte_cfgfile.so.2
 109      librte_cmdline.so.2
 110
 111    This section is a comment. Do not overwrite or remove it.
 112    =========================================================
 113
 114
 115 The libraries prepended with a plus sign were incremented in this version.
 116
 117 .. code-block:: diff
 118
 119      librte_acl.so.2
 120      librte_bbdev.so.1
 121      librte_bitratestats.so.2
 122      librte_bus_dpaa.so.1
 123      librte_bus_fslmc.so.1
 124      librte_bus_pci.so.1
 125      librte_bus_vdev.so.1
 126      librte_cfgfile.so.2
 127      librte_cmdline.so.2
 128      librte_cryptodev.so.4
 129      librte_distributor.so.1
 130      librte_eal.so.6
 131    + librte_ethdev.so.9
 132      librte_eventdev.so.3
 133      librte_flow_classify.so.1
 134      librte_gro.so.1
 135      librte_gso.so.1
 136      librte_hash.so.2
 137      librte_ip_frag.so.1
 138      librte_jobstats.so.1
 139      librte_kni.so.2
 140      librte_kvargs.so.1
 141      librte_latencystats.so.1
 142      librte_lpm.so.2
 143      librte_mbuf.so.3
 144      librte_mempool.so.3
 145    + librte_meter.so.2
 146      librte_metrics.so.1
 147      librte_net.so.1
 148      librte_pci.so.1
 149      librte_pdump.so.2
 150      librte_pipeline.so.3
 151      librte_pmd_bnxt.so.2
 152      librte_pmd_bond.so.2
 153      librte_pmd_i40e.so.2
 154      librte_pmd_ixgbe.so.2
 155      librte_pmd_ring.so.2
 156      librte_pmd_softnic.so.1
 157      librte_pmd_vhost.so.2
 158      librte_port.so.3
 159      librte_power.so.1
 160      librte_rawdev.so.1
 161      librte_reorder.so.1
 162      librte_ring.so.1
 163      librte_sched.so.1
 164      librte_security.so.1
 165      librte_table.so.3
 166      librte_timer.so.1
 167      librte_vhost.so.3
 168
 169
 170 Tested Platforms
 171 ----------------
 172
 173 .. This section should contain a list of platforms that were tested with this
 174    release.
 175
 176    The format is:
 177
 178    * <vendor> platform with <vendor> <type of devices> combinations
 179
 180      * List of CPU
 181      * List of OS
 182      * List of devices
 183      * Other relevant details...
 184
 185    This section is a comment. Do not overwrite or remove it.
 186    Also, make sure to start the actual text at the margin.
 187    =========================================================