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.
39 * **Added vhost-user indirect descriptors support.**
41 If indirect descriptor feature is negotiated, each packet sent by the guest
42 will take exactly one slot in the enqueue virtqueue. Without the feature, in
43 current version, even 64 bytes packets take two slots with Virtio PMD on guest
46 The main impact is better performance for 0% packet loss use-cases, as it
47 behaves as if the virtqueue size was enlarged, so more packets can be buffered
48 in case of system perturbations. On the downside, small performance degradation
49 is measured when running micro-benchmarks.
55 .. This section should contain bug fixes added to the relevant sections. Sample format:
57 * **code/section Fixed issue in the past tense with a full stop.**
59 Add a short 1-2 sentence description of the resolved issue in the past tense.
60 The title should contain the code/lib section like a commit message.
61 Add the entries in alphabetic order in the relevant sections below.
63 This section is a comment. Make sure to start the actual text at the margin.
89 .. This section should contain new known issues in this release. Sample format:
91 * **Add title in present tense with full stop.**
93 Add a short 1-2 sentence description of the known issue in the present
94 tense. Add information on any known workarounds.
96 This section is a comment. Make sure to start the actual text at the margin.
102 .. This section should contain API changes. Sample format:
104 * Add a short 1-2 sentence description of the API change. Use fixed width
105 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
107 This section is a comment. Make sure to start the actual text at the margin.
109 * The driver names have been changed. It especially impacts ``--vdev`` arguments.
110 Examples: ``eth_pcap`` becomes ``net_pcap``
111 and ``cryptodev_aesni_mb_pmd`` becomes ``crypto_aesni_mb``.
113 * The log history is removed.
115 * The ``rte_ivshmem`` feature (including library and EAL code) has been removed
116 in 16.11 because it had some design issues which were not planned to be fixed.
122 .. This section should contain ABI changes. Sample format:
124 * Add a short 1-2 sentence description of the ABI change that was announced in
125 the previous releases and made in this release. Use fixed width quotes for
126 ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
128 This section is a comment. Make sure to start the actual text at the margin.
132 Shared Library Versions
133 -----------------------
135 .. Update any library version updated in this release and prepend with a ``+``
140 + librte_cfgfile.so.2
145 The libraries prepended with a plus sign were incremented in this version.
153 librte_cryptodev.so.1
154 librte_distributor.so.1
182 .. This section should contain a list of platforms that were tested with this release.
191 This section is a comment. Make sure to start the actual text at the margin.
197 .. This section should contain a list of NICs that were tested with this release.
206 This section is a comment. Make sure to start the actual text at the margin.
212 .. This section should contain a list of OSes that were tested with this release.
213 The format is as follows, in alphabetical order:
219 * Red Hat Enterprise Linux 7.2
220 * SUSE Enterprise Linux 12
225 This section is a comment. Make sure to start the actual text at the margin.