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
67 * **Added Membership library (rte_member).**
69 Added membership library. It provides an API for DPDK applications to insert a
70 new member, delete an existing member, or query the existence of a member in a
71 given set, or a group of sets. For the case of a group of sets the library
72 will return not only whether the element has been inserted before in one of
73 the sets but also which set it belongs to.
75 The Membership Library is an extension and generalization of a traditional
76 filter (for example Bloom Filter) structure that has multiple usages in a wide
77 variety of workloads and applications. In general, the Membership Library is a
78 data structure that provides a “set-summary” and responds to set-membership
79 queries whether a certain member belongs to a set(s).
81 See the :ref:`Membership Library <Member_Library>` documentation in
82 the Programmers Guide document, for more information.
88 .. This section should contain bug fixes added to the relevant
89 sections. Sample format:
91 * **code/section Fixed issue in the past tense with a full stop.**
93 Add a short 1-2 sentence description of the resolved issue in the past
96 The title should contain the code/lib section like a commit message.
98 Add the entries in alphabetic order in the relevant sections below.
100 This section is a comment. do not overwrite or remove it.
101 Also, make sure to start the actual text at the margin.
102 =========================================================
108 * **Service core fails to call service callback due to atomic lock**
110 In a specific configuration of multi-thread unsafe services and service
111 cores, a service core previously did not correctly release the atomic lock
112 on the service. This would result in the cores polling the service, but it
113 looked like another thread was executing the service callback. The logic for
114 atomic locking of the services has been fixed and refactored for readability.
135 .. This section should contain new known issues in this release. Sample format:
137 * **Add title in present tense with full stop.**
139 Add a short 1-2 sentence description of the known issue in the present
140 tense. Add information on any known workarounds.
142 This section is a comment. do not overwrite or remove it.
143 Also, make sure to start the actual text at the margin.
144 =========================================================
150 .. This section should contain API changes. Sample format:
152 * Add a short 1-2 sentence description of the API change. Use fixed width
153 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
156 This section is a comment. do not overwrite or remove it.
157 Also, make sure to start the actual text at the margin.
158 =========================================================
160 * **Service cores API updated for usability**
162 The service cores API has been changed, removing pointers from the API
163 where possible, instead using integer IDs to identify each service. This
164 simplifed application code, aids debugging, and provides better
165 encapsulation. A summary of the main changes made is as follows:
167 * Services identified by ID not by ``rte_service_spec`` pointer
168 * Reduced API surface by using ``set`` functions instead of enable/disable
169 * Reworked ``rte_service_register`` to provide the service ID to registrar
170 * Rework start and stop APIs into ``rte_service_runstate_set``
171 * Added API to set runstate of service implementation to indicate readyness
173 * **The following changes made in mempool library**
175 * Moved ``flags`` datatype from int to unsigned int for ``rte_mempool``.
176 * Removed ``__rte_unused int flag`` param from ``rte_mempool_generic_put``
177 and ``rte_mempool_generic_get`` API.
178 * Added ``flags`` param in ``rte_mempool_xmem_size`` and
179 ``rte_mempool_xmem_usage``.
185 .. This section should contain ABI changes. Sample format:
187 * Add a short 1-2 sentence description of the ABI change that was announced
188 in the previous releases and made in this release. Use fixed width quotes
189 for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
191 This section is a comment. do not overwrite or remove it.
192 Also, make sure to start the actual text at the margin.
193 =========================================================
195 * **Extended port_id range.**
197 The size of the field ``port_id`` in the ``rte_eth_dev_data`` structure
198 changed, as described in the `New Features` section.
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.
219 librte_bitratestats.so.2
222 librte_cryptodev.so.3
223 librte_distributor.so.1
233 librte_latencystats.so.1
245 librte_pmd_ixgbe.so.2
247 librte_pmd_vhost.so.2
261 .. This section should contain a list of platforms that were tested with this
266 * <vendor> platform with <vendor> <type of devices> combinations
271 * Other relevant details...
273 This section is a comment. do not overwrite or remove it.
274 Also, make sure to start the actual text at the margin.
275 =========================================================