4 .. **Read this first.**
6 The text 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: ``LIKE_THIS``.
12 Build the docs and view the output file to ensure the changes are correct::
16 firefox build/doc/html/guides/rel_notes/release_16_11.html
22 .. This section should contain new features added in this release. Sample format:
24 * **Add a title in the past tense with a full stop.**
26 Add a short 1-2 sentence description in the past tense. The description
27 should be enough to allow someone scanning the release notes to understand
30 If the feature adds a lot of sub-features you can use a bullet list like this.
32 * Added feature foo to do something.
33 * Enhanced feature bar to do something else.
35 Refer to the previous release notes for examples.
37 This section is a comment. Make sure to start the actual text at the margin.
40 * **Added software parser for packet type.**
42 * Added a new function ``rte_pktmbuf_read()`` to read the packet data from an
43 mbuf chain, linearizing if required.
44 * Added a new function ``rte_net_get_ptype()`` to parse an Ethernet packet
45 in an mbuf chain and retrieve its packet type by software.
46 * Added new functions ``rte_get_ptype_*()`` to dump a packet type as a string.
48 * **Improved offloads support in mbuf.**
50 * Added a new function ``rte_raw_cksum_mbuf()`` to process the checksum of
51 data embedded in an mbuf chain.
52 * Added new Rx checksum flags in mbufs to describe more states: unknown,
53 good, bad, or not present (useful for virtual drivers). This modification
54 was done for IP and L4.
55 * Added a new RX LRO mbuf flag, used when packets are coalesced. This
56 flag indicates that the segment size of original packets is known.
58 * **Added vhost-user dequeue zero copy support**
60 The copy in dequeue path is saved, which is meant to improve the performance.
61 In the VM2VM case, the boost is quite impressive. The bigger the packet size,
62 the bigger performance boost you may get. However, for VM2NIC case, there
63 are some limitations, yet the boost is not that impressive as VM2VM case.
64 It may even drop quite a bit for small packets.
66 For such reason, this feature is disabled by default. It can be enabled when
67 ``RTE_VHOST_USER_DEQUEUE_ZERO_COPY`` flag is given. Check the vhost section
68 at programming guide for more information.
70 * **Added vhost-user indirect descriptors support.**
72 If indirect descriptor feature is negotiated, each packet sent by the guest
73 will take exactly one slot in the enqueue virtqueue. Without the feature, in
74 current version, even 64 bytes packets take two slots with Virtio PMD on guest
77 The main impact is better performance for 0% packet loss use-cases, as it
78 behaves as if the virtqueue size was enlarged, so more packets can be buffered
79 in case of system perturbations. On the downside, small performance degradation
80 is measured when running micro-benchmarks.
82 * **Added vhost PMD xstats.**
84 Added extended statistics to vhost PMD from per port perspective.
86 * **Added virtio NEON support for ARM.**
88 * **Updated the ixgbe base driver.**
90 Updated the ixgbe base driver, including the following changes:
92 * add X550em_a 10G PHY support
93 * support flow control auto negotiation for X550em_a 1G PHY
94 * add X550em_a FW ALEF support
95 * increase mailbox version to ixgbe_mbox_api_13
96 * add two MAC ops for Hyper-V support
98 * **Updated the QAT PMD.**
100 The QAT PMD was updated with following support:
103 * SHA224-HMAC algorithm
104 * SHA384-HMAC algorithm
106 * KASUMI (F8 and F9) algorithm
112 * **Added libcrypto PMD.**
114 A new crypto PMD has been added, which provides several ciphering and hashing.
115 All cryptography operations are using Openssl library crypto API.
117 * **Updated the IPsec example with following support:**
120 * AES CBC IV generation with cipher forward function
123 * **Added support for new gcc -march option.**
125 The GCC 4.9 ``-march`` option supports the Intel processor code names.
126 The config option ``RTE_MACHINE`` can be used to pass code names to the compiler as ``-march`` flag.
132 .. This section should contain bug fixes added to the relevant sections. Sample format:
134 * **code/section Fixed issue in the past tense with a full stop.**
136 Add a short 1-2 sentence description of the resolved issue in the past tense.
137 The title should contain the code/lib section like a commit message.
138 Add the entries in alphabetic order in the relevant sections below.
140 This section is a comment. Make sure to start the actual text at the margin.
166 .. This section should contain new known issues in this release. Sample format:
168 * **Add title in present tense with full stop.**
170 Add a short 1-2 sentence description of the known issue in the present
171 tense. Add information on any known workarounds.
173 This section is a comment. Make sure to start the actual text at the margin.
179 .. This section should contain API changes. Sample format:
181 * Add a short 1-2 sentence description of the API change. Use fixed width
182 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
184 This section is a comment. Make sure to start the actual text at the margin.
186 * The driver names have been changed. It especially impacts ``--vdev`` arguments.
187 Examples: ``eth_pcap`` becomes ``net_pcap``
188 and ``cryptodev_aesni_mb_pmd`` becomes ``crypto_aesni_mb``.
190 * The log history is removed.
192 * The ``rte_ivshmem`` feature (including library and EAL code) has been removed
193 in 16.11 because it had some design issues which were not planned to be fixed.
195 * The ``file_name`` data type of ``struct rte_port_source_params`` and
196 ``struct rte_port_sink_params`` is changed from `char *`` to ``const char *``.
202 .. This section should contain ABI changes. Sample format:
204 * Add a short 1-2 sentence description of the ABI change that was announced in
205 the previous releases and made in this release. Use fixed width quotes for
206 ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
208 This section is a comment. Make sure to start the actual text at the margin.
212 Shared Library Versions
213 -----------------------
215 .. Update any library version updated in this release and prepend with a ``+``
220 + librte_cfgfile.so.2
225 The libraries prepended with a plus sign were incremented in this version.
233 librte_cryptodev.so.1
234 librte_distributor.so.1
262 .. This section should contain a list of platforms that were tested with this release.
271 This section is a comment. Make sure to start the actual text at the margin.
277 .. This section should contain a list of NICs that were tested with this release.
286 This section is a comment. Make sure to start the actual text at the margin.
292 .. This section should contain a list of OSes that were tested with this release.
293 The format is as follows, in alphabetical order:
299 * Red Hat Enterprise Linux 7.2
300 * SUSE Enterprise Linux 12
305 This section is a comment. Make sure to start the actual text at the margin.