7 The text below explains how to update the release notes.
9 Use proper spelling, capitalization and punctuation in all sections.
11 Variable and config names should be quoted as fixed width text: ``LIKE_THIS``.
13 Build the docs and view the output file to ensure the changes are correct::
17 firefox build/doc/html/guides/rel_notes/release_2_3.html
23 This section should contain new features added in this release. Sample format:
25 * **Add a title in the past tense with a full stop.**
27 Add a short 1-2 sentence description in the past tense. The description
28 should be enough to allow someone scanning the release notes to understand
31 If the feature adds a lot of sub-features you can use a bullet list like this.
33 * Added feature foo to do something.
34 * Enhanced feature bar to do something else.
36 Refer to the previous release notes for examples.
40 Enabled virtio 1.0 support for virtio pmd driver.
46 This section should contain bug fixes added to the relevant sections. Sample format:
48 * **code/section Fixed issue in the past tense with a full stop.**
50 Add a short 1-2 sentence description of the resolved issue in the past tense.
51 The title should contain the code/lib section like a commit message.
52 Add the entries in alphabetic order in the relevant sections below.
78 This section should contain new known issues in this release. Sample format:
80 * **Add title in present tense with full stop.**
82 Add a short 1-2 sentence description of the known issue in the present
83 tense. Add information on any known workarounds.
89 This section should contain API changes. Sample format:
91 * Add a short 1-2 sentence description of the API change. Use fixed width
92 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
98 * Add a short 1-2 sentence description of the ABI change that was announced in
99 the previous releases and made in this release. Use fixed width quotes for
100 ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
103 Shared Library Versions
104 -----------------------
106 Update any library version updated in this release and prepend with a ``+`` sign.
108 The libraries prepended with a plus sign were incremented in this version.
116 librte_distributor.so.1