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_08.html
23 .. This section should contain new features added in this release.
26 * **Add a title in the past tense with a full stop.**
28 Add a short 1-2 sentence description in the past tense.
29 The description should be enough to allow someone scanning
30 the release notes to understand the new feature.
32 If the feature adds a lot of sub-features you can use a bullet list
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 support for Hyper-V netvsc PMD.**
46 The new ``netvsc`` poll mode driver provides native support for
47 networking on Hyper-V. See the :doc:`../nics/netvsc` NIC driver guide
48 for more details on this new driver.
50 * **Added Flow API support for CXGBE PMD.**
52 Flow API support has been added to CXGBE Poll Mode Driver to offload
53 flows to Chelsio T5/T6 NICs.
55 * **Added ixgbe preferred Rx/Tx parameters.**
57 Rather than applications providing explicit Rx and Tx parameters such as
58 queue and burst sizes, they can request that the EAL instead uses preferred
59 values provided by the PMD, falling back to defaults within the EAL if the
60 PMD does not provide any. The provision of such tuned values now includes
63 * **Added descriptor status check support for fm10k.**
65 ``rte_eth_rx_descritpr_status`` and ``rte_eth_tx_descriptor_status``
66 are supported by fm10K.
68 * **Updated the enic driver.**
70 * Add support for mbuf fast free offload.
71 * Add low cycle count Tx handler for no-offload Tx (except mbuf fast free).
72 * Add low cycle count Rx handler for non-scattered Rx.
73 * Minor performance improvements to scattered Rx handler.
74 * Add handlers to add/delete VxLAN port number.
75 * Add devarg to specify ingress VLAN rewrite mode.
77 * **Added a new compression PMD using Intel's QuickAssist (QAT) device family.**
79 Added the new ``QAT`` compression driver, for compression and decompression
80 operations in software. See the :doc:`../compressdevs/qat_comp` compression
81 driver guide for details on this new driver.
87 .. This section should contain API changes. Sample format:
89 * Add a short 1-2 sentence description of the API change.
90 Use fixed width quotes for ``function_names`` or ``struct_names``.
93 This section is a comment. Do not overwrite or remove it.
94 Also, make sure to start the actual text at the margin.
95 =========================================================
97 * Path to runtime config file has changed. The new path is determined as
100 - If DPDK is running as root, ``/var/run/dpdk/<prefix>/config``
101 - If DPDK is not running as root:
103 * If ``$XDG_RUNTIME_DIR`` is set, ``${XDG_RUNTIME_DIR}/dpdk/<prefix>/config``
104 * Otherwise, ``/tmp/dpdk/<prefix>/config``
106 * cryptodev: In struct ``struct rte_cryptodev_info``, field ``rte_pci_device *pci_dev``
107 has been replaced with field ``struct rte_device *device``.
108 Value 0 is accepted in ``sym.max_nb_sessions``, meaning that a device
109 supports an unlimited number of sessions.
110 Two new fields of type ``uint16_t`` have been added:
111 ``min_mbuf_headroom_req`` and ``min_mbuf_tailroom_req``.
112 These parameters specify the recommended headroom and tailroom for mbufs
113 to be processed by the PMD.
115 * cryptodev: Following functions were deprecated and are removed in 18.08:
117 - ``rte_cryptodev_queue_pair_start``
118 - ``rte_cryptodev_queue_pair_stop``
119 - ``rte_cryptodev_queue_pair_attach_sym_session``
120 - ``rte_cryptodev_queue_pair_detach_sym_session``
122 * cryptodev: Following functions were deprecated and are replaced by
123 other functions in 18.08:
125 - ``rte_cryptodev_get_header_session_size`` is replaced with
126 ``rte_cryptodev_sym_get_header_session_size``
127 - ``rte_cryptodev_get_private_session_size`` is replaced with
128 ``rte_cryptodev_sym_get_private_session_size``
130 * cryptodev: Feature flag ``RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER`` is
131 replaced with the following more explicit flags:
133 - ``RTE_CRYPTODEV_FF_IN_PLACE_SGL``
134 - ``RTE_CRYPTODEV_FF_OOP_SGL_IN_SGL_OUT``
135 - ``RTE_CRYPTODEV_FF_OOP_SGL_IN_LB_OUT``
136 - ``RTE_CRYPTODEV_FF_OOP_LB_IN_SGL_OUT``
137 - ``RTE_CRYPTODEV_FF_OOP_LB_IN_LB_OUT``
139 * cryptodev: Renamed cryptodev experimental APIs:
141 Used user_data instead of private_data in following APIs to avoid confusion
142 with the existing session parameter ``sess_private_data[]`` and related APIs.
144 - ``rte_cryptodev_sym_session_set_private_data()`` changed to
145 ``rte_cryptodev_sym_session_set_user_data()``
146 - ``rte_cryptodev_sym_session_get_private_data()`` changed to
147 ``rte_cryptodev_sym_session_get_user_data()``
149 * compressdev: Feature flag ``RTE_COMP_FF_MBUF_SCATTER_GATHER`` is
150 replaced with the following more explicit flags:
152 - ``RTE_COMP_FF_OOP_SGL_IN_SGL_OUT``
153 - ``RTE_COMP_FF_OOP_SGL_IN_LB_OUT``
154 - ``RTE_COMP_FF_OOP_LB_IN_SGL_OUT``
160 .. This section should contain ABI changes. Sample format:
162 * Add a short 1-2 sentence description of the ABI change
163 that was announced in the previous releases and made in this release.
164 Use fixed width quotes for ``function_names`` or ``struct_names``.
167 This section is a comment. Do not overwrite or remove it.
168 Also, make sure to start the actual text at the margin.
169 =========================================================
175 .. This section should contain removed items in this release. Sample format:
177 * Add a short 1-2 sentence description of the removed item
180 This section is a comment. Do not overwrite or remove it.
181 Also, make sure to start the actual text at the margin.
182 =========================================================
185 Shared Library Versions
186 -----------------------
188 .. Update any library version updated in this release
189 and prepend with a ``+`` sign, like this:
192 + librte_cfgfile.so.2
195 This section is a comment. Do not overwrite or remove it.
196 =========================================================
198 The libraries prepended with a plus sign were incremented in this version.
204 librte_bitratestats.so.2
207 librte_bus_fslmc.so.1
210 + librte_bus_vmbus.so.1
213 librte_common_octeontx.so.1
214 librte_compressdev.so.1
215 + librte_cryptodev.so.5
216 librte_distributor.so.1
220 librte_flow_classify.so.1
228 librte_latencystats.so.1
241 librte_pmd_ixgbe.so.2
242 librte_pmd_dpaa2_cmdif.so.1
243 librte_pmd_dpaa2_qdma.so.1
245 librte_pmd_softnic.so.1
246 librte_pmd_vhost.so.2
262 .. This section should contain new known issues in this release. Sample format:
264 * **Add title in present tense with full stop.**
266 Add a short 1-2 sentence description of the known issue
267 in the present tense. Add information on any known workarounds.
269 This section is a comment. Do not overwrite or remove it.
270 Also, make sure to start the actual text at the margin.
271 =========================================================
277 .. This section should contain a list of platforms that were tested
282 * <vendor> platform with <vendor> <type of devices> combinations
287 * Other relevant details...
289 This section is a comment. Do not overwrite or remove it.
290 Also, make sure to start the actual text at the margin.
291 =========================================================