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 * **Added RSS hash and key update to CXGBE PMD.**
  45
  46   Support to update RSS hash and key has been added to CXGBE PMD.
  47
  48
  49 API Changes
  50 -----------
  51
  52 .. This section should contain API changes. Sample format:
  53
  54    * Add a short 1-2 sentence description of the API change. Use fixed width
  55      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
  56      tense.
  57
  58    This section is a comment. Do not overwrite or remove it.
  59    Also, make sure to start the actual text at the margin.
  60    =========================================================
  61
  62
  63 ABI Changes
  64 -----------
  65
  66 .. This section should contain ABI changes. Sample format:
  67
  68    * Add a short 1-2 sentence description of the ABI change that was announced
  69      in the previous releases and made in this release. Use fixed width quotes
  70      for ``rte_function_names`` or ``rte_struct_names``. Use 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 Removed Items
  78 -------------
  79
  80 .. This section should contain removed items in this release. Sample format:
  81
  82    * Add a short 1-2 sentence description of the removed item in the past
  83      tense.
  84
  85    This section is a comment. Do not overwrite or remove it.
  86    Also, make sure to start the actual text at the margin.
  87    =========================================================
  88
  89
  90 Known Issues
  91 ------------
  92
  93 .. This section should contain new known issues in this release. Sample format:
  94
  95    * **Add title in present tense with full stop.**
  96
  97      Add a short 1-2 sentence description of the known issue in the present
  98      tense. Add information on any known workarounds.
  99
 100    This section is a comment. Do not overwrite or remove it.
 101    Also, make sure to start the actual text at the margin.
 102    =========================================================
 103
 104
 105 Shared Library Versions
 106 -----------------------
 107
 108 .. Update any library version updated in this release and prepend with a ``+``
 109    sign, like this:
 110
 111      librte_acl.so.2
 112    + librte_cfgfile.so.2
 113      librte_cmdline.so.2
 114
 115    This section is a comment. Do not overwrite or remove it.
 116    =========================================================
 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_bus_dpaa.so.1
 127      librte_bus_fslmc.so.1
 128      librte_bus_pci.so.1
 129      librte_bus_vdev.so.1
 130      librte_cfgfile.so.2
 131      librte_cmdline.so.2
 132      librte_cryptodev.so.4
 133      librte_distributor.so.1
 134      librte_eal.so.6
 135    + librte_ethdev.so.9
 136      librte_eventdev.so.3
 137      librte_flow_classify.so.1
 138      librte_gro.so.1
 139      librte_gso.so.1
 140      librte_hash.so.2
 141      librte_ip_frag.so.1
 142      librte_jobstats.so.1
 143      librte_kni.so.2
 144      librte_kvargs.so.1
 145      librte_latencystats.so.1
 146      librte_lpm.so.2
 147      librte_mbuf.so.3
 148      librte_mempool.so.3
 149    + librte_meter.so.2
 150      librte_metrics.so.1
 151      librte_net.so.1
 152      librte_pci.so.1
 153      librte_pdump.so.2
 154      librte_pipeline.so.3
 155      librte_pmd_bnxt.so.2
 156      librte_pmd_bond.so.2
 157      librte_pmd_i40e.so.2
 158      librte_pmd_ixgbe.so.2
 159      librte_pmd_ring.so.2
 160      librte_pmd_softnic.so.1
 161      librte_pmd_vhost.so.2
 162      librte_port.so.3
 163      librte_power.so.1
 164      librte_rawdev.so.1
 165      librte_reorder.so.1
 166      librte_ring.so.1
 167      librte_sched.so.1
 168      librte_security.so.1
 169      librte_table.so.3
 170      librte_timer.so.1
 171      librte_vhost.so.3
 172
 173
 174 Tested Platforms
 175 ----------------
 176
 177 .. This section should contain a list of platforms that were tested with this
 178    release.
 179
 180    The format is:
 181
 182    * <vendor> platform with <vendor> <type of devices> combinations
 183
 184      * List of CPU
 185      * List of OS
 186      * List of devices
 187      * Other relevant details...
 188
 189    This section is a comment. Do not overwrite or remove it.
 190    Also, make sure to start the actual text at the margin.
 191    =========================================================