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.
45 .. This section should contain bug fixes added to the relevant sections. Sample format:
47 * **code/section Fixed issue in the past tense with a full stop.**
49 Add a short 1-2 sentence description of the resolved issue in the past tense.
50 The title should contain the code/lib section like a commit message.
51 Add the entries in alphabetic order in the relevant sections below.
61 * **i40e: Fixed vlan stripping from inner header.**
63 Previously, for tunnel packets, such as VXLAN/NVGRE, the vlan
64 tags of the inner header will be stripped without putting vlan
66 Now this issue is fixed by disabling vlan stripping from inner header.
84 .. This section should contain new known issues in this release. Sample format:
86 * **Add title in present tense with full stop.**
88 Add a short 1-2 sentence description of the known issue in the present
89 tense. Add information on any known workarounds.
95 .. This section should contain API changes. Sample format:
97 * Add a short 1-2 sentence description of the API change. Use fixed width
98 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
100 * The following counters are removed from ``rte_eth_stats`` structure:
101 ibadcrc, ibadlen, imcasts, fdirmatch, fdirmiss,
102 tx_pause_xon, rx_pause_xon, tx_pause_xoff, rx_pause_xoff.
108 .. * Add a short 1-2 sentence description of the ABI change that was announced in
109 the previous releases and made in this release. Use fixed width quotes for
110 ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
112 * The ``rte_port_source_params`` structure has new fields to support PCAP file.
113 It was already in release 16.04 with ``RTE_NEXT_ABI`` flag.
116 Shared Library Versions
117 -----------------------
119 .. Update any library version updated in this release and prepend with a ``+`` sign.
121 The libraries prepended with a plus sign were incremented in this version.
129 librte_distributor.so.1
139 + librte_mempool.so.2
157 .. This section should contain a list of platforms that were tested with this
171 .. This section should contain a list of NICs that were tested with this release.