doc/guides/rel_notes/release_16_07.rst

   1 DPDK Release 16.07
   2 ==================
   3
   4 **Read this first.**
   5
   6 The text 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: ``LIKE_THIS``.
  11
  12 Build the docs and view the output file to ensure the changes are correct::
  13
  14    make doc-guides-html
  15
  16    firefox build/doc/html/guides/rel_notes/release_16_07.html
  17
  18
  19 New Features
  20 ------------
  21
  22 This section should contain new features added in this release. Sample format:
  23
  24 * **Add a title in the past tense with a full stop.**
  25
  26   Add a short 1-2 sentence description in the past tense. The description
  27   should be enough to allow someone scanning the release notes to understand
  28   the new feature.
  29
  30   If the feature adds a lot of sub-features you can use a bullet list like this.
  31
  32   * Added feature foo to do something.
  33   * Enhanced feature bar to do something else.
  34
  35   Refer to the previous release notes for examples.
  36
  37
  38 Resolved Issues
  39 ---------------
  40
  41 This section should contain bug fixes added to the relevant sections. Sample format:
  42
  43 * **code/section Fixed issue in the past tense with a full stop.**
  44
  45   Add a short 1-2 sentence description of the resolved issue in the past tense.
  46   The title should contain the code/lib section like a commit message.
  47   Add the entries in alphabetic order in the relevant sections below.
  48
  49
  50 EAL
  51 ~~~
  52
  53
  54 Drivers
  55 ~~~~~~~
  56
  57
  58 Libraries
  59 ~~~~~~~~~
  60
  61
  62 Examples
  63 ~~~~~~~~
  64
  65
  66 Other
  67 ~~~~~
  68
  69
  70 Known Issues
  71 ------------
  72
  73 This section should contain new known issues in this release. Sample format:
  74
  75 * **Add title in present tense with full stop.**
  76
  77   Add a short 1-2 sentence description of the known issue in the present
  78   tense. Add information on any known workarounds.
  79
  80
  81 API Changes
  82 -----------
  83
  84 This section should contain API changes. Sample format:
  85
  86 * Add a short 1-2 sentence description of the API change. Use fixed width
  87   quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
  88
  89
  90 ABI Changes
  91 -----------
  92
  93 * Add a short 1-2 sentence description of the ABI change that was announced in
  94   the previous releases and made in this release. Use fixed width quotes for
  95   ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
  96
  97
  98 Shared Library Versions
  99 -----------------------
 100
 101 Update any library version updated in this release and prepend with a ``+`` sign.
 102
 103 The libraries prepended with a plus sign were incremented in this version.
 104
 105 .. code-block:: diff
 106
 107      libethdev.so.3
 108      librte_acl.so.2
 109      librte_cfgfile.so.2
 110      librte_cmdline.so.2
 111      librte_distributor.so.1
 112      librte_eal.so.2
 113      librte_hash.so.2
 114      librte_ip_frag.so.1
 115      librte_ivshmem.so.1
 116      librte_jobstats.so.1
 117      librte_kni.so.2
 118      librte_kvargs.so.1
 119      librte_lpm.so.2
 120      librte_mbuf.so.2
 121      librte_mempool.so.1
 122      librte_meter.so.1
 123      librte_pipeline.so.3
 124      librte_pmd_bond.so.1
 125      librte_pmd_ring.so.2
 126      librte_port.so.2
 127      librte_power.so.1
 128      librte_reorder.so.1
 129      librte_ring.so.1
 130      librte_sched.so.1
 131      librte_table.so.2
 132      librte_timer.so.1
 133      librte_vhost.so.2
 134
 135
 136 Tested Platforms
 137 ----------------
 138
 139 This section should contain a list of platforms that were tested with this
 140 release.
 141
 142 The format is:
 143
 144 #. Platform name.
 145
 146    - Platform details.
 147    - Platform details.
 148
 149
 150 Tested NICs
 151 -----------
 152
 153 This section should contain a list of NICs that were tested with this release.
 154
 155 The format is:
 156
 157 #. NIC name.
 158
 159    - NIC details.
 160    - NIC details.