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 * **Updated Solarflare network PMD.**
50 Updated the sfc_efx driver including the following changes:
52 * Added support for NVGRE, VXLAN and GENEVE filters in flow API.
53 * Added support for DROP action in flow API.
59 .. This section should contain API changes. Sample format:
61 * Add a short 1-2 sentence description of the API change. Use fixed width
62 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
65 This section is a comment. Do not overwrite or remove it.
66 Also, make sure to start the actual text at the margin.
67 =========================================================
73 .. This section should contain ABI changes. Sample format:
75 * Add a short 1-2 sentence description of the ABI change that was announced
76 in the previous releases and made in this release. Use fixed width quotes
77 for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
79 This section is a comment. Do not overwrite or remove it.
80 Also, make sure to start the actual text at the margin.
81 =========================================================
87 .. This section should contain removed items in this release. Sample format:
89 * Add a short 1-2 sentence description of the removed item in the past
92 This section is a comment. Do not overwrite or remove it.
93 Also, make sure to start the actual text at the margin.
94 =========================================================
100 .. This section should contain new known issues in this release. Sample format:
102 * **Add title in present tense with full stop.**
104 Add a short 1-2 sentence description of the known issue in the present
105 tense. Add information on any known workarounds.
107 This section is a comment. Do not overwrite or remove it.
108 Also, make sure to start the actual text at the margin.
109 =========================================================
112 Shared Library Versions
113 -----------------------
115 .. Update any library version updated in this release and prepend with a ``+``
119 + librte_cfgfile.so.2
122 This section is a comment. Do not overwrite or remove it.
123 =========================================================
126 The libraries prepended with a plus sign were incremented in this version.
132 librte_bitratestats.so.2
134 librte_bus_fslmc.so.1
139 librte_cryptodev.so.4
140 librte_distributor.so.1
144 librte_flow_classify.so.1
152 librte_latencystats.so.1
165 librte_pmd_ixgbe.so.2
167 librte_pmd_softnic.so.1
168 librte_pmd_vhost.so.2
184 .. This section should contain a list of platforms that were tested with this
189 * <vendor> platform with <vendor> <type of devices> combinations
194 * Other relevant details...
196 This section is a comment. Do not overwrite or remove it.
197 Also, make sure to start the actual text at the margin.
198 =========================================================