4 .. **Read this first.**
6 The text in the sections below explains how to update the release notes.
8 Use proper spelling, capitalization and punctuation in all sections.
10 Variable and config names should be quoted as fixed width text:
13 Build the docs and view the output file to ensure the changes are correct::
17 xdg-open build/doc/html/guides/rel_notes/release_17_05.html
23 .. This section should contain new features added in this release. Sample
26 * **Add a title in the past tense with a full stop.**
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.
32 If the feature adds a lot of sub-features you can use a bullet list like
35 * Added feature foo to do something.
36 * Enhanced feature bar to do something else.
38 Refer to the previous release notes for examples.
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 =========================================================
44 * **Added free Tx mbuf on demand API.**
46 Added a new function ``rte_eth_tx_done_cleanup()`` which allows an application
47 to request the driver to release mbufs from their Tx ring that are no longer
48 in use, independent of whether or not the ``tx_rs_thresh`` has been crossed.
50 * **Added descriptor status ethdev API.**
52 Added a new API to get the status of a descriptor.
54 For Rx, it is almost similar to the ``rx_descriptor_done`` API, except
55 it differentiates descriptors which are hold by the driver and not
56 returned to the hardware. For Tx, it is a new API.
58 * **Increased number of next hops for LPM IPv6 to 2^21.**
60 The next_hop field is extended from 8 bits to 21 bits for IPv6.
62 * **Added VFIO hotplug support.**
64 How hotplug supported with UIO and VFIO drivers.
66 * **Added powerpc support in pci probing for vfio-pci devices.**
68 sPAPR IOMMU based pci probing enabled for vfio-pci devices.
74 .. This section should contain bug fixes added to the relevant
75 sections. Sample format:
77 * **code/section Fixed issue in the past tense with a full stop.**
79 Add a short 1-2 sentence description of the resolved issue in the past
82 The title should contain the code/lib section like a commit message.
84 Add the entries in alphabetic order in the relevant sections below.
86 This section is a comment. do not overwrite or remove it.
87 Also, make sure to start the actual text at the margin.
88 =========================================================
114 .. This section should contain new known issues in this release. Sample format:
116 * **Add title in present tense with full stop.**
118 Add a short 1-2 sentence description of the known issue in the present
119 tense. Add information on any known workarounds.
121 This section is a comment. do not overwrite or remove it.
122 Also, make sure to start the actual text at the margin.
123 =========================================================
129 .. This section should contain API changes. Sample format:
131 * Add a short 1-2 sentence description of the API change. Use fixed width
132 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
135 This section is a comment. do not overwrite or remove it.
136 Also, make sure to start the actual text at the margin.
137 =========================================================
139 * The LPM ``next_hop`` field is extended from 8 bits to 21 bits for IPv6
140 while keeping ABI compatibility.
142 * **Reworked rte_ring library**
144 The rte_ring library has been reworked and updated. The following changes
145 have been made to it:
147 * removed the build-time setting ``CONFIG_RTE_RING_SPLIT_PROD_CONS``
148 * removed the build-time setting ``CONFIG_RTE_LIBRTE_RING_DEBUG``
149 * removed the build-time setting ``CONFIG_RTE_RING_PAUSE_REP_COUNT``
150 * removed the function ``rte_ring_set_water_mark`` as part of a general
151 removal of watermarks support in the library.
152 * added an extra parameter to the burst/bulk enqueue functions to
153 return the number of free spaces in the ring after enqueue. This can
154 be used by an application to implement its own watermark functionality.
155 * added an extra parameter to the burst/bulk dequeue functions to return
156 the number elements remaining in the ring after dequeue.
157 * changed the return value of the enqueue and dequeue bulk functions to
158 match that of the burst equivalents. In all cases, ring functions which
159 operate on multiple packets now return the number of elements enqueued
160 or dequeued, as appropriate. The updated functions are:
162 - ``rte_ring_mp_enqueue_bulk``
163 - ``rte_ring_sp_enqueue_bulk``
164 - ``rte_ring_enqueue_bulk``
165 - ``rte_ring_mc_dequeue_bulk``
166 - ``rte_ring_sc_dequeue_bulk``
167 - ``rte_ring_dequeue_bulk``
169 NOTE: the above functions all have different parameters as well as
170 different return values, due to the other listed changes above. This
171 means that all instances of the functions in existing code will be
172 flagged by the compiler. The return value usage should be checked
173 while fixing the compiler error due to the extra parameter.
178 .. This section should contain ABI changes. Sample format:
180 * Add a short 1-2 sentence description of the ABI change that was announced
181 in the previous releases and made in this release. Use fixed width quotes
182 for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
184 This section is a comment. do not overwrite or remove it.
185 Also, make sure to start the actual text at the margin.
186 =========================================================
192 .. This section should contain removed items in this release. Sample format:
194 * Add a short 1-2 sentence description of the removed item in the past
197 This section is a comment. do not overwrite or remove it.
198 Also, make sure to start the actual text at the margin.
199 =========================================================
201 * KNI vhost support removed.
204 Shared Library Versions
205 -----------------------
207 .. Update any library version updated in this release and prepend with a ``+``
211 + librte_cfgfile.so.2
214 This section is a comment. do not overwrite or remove it.
215 =========================================================
218 The libraries prepended with a plus sign were incremented in this version.
225 librte_cryptodev.so.2
226 librte_distributor.so.1
256 .. This section should contain a list of platforms that were tested with this
261 * <vendor> platform with <vendor> <type of devices> combinations
266 * Other relevant details...
268 This section is a comment. do not overwrite or remove it.
269 Also, make sure to start the actual text at the margin.
270 =========================================================