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.
61 * **Added device event monitor framework.**
63 Added a general device event monitor framework at EAL, for device dynamic management.
64 Such as device hotplug awareness and actions adopted accordingly. The list of new APIs:
66 * ``rte_dev_event_monitor_start`` and ``rte_dev_event_monitor_stop`` are for
67 the event monitor enable and disable.
68 * ``rte_dev_event_callback_register`` and ``rte_dev_event_callback_unregister``
69 are for the user's callbacks register and unregister.
71 Linux uevent is supported as backend of this device event notification framework.
77 .. This section should contain API changes. Sample format:
79 * Add a short 1-2 sentence description of the API change. Use fixed width
80 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
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 =========================================================
87 * mbuf: The control mbuf API has been removed in v18.05. The impacted
88 functions and macros are:
90 - ``rte_ctrlmbuf_init()``
91 - ``rte_ctrlmbuf_alloc()``
92 - ``rte_ctrlmbuf_free()``
93 - ``rte_ctrlmbuf_data()``
94 - ``rte_ctrlmbuf_len()``
95 - ``rte_is_ctrlmbuf()``
98 The packet mbuf API should be used as a replacement.
100 * meter: updated to accommodate configuration profiles.
102 The meter API is changed to support meter configuration profiles. The
103 configuration profile represents the set of configuration parameters
104 for a given meter object, such as the rates and sizes for the token
105 buckets. These configuration parameters were previously the part of meter
106 object internal data strcuture. The separation of the configuration
107 parameters from meter object data structure results in reducing its
108 memory footprint which helps in better cache utilization when large number
109 of meter objects are used.
115 .. This section should contain ABI changes. Sample format:
117 * Add a short 1-2 sentence description of the ABI change that was announced
118 in the previous releases and made in this release. Use fixed width quotes
119 for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
121 This section is a comment. Do not overwrite or remove it.
122 Also, make sure to start the actual text at the margin.
123 =========================================================
129 .. This section should contain removed items in this release. Sample format:
131 * Add a short 1-2 sentence description of the removed item in the past
134 This section is a comment. Do not overwrite or remove it.
135 Also, make sure to start the actual text at the margin.
136 =========================================================
142 .. This section should contain new known issues in this release. Sample format:
144 * **Add title in present tense with full stop.**
146 Add a short 1-2 sentence description of the known issue in the present
147 tense. Add information on any known workarounds.
149 This section is a comment. Do not overwrite or remove it.
150 Also, make sure to start the actual text at the margin.
151 =========================================================
154 Shared Library Versions
155 -----------------------
157 .. Update any library version updated in this release and prepend with a ``+``
161 + librte_cfgfile.so.2
164 This section is a comment. Do not overwrite or remove it.
165 =========================================================
168 The libraries prepended with a plus sign were incremented in this version.
174 librte_bitratestats.so.2
176 librte_bus_fslmc.so.1
181 + librte_common_octeontx.so.1
182 librte_cryptodev.so.4
183 librte_distributor.so.1
187 librte_flow_classify.so.1
195 librte_latencystats.so.1
208 librte_pmd_ixgbe.so.2
210 librte_pmd_softnic.so.1
211 librte_pmd_vhost.so.2
227 .. This section should contain a list of platforms that were tested with this
232 * <vendor> platform with <vendor> <type of devices> combinations
237 * Other relevant details...
239 This section is a comment. Do not overwrite or remove it.
240 Also, make sure to start the actual text at the margin.
241 =========================================================