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 Flow API support for CXGBE PMD.**
46 Flow API support has been added to CXGBE Poll Mode Driver to offload
47 flows to Chelsio T5/T6 NICs.
49 * **Added ixgbe preferred Rx/Tx parameters.**
51 Rather than applications providing explicit Rx and Tx parameters such as
52 queue and burst sizes, they can request that the EAL instead uses preferred
53 values provided by the PMD, falling back to defaults within the EAL if the
54 PMD does not provide any. The provision of such tuned values now includes
57 * **Added descriptor status check support for fm10k.**
59 ``rte_eth_rx_descritpr_status`` and ``rte_eth_tx_descriptor_status``
60 are supported by fm10K.
62 * **Updated the enic driver.**
64 * Add support for mbuf fast free offload.
65 * Add low cycle count Tx handler for no-offload Tx (except mbuf fast free).
66 * Add low cycle count Rx handler for non-scattered Rx.
67 * Minor performance improvements to scattered Rx handler.
68 * Add handlers to add/delete VxLAN port number.
69 * Add devarg to specify ingress VLAN rewrite mode.
75 .. This section should contain API changes. Sample format:
77 * Add a short 1-2 sentence description of the API change.
78 Use fixed width quotes for ``function_names`` or ``struct_names``.
81 This section is a comment. Do not overwrite or remove it.
82 Also, make sure to start the actual text at the margin.
83 =========================================================
85 * cryptodev: In struct ``struct rte_cryptodev_info``, field ``rte_pci_device *pci_dev``
86 has been replaced with field ``struct rte_device *device``.
87 Value 0 is accepted in ``sym.max_nb_sessions``, meaning that a device
88 supports an unlimited number of sessions.
90 * cryptodev: Following functions were deprecated and are removed in 18.08:
92 - ``rte_cryptodev_queue_pair_start``
93 - ``rte_cryptodev_queue_pair_stop``
95 * compressdev: Feature flag ``RTE_COMP_FF_MBUF_SCATTER_GATHER`` is
96 replaced with the following more explicit flags:
97 - ``RTE_COMP_FF_OOP_SGL_IN_SGL_OUT``
98 - ``RTE_COMP_FF_OOP_SGL_IN_LB_OUT``
99 - ``RTE_COMP_FF_OOP_LB_IN_SGL_OUT``
105 .. This section should contain ABI changes. Sample format:
107 * Add a short 1-2 sentence description of the ABI change
108 that was announced in the previous releases and made in this release.
109 Use fixed width quotes for ``function_names`` or ``struct_names``.
112 This section is a comment. Do not overwrite or remove it.
113 Also, make sure to start the actual text at the margin.
114 =========================================================
120 .. This section should contain removed items in this release. Sample format:
122 * Add a short 1-2 sentence description of the removed item
125 This section is a comment. Do not overwrite or remove it.
126 Also, make sure to start the actual text at the margin.
127 =========================================================
130 Shared Library Versions
131 -----------------------
133 .. Update any library version updated in this release
134 and prepend with a ``+`` sign, like this:
137 + librte_cfgfile.so.2
140 This section is a comment. Do not overwrite or remove it.
141 =========================================================
143 The libraries prepended with a plus sign were incremented in this version.
149 librte_bitratestats.so.2
152 librte_bus_fslmc.so.1
157 librte_common_octeontx.so.1
158 librte_compressdev.so.1
159 + librte_cryptodev.so.5
160 librte_distributor.so.1
164 librte_flow_classify.so.1
172 librte_latencystats.so.1
185 librte_pmd_ixgbe.so.2
186 librte_pmd_dpaa2_cmdif.so.1
187 librte_pmd_dpaa2_qdma.so.1
189 librte_pmd_softnic.so.1
190 librte_pmd_vhost.so.2
206 .. This section should contain new known issues in this release. Sample format:
208 * **Add title in present tense with full stop.**
210 Add a short 1-2 sentence description of the known issue
211 in the present tense. Add information on any known workarounds.
213 This section is a comment. Do not overwrite or remove it.
214 Also, make sure to start the actual text at the margin.
215 =========================================================
221 .. This section should contain a list of platforms that were tested
226 * <vendor> platform with <vendor> <type of devices> combinations
231 * Other relevant details...
233 This section is a comment. Do not overwrite or remove it.
234 Also, make sure to start the actual text at the margin.
235 =========================================================