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.
43 .. This section should contain bug fixes added to the relevant sections. Sample format:
45 * **code/section Fixed issue in the past tense with a full stop.**
47 Add a short 1-2 sentence description of the resolved issue in the past tense.
48 The title should contain the code/lib section like a commit message.
49 Add the entries in alphabetic order in the relevant sections below.
51 This section is a comment. Make sure to start the actual text at the margin.
77 .. This section should contain new known issues in this release. Sample format:
79 * **Add title in present tense with full stop.**
81 Add a short 1-2 sentence description of the known issue in the present
82 tense. Add information on any known workarounds.
84 This section is a comment. Make sure to start the actual text at the margin.
90 .. This section should contain API changes. Sample format:
92 * Add a short 1-2 sentence description of the API change. Use fixed width
93 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
95 This section is a comment. Make sure to start the actual text at the margin.
97 * The log history is removed.
103 .. This section should contain ABI changes. Sample format:
105 * Add a short 1-2 sentence description of the ABI change that was announced in
106 the previous releases and made in this release. Use fixed width quotes for
107 ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
109 This section is a comment. Make sure to start the actual text at the margin.
113 Shared Library Versions
114 -----------------------
116 .. Update any library version updated in this release and prepend with a ``+``
121 + librte_cfgfile.so.2
126 The libraries prepended with a plus sign were incremented in this version.
134 librte_cryptodev.so.1
135 librte_distributor.so.1
164 .. This section should contain a list of platforms that were tested with this release.
173 This section is a comment. Make sure to start the actual text at the margin.
179 .. This section should contain a list of NICs that were tested with this release.
188 This section is a comment. Make sure to start the actual text at the margin.
194 .. This section should contain a list of OSes that were tested with this release.
195 The format is as follows, in alphabetical order:
201 * Red Hat Enterprise Linux 7.2
202 * SUSE Enterprise Linux 12
207 This section is a comment. Make sure to start the actual text at the margin.