X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Frel_notes%2Frelease_17_05.rst;h=b0dad76fd3c33501b60107b0cdd4a5126d10279f;hb=f6aef1dacf25d3b1ce3afd6da903cf4fd659220f;hp=68922840a38bcf9287ed1526d839958e4a0fa702;hpb=8fa90ab26e125f2e82c237d92cd87f2528ff4cdc;p=dpdk.git diff --git a/doc/guides/rel_notes/release_17_05.rst b/doc/guides/rel_notes/release_17_05.rst index 68922840a3..b0dad76fd3 100644 --- a/doc/guides/rel_notes/release_17_05.rst +++ b/doc/guides/rel_notes/release_17_05.rst @@ -1,46 +1,12 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright 2017 The DPDK contributors + DPDK Release 17.05 ================== -.. **Read this first.** - - The text in the sections below explains how to update the release notes. - - Use proper spelling, capitalization and punctuation in all sections. - - Variable and config names should be quoted as fixed width text: - ``LIKE_THIS``. - - Build the docs and view the output file to ensure the changes are correct:: - - make doc-guides-html - - xdg-open build/doc/html/guides/rel_notes/release_17_05.html - - New Features ------------ -.. This section should contain new features added in this release. Sample - format: - - * **Add a title in the past tense with a full stop.** - - Add a short 1-2 sentence description in the past tense. The description - should be enough to allow someone scanning the release notes to - understand the new feature. - - If the feature adds a lot of sub-features you can use a bullet list like - this: - - * Added feature foo to do something. - * Enhanced feature bar to do something else. - - Refer to the previous release notes for examples. - - This section is a comment. do not overwrite or remove it. - Also, make sure to start the actual text at the margin. - ========================================================= - * **Reorganized mbuf structure.** The mbuf structure has been reorganized as follows: @@ -325,23 +291,6 @@ New Features Resolved Issues --------------- -.. This section should contain bug fixes added to the relevant - sections. Sample format: - - * **code/section Fixed issue in the past tense with a full stop.** - - Add a short 1-2 sentence description of the resolved issue in the past - tense. - - The title should contain the code/lib section like a commit message. - - Add the entries in alphabetic order in the relevant sections below. - - This section is a comment. do not overwrite or remove it. - Also, make sure to start the actual text at the margin. - ========================================================= - - * **l2fwd-keepalive: Fixed unclean shutdowns.** Added clean shutdown to l2fwd-keepalive so that it can free up @@ -351,17 +300,6 @@ Resolved Issues Known Issues ------------ -.. This section should contain new known issues in this release. Sample format: - - * **Add title in present tense with full stop.** - - Add a short 1-2 sentence description of the known issue in the present - tense. Add information on any known workarounds. - - This section is a comment. do not overwrite or remove it. - Also, make sure to start the actual text at the margin. - ========================================================= - * **LSC interrupt doesn't work for virtio-user + vhost-kernel.** LSC interrupt cannot be detected when setting the backend, tap device, @@ -371,16 +309,6 @@ Known Issues API Changes ----------- -.. This section should contain API changes. Sample format: - - * Add a short 1-2 sentence description of the API change. Use fixed width - quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past - tense. - - This section is a comment. do not overwrite or remove it. - Also, make sure to start the actual text at the margin. - ========================================================= - * The LPM ``next_hop`` field is extended from 8 bits to 21 bits for IPv6 while keeping ABI compatibility. @@ -463,16 +391,6 @@ API Changes ABI Changes ----------- -.. This section should contain ABI changes. Sample format: - - * Add a short 1-2 sentence description of the ABI change that was announced - in the previous releases and made in this release. Use fixed width quotes - for ``rte_function_names`` or ``rte_struct_names``. Use the past tense. - - This section is a comment. do not overwrite or remove it. - Also, make sure to start the actual text at the margin. - ========================================================= - * **Reorganized the mbuf structure.** The order and size of the fields in the ``mbuf`` structure changed, @@ -485,15 +403,6 @@ ABI Changes Removed Items ------------- -.. This section should contain removed items in this release. Sample format: - - * Add a short 1-2 sentence description of the removed item in the past - tense. - - This section is a comment. do not overwrite or remove it. - Also, make sure to start the actual text at the margin. - ========================================================= - * KNI vhost support has been removed. * The dpdk_qat sample application has been removed. @@ -501,17 +410,6 @@ Removed Items Shared Library Versions ----------------------- -.. Update any library version updated in this release and prepend with a ``+`` - sign, like this: - - librte_acl.so.2 - + librte_cfgfile.so.2 - librte_cmdline.so.2 - - This section is a comment. do not overwrite or remove it. - ========================================================= - - The libraries prepended with a plus sign were incremented in this version. .. code-block:: diff @@ -554,22 +452,6 @@ The libraries prepended with a plus sign were incremented in this version. Tested Platforms ---------------- -.. This section should contain a list of platforms that were tested with this - release. - - The format is: - - * platform with combinations - - * List of CPU - * List of OS - * List of devices - * Other relevant details... - - This section is a comment. do not overwrite or remove it. - Also, make sure to start the actual text at the margin. - ========================================================= - * Intel(R) platforms with Intel(R) NICs combinations * CPU