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.
66 .. This section should contain API changes. Sample format:
68 * Add a short 1-2 sentence description of the API change.
69 Use fixed width quotes for ``function_names`` or ``struct_names``.
72 This section is a comment. Do not overwrite or remove it.
73 Also, make sure to start the actual text at the margin.
74 =========================================================
80 .. This section should contain ABI changes. Sample format:
82 * Add a short 1-2 sentence description of the ABI change
83 that was announced in the previous releases and made in this release.
84 Use fixed width quotes for ``function_names`` or ``struct_names``.
87 This section is a comment. Do not overwrite or remove it.
88 Also, make sure to start the actual text at the margin.
89 =========================================================
95 .. This section should contain removed items in this release. Sample format:
97 * Add a short 1-2 sentence description of the removed item
100 This section is a comment. Do not overwrite or remove it.
101 Also, make sure to start the actual text at the margin.
102 =========================================================
105 Shared Library Versions
106 -----------------------
108 .. Update any library version updated in this release
109 and prepend with a ``+`` sign, like this:
112 + librte_cfgfile.so.2
115 This section is a comment. Do not overwrite or remove it.
116 =========================================================
118 The libraries prepended with a plus sign were incremented in this version.
124 librte_bitratestats.so.2
127 librte_bus_fslmc.so.1
132 librte_common_octeontx.so.1
133 librte_compressdev.so.1
134 librte_cryptodev.so.4
135 librte_distributor.so.1
139 librte_flow_classify.so.1
147 librte_latencystats.so.1
160 librte_pmd_ixgbe.so.2
161 librte_pmd_dpaa2_cmdif.so.1
162 librte_pmd_dpaa2_qdma.so.1
164 librte_pmd_softnic.so.1
165 librte_pmd_vhost.so.2
181 .. This section should contain new known issues in this release. Sample format:
183 * **Add title in present tense with full stop.**
185 Add a short 1-2 sentence description of the known issue
186 in the present tense. Add information on any known workarounds.
188 This section is a comment. Do not overwrite or remove it.
189 Also, make sure to start the actual text at the margin.
190 =========================================================
196 .. This section should contain a list of platforms that were tested
201 * <vendor> platform with <vendor> <type of devices> combinations
206 * Other relevant details...
208 This section is a comment. Do not overwrite or remove it.
209 Also, make sure to start the actual text at the margin.
210 =========================================================