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_16_04.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.
38 * **Enabled bulk allocation of mbufs.**
40 A new function ``rte_pktmbuf_alloc_bulk()`` has been added to allow the user
41 to allocate a bulk of mbufs.
45 Enabled virtio 1.0 support for virtio pmd driver.
47 * **Supported virtio offload in vhost-user.**
49 Add the offload and negotiation of checksum and TSO between vhost-user and
50 vanilla Linux virtio guest.
52 * **Added vhost-user live migration support.**
58 This section should contain bug fixes added to the relevant sections. Sample format:
60 * **code/section Fixed issue in the past tense with a full stop.**
62 Add a short 1-2 sentence description of the resolved issue in the past tense.
63 The title should contain the code/lib section like a commit message.
64 Add the entries in alphabetic order in the relevant sections below.
66 * **examples/vhost: Fixed frequent mbuf allocation failure.**
68 vhost-switch often fails to allocate mbuf when dequeue from vring because it
69 wrongly calculates the number of mbufs needed.
79 * **aesni_mb: Fixed wrong return value when creating a device.**
81 cryptodev_aesni_mb_init() was returning the device id of the device created,
82 instead of 0 (when success), that rte_eal_vdev_init() expects.
83 This made impossible the creation of more than one aesni_mb device
90 * **hash: Fixed CRC32c hash computation for non multiple of 4 bytes sizes.**
92 Fix crc32c hash functions to return a valid crc32c value for data lengths
93 not multiple of 4 bytes.
107 This section should contain new known issues in this release. Sample format:
109 * **Add title in present tense with full stop.**
111 Add a short 1-2 sentence description of the known issue in the present
112 tense. Add information on any known workarounds.
118 This section should contain API changes. Sample format:
120 * Add a short 1-2 sentence description of the API change. Use fixed width
121 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
127 * Add a short 1-2 sentence description of the ABI change that was announced in
128 the previous releases and made in this release. Use fixed width quotes for
129 ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
132 Shared Library Versions
133 -----------------------
135 Update any library version updated in this release and prepend with a ``+`` sign.
137 The libraries prepended with a plus sign were incremented in this version.
145 librte_distributor.so.1