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.**
60 * **Enabled PCI extended tag for i40e.**
62 It enabled extended tag by checking and writing corresponding PCI config
63 space bytes, to boost the performance. In the meanwhile, it deprecated the
64 legacy way via reading/writing sysfile supported by kernel module igb_uio.
70 This section should contain bug fixes added to the relevant sections. Sample format:
72 * **code/section: Fixed issue in the past tense with a full stop.**
74 Add a short 1-2 sentence description of the resolved issue in the past tense.
75 The title should contain the code/lib section like a commit message.
76 Add the entries in alphabetic order in the relevant sections below.
86 * **ethdev: Fixed byte order consistency between fdir flow and mask.**
88 Fixed issue in ethdev library that the structure for setting
89 fdir's mask and flow entry was not consistent in byte ordering.
91 * **aesni_mb: Fixed wrong return value when creating a device.**
93 cryptodev_aesni_mb_init() was returning the device id of the device created,
94 instead of 0 (when success), that rte_eal_vdev_init() expects.
95 This made impossible the creation of more than one aesni_mb device
102 * **hash: Fixed CRC32c hash computation for non multiple of 4 bytes sizes.**
104 Fix crc32c hash functions to return a valid crc32c value for data lengths
105 not multiple of 4 bytes.
111 * **examples/vhost: Fixed frequent mbuf allocation failure.**
113 vhost-switch often fails to allocate mbuf when dequeue from vring because it
114 wrongly calculates the number of mbufs needed.
124 This section should contain new known issues in this release. Sample format:
126 * **Add title in present tense with full stop.**
128 Add a short 1-2 sentence description of the known issue in the present
129 tense. Add information on any known workarounds.
135 This section should contain API changes. Sample format:
137 * Add a short 1-2 sentence description of the API change. Use fixed width
138 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
144 * Add a short 1-2 sentence description of the ABI change that was announced in
145 the previous releases and made in this release. Use fixed width quotes for
146 ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
148 * The fields in ethdev structure ``rte_eth_fdir_masks`` were changed
152 Shared Library Versions
153 -----------------------
155 Update any library version updated in this release and prepend with a ``+`` sign.
157 The libraries prepended with a plus sign were incremented in this version.
165 librte_distributor.so.1