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_07.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 * **Removed mempool cache if not needed.**
39 The size of the mempool structure is reduced if the per-lcore cache is disabled.
41 * **Changed the memory allocation in mempool library.**
43 * Added ability to allocate a large mempool in virtually fragmented memory.
44 * Added new APIs to populate a mempool with memory.
45 * Added an API to free a mempool.
46 * Modified the API of rte_mempool_obj_iter() function.
47 * Dropped specific Xen Dom0 code.
48 * Dropped specific anonymous mempool code in testpmd.
50 * **Supported virtio on IBM POWER8.**
52 The ioports are mapped in memory when using Linux UIO.
54 * **Added AES-CTR support to AESNI MB PMD.**
56 Now AESNI MB PMD supports 128/192/256-bit counter mode AES encryption and
59 * **Added support of AES counter mode for Intel QuickAssist devices.**
61 Enabled support for the AES CTR algorithm for Intel QuickAssist devices.
62 Provided support for algorithm-chaining operations.
64 * **Improved IP Pipeline Application.**
66 The following features have been added to ip_pipeline application:
68 * Configure the MAC address in the routing pipeline and automatic routes
69 updates with change in link state.
70 * Enable RSS per network interface through the configuration file.
71 * Streamline the CLI code.
73 * **Added keepalive enhancements.**
75 Adds support for reporting of core states other than dead to
76 monitoring applications, enabling the support of broader liveness
77 reporting to external processes.
83 .. This section should contain bug fixes added to the relevant sections. Sample format:
85 * **code/section Fixed issue in the past tense with a full stop.**
87 Add a short 1-2 sentence description of the resolved issue in the past tense.
88 The title should contain the code/lib section like a commit message.
89 Add the entries in alphabetic order in the relevant sections below.
99 * **i40e: Fixed vlan stripping from inner header.**
101 Previously, for tunnel packets, such as VXLAN/NVGRE, the vlan
102 tags of the inner header will be stripped without putting vlan
104 Now this issue is fixed by disabling vlan stripping from inner header.
110 * **mbuf: Fixed refcnt update when detaching.**
112 Fix the ``rte_pktmbuf_detach()`` function to decrement the direct
113 mbuf's reference counter. The previous behavior was not to affect
114 the reference counter. It lead a memory leak of the direct mbuf.
128 .. This section should contain new known issues in this release. Sample format:
130 * **Add title in present tense with full stop.**
132 Add a short 1-2 sentence description of the known issue in the present
133 tense. Add information on any known workarounds.
139 .. This section should contain API changes. Sample format:
141 * Add a short 1-2 sentence description of the API change. Use fixed width
142 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
144 * The following counters are removed from ``rte_eth_stats`` structure:
145 ibadcrc, ibadlen, imcasts, fdirmatch, fdirmiss,
146 tx_pause_xon, rx_pause_xon, tx_pause_xoff, rx_pause_xoff.
148 * The extended statistics are fetched by ids with ``rte_eth_xstats_get``
149 after a lookup by name ``rte_eth_xstats_get_names``.
155 .. * Add a short 1-2 sentence description of the ABI change that was announced in
156 the previous releases and made in this release. Use fixed width quotes for
157 ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
159 * The ``rte_port_source_params`` structure has new fields to support PCAP file.
160 It was already in release 16.04 with ``RTE_NEXT_ABI`` flag.
163 Shared Library Versions
164 -----------------------
166 .. Update any library version updated in this release and prepend with a ``+`` sign.
168 The libraries prepended with a plus sign were incremented in this version.
176 librte_distributor.so.1
186 + librte_mempool.so.2
204 .. This section should contain a list of platforms that were tested with this
218 .. This section should contain a list of NICs that were tested with this release.