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_17_02.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. do not overwrite or remove it.
38 Also, make sure to start the actual text at the margin.
39 =========================================================
41 * **Added generic flow API (rte_flow).**
43 This API provides a generic means to configure hardware to match specific
44 ingress or egress traffic, alter its fate and query related counters
45 according to any number of user-defined rules.
47 It is slightly higher-level than the legacy filtering framework which it
48 encompasses and supersedes (including all functions and filter types) in
49 order to expose a single interface with an unambiguous behavior that is
50 common to all poll-mode drivers (PMDs).
52 See the :ref:`Generic flow API <Generic_flow_API>` documentation for more
55 * **Added APIs for MACsec offload support to the ixgbe PMD.**
57 Six new APIs have been added to the ixgbe PMD for MACsec offload support.
58 The declarations for the APIs can be found in ``rte_pmd_ixgbe.h``.
64 .. This section should contain bug fixes added to the relevant sections. Sample format:
66 * **code/section Fixed issue in the past tense with a full stop.**
68 Add a short 1-2 sentence description of the resolved issue in the past tense.
69 The title should contain the code/lib section like a commit message.
70 Add the entries in alphabetic order in the relevant sections below.
72 This section is a comment. do not overwrite or remove it.
73 Also, make sure to start the actual text at the margin.
74 =========================================================
92 * **examples/ethtool: Fixed crash with non-PCI devices.**
94 Querying a non-PCI device was dereferencing non-existent PCI data
95 resulting in a segmentation fault.
105 .. This section should contain new known issues in this release. Sample format:
107 * **Add title in present tense with full stop.**
109 Add a short 1-2 sentence description of the known issue in the present
110 tense. Add information on any known workarounds.
112 This section is a comment. do not overwrite or remove it.
113 Also, make sure to start the actual text at the margin.
114 =========================================================
120 .. This section should contain API changes. Sample format:
122 * Add a short 1-2 sentence description of the API change. Use fixed width
123 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
125 This section is a comment. do not overwrite or remove it.
126 Also, make sure to start the actual text at the margin.
127 =========================================================
133 .. This section should contain ABI changes. Sample format:
135 * Add a short 1-2 sentence description of the ABI change that was announced in
136 the previous releases and made in this release. Use fixed width quotes for
137 ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
139 This section is a comment. do not overwrite or remove it.
140 Also, make sure to start the actual text at the margin.
141 =========================================================
145 Shared Library Versions
146 -----------------------
148 .. Update any library version updated in this release and prepend with a ``+``
152 + librte_cfgfile.so.2
155 This section is a comment. do not overwrite or remove it.
156 =========================================================
159 The libraries prepended with a plus sign were incremented in this version.
166 librte_cryptodev.so.2
167 librte_distributor.so.1
197 .. This section should contain a list of platforms that were tested with this release.
206 This section is a comment. do not overwrite or remove it.
207 Also, make sure to start the actual text at the margin.
208 =========================================================
214 .. This section should contain a list of NICs that were tested with this release.
223 This section is a comment. do not overwrite or remove it.
224 Also, make sure to start the actual text at the margin.
225 =========================================================
231 .. This section should contain a list of OSes that were tested with this release.
232 The format is as follows, in alphabetical order:
238 * Red Hat Enterprise Linux 7.2
239 * SUSE Enterprise Linux 12
244 This section is a comment. do not overwrite or remove it.
245 Also, make sure to start the actual text at the margin.
246 =========================================================