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 =========================================================
75 * mbuf: The control mbuf API has been removed in v18.05. The impacted
76 functions and macros are:
78 - ``rte_ctrlmbuf_init()``
79 - ``rte_ctrlmbuf_alloc()``
80 - ``rte_ctrlmbuf_free()``
81 - ``rte_ctrlmbuf_data()``
82 - ``rte_ctrlmbuf_len()``
83 - ``rte_is_ctrlmbuf()``
86 The packet mbuf API should be used as a replacement.
88 * meter: updated to accommodate configuration profiles.
90 The meter API is changed to support meter configuration profiles. The
91 configuration profile represents the set of configuration parameters
92 for a given meter object, such as the rates and sizes for the token
93 buckets. These configuration parameters were previously the part of meter
94 object internal data strcuture. The separation of the configuration
95 parameters from meter object data structure results in reducing its
96 memory footprint which helps in better cache utilization when large number
97 of meter objects are used.
103 .. This section should contain ABI changes. Sample format:
105 * Add a short 1-2 sentence description of the ABI change that was announced
106 in the previous releases and made in this release. Use fixed width quotes
107 for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
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 removed items in this release. Sample format:
119 * Add a short 1-2 sentence description of the removed item in the past
122 This section is a comment. Do not overwrite or remove it.
123 Also, make sure to start the actual text at the margin.
124 =========================================================
130 .. This section should contain new known issues in this release. Sample format:
132 * **Add title in present tense with full stop.**
134 Add a short 1-2 sentence description of the known issue in the present
135 tense. Add information on any known workarounds.
137 This section is a comment. Do not overwrite or remove it.
138 Also, make sure to start the actual text at the margin.
139 =========================================================
142 Shared Library Versions
143 -----------------------
145 .. Update any library version updated in this release and prepend with a ``+``
149 + librte_cfgfile.so.2
152 This section is a comment. Do not overwrite or remove it.
153 =========================================================
156 The libraries prepended with a plus sign were incremented in this version.
162 librte_bitratestats.so.2
164 librte_bus_fslmc.so.1
169 + librte_common_octeontx.so.1
170 librte_cryptodev.so.4
171 librte_distributor.so.1
175 librte_flow_classify.so.1
183 librte_latencystats.so.1
196 librte_pmd_ixgbe.so.2
198 librte_pmd_softnic.so.1
199 librte_pmd_vhost.so.2
215 .. This section should contain a list of platforms that were tested with this
220 * <vendor> platform with <vendor> <type of devices> combinations
225 * Other relevant details...
227 This section is a comment. Do not overwrite or remove it.
228 Also, make sure to start the actual text at the margin.
229 =========================================================