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_18_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 RSS hash and key update to CXGBE PMD.**
46 Support to update RSS hash and key has been added to CXGBE PMD.
48 * **Added CXGBE VF PMD.**
50 CXGBE VF Poll Mode Driver has been added to run DPDK over Chelsio
51 T5/T6 NIC VF instances.
53 * **Updated Solarflare network PMD.**
55 Updated the sfc_efx driver including the following changes:
57 * Added support for Solarflare XtremeScale X2xxx family adapters.
58 * Added support for NVGRE, VXLAN and GENEVE filters in flow API.
59 * Added support for DROP action in flow API.
65 .. This section should contain API changes. Sample format:
67 * Add a short 1-2 sentence description of the API change. Use fixed width
68 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
71 This section is a comment. Do not overwrite or remove it.
72 Also, make sure to start the actual text at the margin.
73 =========================================================
79 .. This section should contain ABI changes. Sample format:
81 * Add a short 1-2 sentence description of the ABI change that was announced
82 in the previous releases and made in this release. Use fixed width quotes
83 for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
85 This section is a comment. Do not overwrite or remove it.
86 Also, make sure to start the actual text at the margin.
87 =========================================================
93 .. This section should contain removed items in this release. Sample format:
95 * Add a short 1-2 sentence description of the removed item in the past
98 This section is a comment. Do not overwrite or remove it.
99 Also, make sure to start the actual text at the margin.
100 =========================================================
106 .. This section should contain new known issues in this release. Sample format:
108 * **Add title in present tense with full stop.**
110 Add a short 1-2 sentence description of the known issue in the present
111 tense. Add information on any known workarounds.
113 This section is a comment. Do not overwrite or remove it.
114 Also, make sure to start the actual text at the margin.
115 =========================================================
118 Shared Library Versions
119 -----------------------
121 .. Update any library version updated in this release and prepend with a ``+``
125 + librte_cfgfile.so.2
128 This section is a comment. Do not overwrite or remove it.
129 =========================================================
132 The libraries prepended with a plus sign were incremented in this version.
138 librte_bitratestats.so.2
140 librte_bus_fslmc.so.1
145 librte_cryptodev.so.4
146 librte_distributor.so.1
150 librte_flow_classify.so.1
158 librte_latencystats.so.1
171 librte_pmd_ixgbe.so.2
173 librte_pmd_softnic.so.1
174 librte_pmd_vhost.so.2
190 .. This section should contain a list of platforms that were tested with this
195 * <vendor> platform with <vendor> <type of devices> combinations
200 * Other relevant details...
202 This section is a comment. Do not overwrite or remove it.
203 Also, make sure to start the actual text at the margin.
204 =========================================================