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 for ARM.**
49 Enabled virtio support for armv7/v8. Tested for arm64.
50 Virtio for arm support VFIO-noiommu mode only.
51 Virtio can work with other non-x86 arch too like powerpc.
53 * **Supported virtio offload in vhost-user.**
55 Add the offload and negotiation of checksum and TSO between vhost-user and
56 vanilla Linux virtio guest.
58 * **Added vhost-user live migration support.**
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.
80 * **ethdev: Fixed byte order consistency between fdir flow and mask.**
82 Fixed issue in ethdev library that the structure for setting
83 fdir's mask and flow entry was not consistent in byte ordering.
85 * **aesni_mb: Fixed wrong return value when creating a device.**
87 cryptodev_aesni_mb_init() was returning the device id of the device created,
88 instead of 0 (when success), that rte_eal_vdev_init() expects.
89 This made impossible the creation of more than one aesni_mb device
96 * **hash: Fixed CRC32c hash computation for non multiple of 4 bytes sizes.**
98 Fix crc32c hash functions to return a valid crc32c value for data lengths
99 not multiple of 4 bytes.
105 * **examples/vhost: Fixed frequent mbuf allocation failure.**
107 vhost-switch often fails to allocate mbuf when dequeue from vring because it
108 wrongly calculates the number of mbufs needed.
118 This section should contain new known issues in this release. Sample format:
120 * **Add title in present tense with full stop.**
122 Add a short 1-2 sentence description of the known issue in the present
123 tense. Add information on any known workarounds.
129 This section should contain API changes. Sample format:
131 * Add a short 1-2 sentence description of the API change. Use fixed width
132 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
138 * Add a short 1-2 sentence description of the ABI change that was announced in
139 the previous releases and made in this release. Use fixed width quotes for
140 ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
142 * The fields in ethdev structure ``rte_eth_fdir_masks`` were changed
146 Shared Library Versions
147 -----------------------
149 Update any library version updated in this release and prepend with a ``+`` sign.
151 The libraries prepended with a plus sign were incremented in this version.
159 librte_distributor.so.1