doc/guides/rel_notes/release_18_02.rst

   1 DPDK Release 18.02
   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_02.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 * **Add MAC loopback support for i40e.**
  45
  46   Add MAC loopback support for i40e in order to support test task asked by
  47   users. According to the device configuration, it will setup TX->RX loopback
  48   link or not.
  49
  50
  51 API Changes
  52 -----------
  53
  54 .. This section should contain API changes. Sample format:
  55
  56    * Add a short 1-2 sentence description of the API change. Use fixed width
  57      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
  58      tense.
  59
  60    This section is a comment. do not overwrite or remove it.
  61    Also, make sure to start the actual text at the margin.
  62    =========================================================
  63
  64
  65 ABI Changes
  66 -----------
  67
  68 .. This section should contain ABI changes. Sample format:
  69
  70    * Add a short 1-2 sentence description of the ABI change that was announced
  71      in the previous releases and made in this release. Use fixed width quotes
  72      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
  73
  74    This section is a comment. do not overwrite or remove it.
  75    Also, make sure to start the actual text at the margin.
  76    =========================================================
  77
  78
  79 Removed Items
  80 -------------
  81
  82 .. This section should contain removed items in this release. Sample format:
  83
  84    * Add a short 1-2 sentence description of the removed item in the past
  85      tense.
  86
  87    This section is a comment. do not overwrite or remove it.
  88    Also, make sure to start the actual text at the margin.
  89    =========================================================
  90
  91
  92 Known Issues
  93 ------------
  94
  95 .. This section should contain new known issues in this release. Sample format:
  96
  97    * **Add title in present tense with full stop.**
  98
  99      Add a short 1-2 sentence description of the known issue in the present
 100      tense. Add information on any known workarounds.
 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 and prepend with a ``+``
 111    sign, like this:
 112
 113      librte_acl.so.2
 114    + librte_cfgfile.so.2
 115      librte_cmdline.so.2
 116
 117    This section is a comment. do not overwrite or remove it.
 118    =========================================================
 119
 120
 121 The libraries prepended with a plus sign were incremented in this version.
 122
 123 .. code-block:: diff
 124
 125      librte_acl.so.2
 126      librte_bitratestats.so.2
 127      librte_bus_dpaa.so.1
 128      librte_bus_fslmc.so.1
 129      librte_bus_pci.so.1
 130      librte_bus_vdev.so.1
 131      librte_cfgfile.so.2
 132      librte_cmdline.so.2
 133      librte_cryptodev.so.4
 134      librte_distributor.so.1
 135      librte_eal.so.6
 136      librte_ethdev.so.8
 137      librte_eventdev.so.3
 138      librte_flow_classify.so.1
 139      librte_gro.so.1
 140      librte_gso.so.1
 141      librte_hash.so.2
 142      librte_ip_frag.so.1
 143      librte_jobstats.so.1
 144      librte_kni.so.2
 145      librte_kvargs.so.1
 146      librte_latencystats.so.1
 147      librte_lpm.so.2
 148      librte_mbuf.so.3
 149      librte_mempool.so.3
 150      librte_meter.so.1
 151      librte_metrics.so.1
 152      librte_net.so.1
 153      librte_pci.so.1
 154      librte_pdump.so.2
 155      librte_pipeline.so.3
 156      librte_pmd_bnxt.so.2
 157      librte_pmd_bond.so.2
 158      librte_pmd_i40e.so.2
 159      librte_pmd_ixgbe.so.2
 160      librte_pmd_ring.so.2
 161      librte_pmd_softnic.so.1
 162      librte_pmd_vhost.so.2
 163      librte_port.so.3
 164      librte_power.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
 175 Tested Platforms
 176 ----------------
 177
 178 .. This section should contain a list of platforms that were tested with this
 179    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    =========================================================