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_11.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 * **Extended port_id range from uint8_t to uint16_t.**
46 Increased port_id range from 8 bits to 16 bits in order to support more than
47 256 ports in dpdk. All ethdev APIs which have port_id as parameter are changed
50 * **nfp: Added PF support.**
52 Previously Netronome's NFP PMD had just support for VFs. PF support is
53 just as a basic DPDK port and has no VF management yet.
55 PF support comes with firmware upload support which allows the PMD to
56 independently work from kernel netdev NFP drivers.
58 NFP 4000 devices are also now supported along with previous 6000 devices.
60 * **Updated bnxt PMD.**
62 Major enhancements include:
64 * Support for Flow API
65 * Support for Tx and Rx descriptor status functions
71 .. This section should contain bug fixes added to the relevant
72 sections. Sample format:
74 * **code/section Fixed issue in the past tense with a full stop.**
76 Add a short 1-2 sentence description of the resolved issue in the past
79 The title should contain the code/lib section like a commit message.
81 Add the entries in alphabetic order in the relevant sections below.
83 This section is a comment. do not overwrite or remove it.
84 Also, make sure to start the actual text at the margin.
85 =========================================================
91 * **Service core fails to call service callback due to atomic lock**
93 In a specific configuration of multi-thread unsafe services and service
94 cores, a service core previously did not correctly release the atomic lock
95 on the service. This would result in the cores polling the service, but it
96 looked like another thread was executing the service callback. The logic for
97 atomic locking of the services has been fixed and refactored for readability.
118 .. This section should contain new known issues in this release. Sample format:
120 * **Add title in present tense with full stop.**
122 Add a short 1-2 sentence description of the known issue in the present
123 tense. Add information on any known workarounds.
125 This section is a comment. do not overwrite or remove it.
126 Also, make sure to start the actual text at the margin.
127 =========================================================
133 .. This section should contain API changes. Sample format:
135 * Add a short 1-2 sentence description of the API change. Use fixed width
136 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
139 This section is a comment. do not overwrite or remove it.
140 Also, make sure to start the actual text at the margin.
141 =========================================================
143 * **Service cores API updated for usability**
145 The service cores API has been changed, removing pointers from the API
146 where possible, instead using integer IDs to identify each service. This
147 simplifed application code, aids debugging, and provides better
148 encapsulation. A summary of the main changes made is as follows:
150 * Services identified by ID not by ``rte_service_spec`` pointer
151 * Reduced API surface by using ``set`` functions instead of enable/disable
152 * Reworked ``rte_service_register`` to provide the service ID to registrar
153 * Rework start and stop APIs into ``rte_service_runstate_set``
154 * Added API to set runstate of service implementation to indicate readyness
160 .. This section should contain ABI changes. Sample format:
162 * Add a short 1-2 sentence description of the ABI change that was announced
163 in the previous releases and made in this release. Use fixed width quotes
164 for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
166 This section is a comment. do not overwrite or remove it.
167 Also, make sure to start the actual text at the margin.
168 =========================================================
170 * **Extended port_id range.**
172 The size of the field ``port_id`` in the ``rte_eth_dev_data`` structure
173 changed, as described in the `New Features` section.
175 Shared Library Versions
176 -----------------------
178 .. Update any library version updated in this release and prepend with a ``+``
182 + librte_cfgfile.so.2
185 This section is a comment. do not overwrite or remove it.
186 =========================================================
189 The libraries prepended with a plus sign were incremented in this version.
194 librte_bitratestats.so.2
197 librte_cryptodev.so.3
198 librte_distributor.so.1
208 librte_latencystats.so.1
220 librte_pmd_ixgbe.so.2
222 librte_pmd_vhost.so.2
236 .. This section should contain a list of platforms that were tested with this
241 * <vendor> platform with <vendor> <type of devices> combinations
246 * Other relevant details...
248 This section is a comment. do not overwrite or remove it.
249 Also, make sure to start the actual text at the margin.
250 =========================================================