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 * **Updated NXP crypto PMDs for PDCP support.**
61 PDCP support is added to DPAA_SEC and DPAA2_SEC PMDs using rte_security APIs.
62 Support is added for all sequence number sizes for control and user plane.
63 Test application is updated for unit testing.
65 * **Updated the Intel QuickAssist Technology (QAT) compression PMD.**
67 Added stateful decompression support in the Intel QuickAssist Technology PMD.
68 Please note that stateful compression is not supported.
74 .. This section should contain removed items in this release. Sample format:
76 * Add a short 1-2 sentence description of the removed item
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 =========================================================
83 * Removed duplicated set of commands for RX offloading configuration from app/testpmd:
84 “port config all crc-strip|scatter|rx-cksum|rx-timestamp|hw-vlan|hw-vlan-filter|
85 hw-vlan-strip|hw-vlan-extend on|off”.
87 The testpmd commands set that can be used instead in order to enable or disable Rx
88 offloading on all Rx queues of a port is:
89 "port config <port_id> rx_offload crc_strip|scatter|ipv4_cksum|udp_cksum|tcp_cksum|
90 timestamp|vlan_strip|vlan_filter|vlan_extend on|off"
96 .. This section should contain API changes. Sample format:
98 * sample: Add a short 1-2 sentence description of the API change
99 which was announced in the previous releases and made in this release.
100 Start with a scope label like "ethdev:".
101 Use fixed width quotes for ``function_names`` or ``struct_names``.
104 This section is a comment. Do not overwrite or remove it.
105 Also, make sure to start the actual text at the margin.
106 =========================================================
112 .. This section should contain ABI changes. Sample format:
114 * sample: Add a short 1-2 sentence description of the ABI change
115 which was announced in the previous releases and made in this release.
116 Start with a scope label like "ethdev:".
117 Use fixed width quotes for ``function_names`` or ``struct_names``.
120 This section is a comment. Do not overwrite or remove it.
121 Also, make sure to start the actual text at the margin.
122 =========================================================
125 Shared Library Versions
126 -----------------------
128 .. Update any library version updated in this release
129 and prepend with a ``+`` sign, like this:
135 This section is a comment. Do not overwrite or remove it.
136 =========================================================
138 The libraries prepended with a plus sign were incremented in this version.
144 librte_bitratestats.so.2
147 librte_bus_fslmc.so.2
148 librte_bus_ifpga.so.2
151 librte_bus_vmbus.so.2
154 librte_compressdev.so.1
155 librte_cryptodev.so.8
156 librte_distributor.so.1
161 librte_flow_classify.so.1
170 librte_latencystats.so.1
184 librte_pmd_ixgbe.so.2
185 librte_pmd_dpaa2_qdma.so.1
187 librte_pmd_softnic.so.1
188 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 =========================================================