doc/guides/rel_notes/release_17_05.rst

   1 DPDK Release 17.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_17_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 Resolved Issues
  46 ---------------
  47
  48 .. This section should contain bug fixes added to the relevant
  49    sections. Sample format:
  50
  51    * **code/section Fixed issue in the past tense with a full stop.**
  52
  53      Add a short 1-2 sentence description of the resolved issue in the past
  54      tense.
  55
  56      The title should contain the code/lib section like a commit message.
  57
  58      Add the entries in alphabetic order in the relevant sections below.
  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 EAL
  66 ~~~
  67
  68
  69 Drivers
  70 ~~~~~~~
  71
  72
  73 Libraries
  74 ~~~~~~~~~
  75
  76
  77 Examples
  78 ~~~~~~~~
  79
  80
  81 Other
  82 ~~~~~
  83
  84
  85 Known Issues
  86 ------------
  87
  88 .. This section should contain new known issues in this release. Sample format:
  89
  90    * **Add title in present tense with full stop.**
  91
  92      Add a short 1-2 sentence description of the known issue in the present
  93      tense. Add information on any known workarounds.
  94
  95    This section is a comment. do not overwrite or remove it.
  96    Also, make sure to start the actual text at the margin.
  97    =========================================================
  98
  99
 100 API Changes
 101 -----------
 102
 103 .. This section should contain API changes. Sample format:
 104
 105    * Add a short 1-2 sentence description of the API change. Use fixed width
 106      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
 107      tense.
 108
 109    This section is a comment. do not overwrite or remove it.
 110    Also, make sure to start the actual text at the margin.
 111    =========================================================
 112
 113
 114 ABI Changes
 115 -----------
 116
 117 .. This section should contain ABI changes. Sample format:
 118
 119    * Add a short 1-2 sentence description of the ABI change that was announced
 120      in the previous releases and made in this release. Use fixed width quotes
 121      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 122
 123    This section is a comment. do not overwrite or remove it.
 124    Also, make sure to start the actual text at the margin.
 125    =========================================================
 126
 127
 128
 129 Shared Library Versions
 130 -----------------------
 131
 132 .. Update any library version updated in this release and prepend with a ``+``
 133    sign, like this:
 134
 135      librte_acl.so.2
 136    + librte_cfgfile.so.2
 137      librte_cmdline.so.2
 138
 139    This section is a comment. do not overwrite or remove it.
 140    =========================================================
 141
 142
 143 The libraries prepended with a plus sign were incremented in this version.
 144
 145 .. code-block:: diff
 146
 147      librte_acl.so.2
 148      librte_cfgfile.so.2
 149      librte_cmdline.so.2
 150      librte_cryptodev.so.2
 151      librte_distributor.so.1
 152      librte_eal.so.3
 153      librte_ethdev.so.6
 154      librte_hash.so.2
 155      librte_ip_frag.so.1
 156      librte_jobstats.so.1
 157      librte_kni.so.2
 158      librte_kvargs.so.1
 159      librte_lpm.so.2
 160      librte_mbuf.so.2
 161      librte_mempool.so.2
 162      librte_meter.so.1
 163      librte_net.so.1
 164      librte_pdump.so.1
 165      librte_pipeline.so.3
 166      librte_pmd_bond.so.1
 167      librte_pmd_ring.so.2
 168      librte_port.so.3
 169      librte_power.so.1
 170      librte_reorder.so.1
 171      librte_ring.so.1
 172      librte_sched.so.1
 173      librte_table.so.2
 174      librte_timer.so.1
 175      librte_vhost.so.3
 176
 177
 178 Tested Platforms
 179 ----------------
 180
 181 .. This section should contain a list of platforms that were tested with this
 182    release.
 183
 184    The format is:
 185
 186    * <vendor> platform with <vendor> <type of devices> combinations
 187
 188      * List of CPU
 189      * List of OS
 190      * List of devices
 191      * Other relevant details...
 192
 193    This section is a comment. do not overwrite or remove it.
 194    Also, make sure to start the actual text at the margin.
 195    =========================================================