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 * **Increased number of next hops for LPM IPv6 to 2^21.**
52 The next_hop field is extended from 8 bits to 21 bits for IPv6.
54 * **Added powerpc support in pci probing for vfio-pci devices.**
56 sPAPR IOMMU based pci probing enabled for vfio-pci devices.
62 .. This section should contain bug fixes added to the relevant
63 sections. Sample format:
65 * **code/section Fixed issue in the past tense with a full stop.**
67 Add a short 1-2 sentence description of the resolved issue in the past
70 The title should contain the code/lib section like a commit message.
72 Add the entries in alphabetic order in the relevant sections below.
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 =========================================================
102 .. This section should contain new known issues in this release. Sample format:
104 * **Add title in present tense with full stop.**
106 Add a short 1-2 sentence description of the known issue in the present
107 tense. Add information on any known workarounds.
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 =========================================================
117 .. This section should contain API changes. Sample format:
119 * Add a short 1-2 sentence description of the API change. Use fixed width
120 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
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 =========================================================
127 * The LPM ``next_hop`` field is extended from 8 bits to 21 bits for IPv6
128 while keeping ABI compatibility.
130 * **Reworked rte_ring library**
132 The rte_ring library has been reworked and updated. The following changes
133 have been made to it:
135 * removed the build-time setting ``CONFIG_RTE_RING_SPLIT_PROD_CONS``
136 * removed the build-time setting ``CONFIG_RTE_LIBRTE_RING_DEBUG``
141 .. This section should contain ABI changes. Sample format:
143 * Add a short 1-2 sentence description of the ABI change that was announced
144 in the previous releases and made in this release. Use fixed width quotes
145 for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
147 This section is a comment. do not overwrite or remove it.
148 Also, make sure to start the actual text at the margin.
149 =========================================================
155 .. This section should contain removed items in this release. Sample format:
157 * Add a short 1-2 sentence description of the removed item in the past
160 This section is a comment. do not overwrite or remove it.
161 Also, make sure to start the actual text at the margin.
162 =========================================================
164 * KNI vhost support removed.
167 Shared Library Versions
168 -----------------------
170 .. Update any library version updated in this release and prepend with a ``+``
174 + librte_cfgfile.so.2
177 This section is a comment. do not overwrite or remove it.
178 =========================================================
181 The libraries prepended with a plus sign were incremented in this version.
188 librte_cryptodev.so.2
189 librte_distributor.so.1
219 .. This section should contain a list of platforms that were tested with this
224 * <vendor> platform with <vendor> <type of devices> combinations
229 * Other relevant details...
231 This section is a comment. do not overwrite or remove it.
232 Also, make sure to start the actual text at the margin.
233 =========================================================