1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright 2019 The DPDK contributors
4 .. include:: <isonum.txt>
9 .. **Read this first.**
11 The text in the sections below explains how to update the release notes.
13 Use proper spelling, capitalization and punctuation in all sections.
15 Variable and config names should be quoted as fixed width text:
18 Build the docs and view the output file to ensure the changes are correct::
22 xdg-open build/doc/html/guides/rel_notes/release_19_11.html
28 .. This section should contain new features added in this release.
31 * **Add a title in the past tense with a full stop.**
33 Add a short 1-2 sentence description in the past tense.
34 The description should be enough to allow someone scanning
35 the release notes to understand the new feature.
37 If the feature adds a lot of sub-features you can use a bullet list
40 * Added feature foo to do something.
41 * Enhanced feature bar to do something else.
43 Refer to the previous release notes for examples.
45 Suggested order in release notes items:
46 * Core libs (EAL, mempool, ring, mbuf, buses)
47 * Device abstraction libs and PMDs
49 - cryptodev (lib, PMDs)
50 - eventdev (lib, PMDs)
53 * Apps, Examples, Tools (if significant)
55 This section is a comment. Do not overwrite or remove it.
56 Also, make sure to start the actual text at the margin.
57 =========================================================
59 * **Add support of support dynamic fields and flags in mbuf.**
61 This new feature adds the ability to dynamically register some room
62 for a field or a flag in the mbuf structure. This is typically used
63 for specific offload features, where adding a static field or flag
64 in the mbuf is not justified.
70 .. This section should contain removed items in this release. Sample format:
72 * Add a short 1-2 sentence description of the removed item
75 This section is a comment. Do not overwrite or remove it.
76 Also, make sure to start the actual text at the margin.
77 =========================================================
79 * Removed duplicated set of commands for RX offloading configuration from app/testpmd:
80 “port config all crc-strip|scatter|rx-cksum|rx-timestamp|hw-vlan|hw-vlan-filter|
81 hw-vlan-strip|hw-vlan-extend on|off”.
83 The testpmd commands set that can be used instead in order to enable or disable Rx
84 offloading on all Rx queues of a port is:
85 "port config <port_id> rx_offload crc_strip|scatter|ipv4_cksum|udp_cksum|tcp_cksum|
86 timestamp|vlan_strip|vlan_filter|vlan_extend on|off"
92 .. This section should contain API changes. Sample format:
94 * sample: Add a short 1-2 sentence description of the API change
95 which was announced in the previous releases and made in this release.
96 Start with a scope label like "ethdev:".
97 Use fixed width quotes for ``function_names`` or ``struct_names``.
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 =========================================================
108 .. This section should contain ABI changes. Sample format:
110 * sample: Add a short 1-2 sentence description of the ABI change
111 which was announced in the previous releases and made in this release.
112 Start with a scope label like "ethdev:".
113 Use fixed width quotes for ``function_names`` or ``struct_names``.
116 This section is a comment. Do not overwrite or remove it.
117 Also, make sure to start the actual text at the margin.
118 =========================================================
121 Shared Library Versions
122 -----------------------
124 .. Update any library version updated in this release
125 and prepend with a ``+`` sign, like this:
131 This section is a comment. Do not overwrite or remove it.
132 =========================================================
134 The libraries prepended with a plus sign were incremented in this version.
140 librte_bitratestats.so.2
143 librte_bus_fslmc.so.2
144 librte_bus_ifpga.so.2
147 librte_bus_vmbus.so.2
150 librte_compressdev.so.1
151 librte_cryptodev.so.8
152 librte_distributor.so.1
157 librte_flow_classify.so.1
166 librte_latencystats.so.1
180 librte_pmd_ixgbe.so.2
181 librte_pmd_dpaa2_qdma.so.1
183 librte_pmd_softnic.so.1
184 librte_pmd_vhost.so.2
202 .. This section should contain new known issues in this release. Sample format:
204 * **Add title in present tense with full stop.**
206 Add a short 1-2 sentence description of the known issue
207 in the present tense. Add information on any known workarounds.
209 This section is a comment. Do not overwrite or remove it.
210 Also, make sure to start the actual text at the margin.
211 =========================================================
217 .. This section should contain a list of platforms that were tested
222 * <vendor> platform with <vendor> <type of devices> combinations
227 * Other relevant details...
229 This section is a comment. Do not overwrite or remove it.
230 Also, make sure to start the actual text at the margin.
231 =========================================================