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 =========================================================
48 .. This section should contain bug fixes added to the relevant
49 sections. Sample format:
51 * **code/section Fixed issue in the past tense with a full stop.**
53 Add a short 1-2 sentence description of the resolved issue in the past
56 The title should contain the code/lib section like a commit message.
58 Add the entries in alphabetic order in the relevant sections below.
60 This section is a comment. do not overwrite or remove it.
61 Also, make sure to start the actual text at the margin.
62 =========================================================
68 * **Service core fails to call service callback due to atomic lock**
70 In a specific configuration of multi-thread unsafe services and service
71 cores, a service core previously did not correctly release the atomic lock
72 on the service. This would result in the cores polling the service, but it
73 looked like another thread was executing the service callback. The logic for
74 atomic locking of the services has been fixed and refactored for readability.
95 .. This section should contain new known issues in this release. Sample format:
97 * **Add title in present tense with full stop.**
99 Add a short 1-2 sentence description of the known issue in the present
100 tense. Add information on any known workarounds.
102 This section is a comment. do not overwrite or remove it.
103 Also, make sure to start the actual text at the margin.
104 =========================================================
110 .. This section should contain API changes. Sample format:
112 * Add a short 1-2 sentence description of the API change. Use fixed width
113 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
116 This section is a comment. do not overwrite or remove it.
117 Also, make sure to start the actual text at the margin.
118 =========================================================
120 * **Service cores API updated for usability**
122 The service cores API has been changed, removing pointers from the API
123 where possible, instead using integer IDs to identify each service. This
124 simplifed application code, aids debugging, and provides better
125 encapsulation. A summary of the main changes made is as follows:
127 * Services identified by ID not by ``rte_service_spec`` pointer
128 * Reduced API surface by using ``set`` functions instead of enable/disable
129 * Reworked ``rte_service_register`` to provide the service ID to registrar
130 * Rework start and stop APIs into ``rte_service_runstate_set``
131 * Added API to set runstate of service implementation to indicate readyness
137 .. This section should contain ABI changes. Sample format:
139 * Add a short 1-2 sentence description of the ABI change that was announced
140 in the previous releases and made in this release. Use fixed width quotes
141 for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
143 This section is a comment. do not overwrite or remove it.
144 Also, make sure to start the actual text at the margin.
145 =========================================================
149 Shared Library Versions
150 -----------------------
152 .. Update any library version updated in this release and prepend with a ``+``
156 + librte_cfgfile.so.2
159 This section is a comment. do not overwrite or remove it.
160 =========================================================
163 The libraries prepended with a plus sign were incremented in this version.
168 librte_bitratestats.so.1
171 librte_cryptodev.so.3
172 librte_distributor.so.1
182 librte_latencystats.so.1
206 .. This section should contain a list of platforms that were tested with this
211 * <vendor> platform with <vendor> <type of devices> combinations
216 * Other relevant details...
218 This section is a comment. do not overwrite or remove it.
219 Also, make sure to start the actual text at the margin.
220 =========================================================