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 powerpc support in pci probing for vfio-pci devices.**
64 sPAPR IOMMU based pci probing enabled for vfio-pci devices.
70 .. This section should contain bug fixes added to the relevant
71 sections. Sample format:
73 * **code/section Fixed issue in the past tense with a full stop.**
75 Add a short 1-2 sentence description of the resolved issue in the past
78 The title should contain the code/lib section like a commit message.
80 Add the entries in alphabetic order in the relevant sections below.
82 This section is a comment. do not overwrite or remove it.
83 Also, make sure to start the actual text at the margin.
84 =========================================================
110 .. This section should contain new known issues in this release. Sample format:
112 * **Add title in present tense with full stop.**
114 Add a short 1-2 sentence description of the known issue in the present
115 tense. Add information on any known workarounds.
117 This section is a comment. do not overwrite or remove it.
118 Also, make sure to start the actual text at the margin.
119 =========================================================
125 .. This section should contain API changes. Sample format:
127 * Add a short 1-2 sentence description of the API change. Use fixed width
128 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
131 This section is a comment. do not overwrite or remove it.
132 Also, make sure to start the actual text at the margin.
133 =========================================================
135 * The LPM ``next_hop`` field is extended from 8 bits to 21 bits for IPv6
136 while keeping ABI compatibility.
138 * **Reworked rte_ring library**
140 The rte_ring library has been reworked and updated. The following changes
141 have been made to it:
143 * removed the build-time setting ``CONFIG_RTE_RING_SPLIT_PROD_CONS``
144 * removed the build-time setting ``CONFIG_RTE_LIBRTE_RING_DEBUG``
145 * removed the build-time setting ``CONFIG_RTE_RING_PAUSE_REP_COUNT``
146 * removed the function ``rte_ring_set_water_mark`` as part of a general
147 removal of watermarks support in the library.
148 * added an extra parameter to the burst/bulk enqueue functions to
149 return the number of free spaces in the ring after enqueue. This can
150 be used by an application to implement its own watermark functionality.
151 * added an extra parameter to the burst/bulk dequeue functions to return
152 the number elements remaining in the ring after dequeue.
153 * changed the return value of the enqueue and dequeue bulk functions to
154 match that of the burst equivalents. In all cases, ring functions which
155 operate on multiple packets now return the number of elements enqueued
156 or dequeued, as appropriate. The updated functions are:
158 - ``rte_ring_mp_enqueue_bulk``
159 - ``rte_ring_sp_enqueue_bulk``
160 - ``rte_ring_enqueue_bulk``
161 - ``rte_ring_mc_dequeue_bulk``
162 - ``rte_ring_sc_dequeue_bulk``
163 - ``rte_ring_dequeue_bulk``
165 NOTE: the above functions all have different parameters as well as
166 different return values, due to the other listed changes above. This
167 means that all instances of the functions in existing code will be
168 flagged by the compiler. The return value usage should be checked
169 while fixing the compiler error due to the extra parameter.
174 .. This section should contain ABI changes. Sample format:
176 * Add a short 1-2 sentence description of the ABI change that was announced
177 in the previous releases and made in this release. Use fixed width quotes
178 for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
180 This section is a comment. do not overwrite or remove it.
181 Also, make sure to start the actual text at the margin.
182 =========================================================
188 .. This section should contain removed items in this release. Sample format:
190 * Add a short 1-2 sentence description of the removed item in the past
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 =========================================================
197 * KNI vhost support removed.
200 Shared Library Versions
201 -----------------------
203 .. Update any library version updated in this release and prepend with a ``+``
207 + librte_cfgfile.so.2
210 This section is a comment. do not overwrite or remove it.
211 =========================================================
214 The libraries prepended with a plus sign were incremented in this version.
221 librte_cryptodev.so.2
222 librte_distributor.so.1
252 .. This section should contain a list of platforms that were tested with this
257 * <vendor> platform with <vendor> <type of devices> combinations
262 * Other relevant details...
264 This section is a comment. do not overwrite or remove it.
265 Also, make sure to start the actual text at the margin.
266 =========================================================