1DPDK Release 17.02 2================== 3 4.. **Read this first.** 5 6 The text below explains how to update the release notes. 7 8 Use proper spelling, capitalization and punctuation in all sections. 9 10 Variable and config names should be quoted as fixed width text: ``LIKE_THIS``. 11 12 Build the docs and view the output file to ensure the changes are correct:: 13 14 make doc-guides-html 15 16 firefox build/doc/html/guides/rel_notes/release_17_02.html 17 18 19New Features 20------------ 21 22.. This section should contain new features added in this release. Sample format: 23 24 * **Add a title in the past tense with a full stop.** 25 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 28 the new feature. 29 30 If the feature adds a lot of sub-features you can use a bullet list like this. 31 32 * Added feature foo to do something. 33 * Enhanced feature bar to do something else. 34 35 Refer to the previous release notes for examples. 36 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 ========================================================= 40 41 42Resolved Issues 43--------------- 44 45.. This section should contain bug fixes added to the relevant sections. Sample format: 46 47 * **code/section Fixed issue in the past tense with a full stop.** 48 49 Add a short 1-2 sentence description of the resolved issue in the past tense. 50 The title should contain the code/lib section like a commit message. 51 Add the entries in alphabetic order in the relevant sections below. 52 53 This section is a comment. do not overwrite or remove it. 54 Also, make sure to start the actual text at the margin. 55 ========================================================= 56 57 58EAL 59~~~ 60 61 62Drivers 63~~~~~~~ 64 65 66Libraries 67~~~~~~~~~ 68 69 70Examples 71~~~~~~~~ 72 73* **examples/ethtool: Fixed crash with non-PCI devices.** 74 75 Querying a non-PCI device was dereferencing non-existent PCI data 76 resulting in a segmentation fault. 77 78 79Other 80~~~~~ 81 82 83Known Issues 84------------ 85 86.. This section should contain new known issues in this release. Sample format: 87 88 * **Add title in present tense with full stop.** 89 90 Add a short 1-2 sentence description of the known issue in the present 91 tense. Add information on any known workarounds. 92 93 This section is a comment. do not overwrite or remove it. 94 Also, make sure to start the actual text at the margin. 95 ========================================================= 96 97 98API Changes 99----------- 100 101.. This section should contain API changes. Sample format: 102 103 * Add a short 1-2 sentence description of the API change. Use fixed width 104 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense. 105 106 This section is a comment. do not overwrite or remove it. 107 Also, make sure to start the actual text at the margin. 108 ========================================================= 109 110 111ABI Changes 112----------- 113 114.. This section should contain ABI changes. Sample format: 115 116 * Add a short 1-2 sentence description of the ABI change that was announced in 117 the previous releases and made in this release. Use fixed width quotes for 118 ``rte_function_names`` or ``rte_struct_names``. Use the past tense. 119 120 This section is a comment. do not overwrite or remove it. 121 Also, make sure to start the actual text at the margin. 122 ========================================================= 123 124 125 126Shared Library Versions 127----------------------- 128 129.. Update any library version updated in this release and prepend with a ``+`` 130 sign, like this: 131 132 librte_acl.so.2 133 + librte_cfgfile.so.2 134 librte_cmdline.so.2 135 136 This section is a comment. do not overwrite or remove it. 137 ========================================================= 138 139 140The libraries prepended with a plus sign were incremented in this version. 141 142.. code-block:: diff 143 144 librte_acl.so.2 145 librte_cfgfile.so.2 146 librte_cmdline.so.2 147 librte_cryptodev.so.2 148 librte_distributor.so.1 149 librte_eal.so.3 150 librte_ethdev.so.5 151 librte_hash.so.2 152 librte_ip_frag.so.1 153 librte_jobstats.so.1 154 librte_kni.so.2 155 librte_kvargs.so.1 156 librte_lpm.so.2 157 librte_mbuf.so.2 158 librte_mempool.so.2 159 librte_meter.so.1 160 librte_net.so.1 161 librte_pdump.so.1 162 librte_pipeline.so.3 163 librte_pmd_bond.so.1 164 librte_pmd_ring.so.2 165 librte_port.so.3 166 librte_power.so.1 167 librte_reorder.so.1 168 librte_ring.so.1 169 librte_sched.so.1 170 librte_table.so.2 171 librte_timer.so.1 172 librte_vhost.so.3 173 174 175Tested Platforms 176---------------- 177 178.. This section should contain a list of platforms that were tested with this release. 179 180 The format is: 181 182 #. Platform name. 183 184 * Platform details. 185 * Platform details. 186 187 This section is a comment. do not overwrite or remove it. 188 Also, make sure to start the actual text at the margin. 189 ========================================================= 190 191 192Tested NICs 193----------- 194 195.. This section should contain a list of NICs that were tested with this release. 196 197 The format is: 198 199 #. NIC name. 200 201 * NIC details. 202 * NIC details. 203 204 This section is a comment. do not overwrite or remove it. 205 Also, make sure to start the actual text at the margin. 206 ========================================================= 207 208 209Tested OSes 210----------- 211 212.. This section should contain a list of OSes that were tested with this release. 213 The format is as follows, in alphabetical order: 214 215 * CentOS 7.0 216 * Fedora 23 217 * Fedora 24 218 * FreeBSD 10.3 219 * Red Hat Enterprise Linux 7.2 220 * SUSE Enterprise Linux 12 221 * Ubuntu 15.10 222 * Ubuntu 16.04 LTS 223 * Wind River Linux 8 224 225 This section is a comment. do not overwrite or remove it. 226 Also, make sure to start the actual text at the margin. 227 ========================================================= 228