X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Frel_notes%2Frelease_19_08.rst;h=9ea2f2eee9676c760ba4bc1e803f414a7132a744;hb=9ec50a52534d32698ebe82bc85834b2cea5ff6e6;hp=d2baa828b174d687fb00a9d20542dc5fd1477900;hpb=9c30a6f3c9a456e8111a2b1e5f6c2c02a62025b6;p=dpdk.git diff --git a/doc/guides/rel_notes/release_19_08.rst b/doc/guides/rel_notes/release_19_08.rst index d2baa828b1..9ea2f2eee9 100644 --- a/doc/guides/rel_notes/release_19_08.rst +++ b/doc/guides/rel_notes/release_19_08.rst @@ -6,56 +6,9 @@ DPDK Release 19.08 ================== -.. **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_19_08.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. - - Suggested order in release notes items: - * Core libs (EAL, mempool, ring, mbuf, buses) - * Device abstraction libs and PMDs - - ethdev (lib, PMDs) - - cryptodev (lib, PMDs) - - eventdev (lib, PMDs) - - etc - * Other libs - * Apps, Examples, Tools (if significant) - - This section is a comment. Do not overwrite or remove it. - Also, make sure to start the actual text at the margin. - ========================================================= - * **EAL will now pick IOVA as VA mode as the default in most cases.** Previously, the preferred default IOVA mode was selected to be IOVA as PA. The @@ -243,15 +196,6 @@ New Features 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. - ========================================================= - * Removed KNI ethtool, ``CONFIG_RTE_KNI_KMOD_ETHTOOL``, support. * build: armv8 crypto extension is disabled. @@ -260,18 +204,6 @@ Removed Items API Changes ----------- -.. This section should contain API changes. Sample format: - - * sample: Add a short 1-2 sentence description of the API change - which was announced in the previous releases and made in this release. - Start with a scope label like "ethdev:". - Use fixed width quotes for ``function_names`` or ``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 ``rte_mem_config`` structure has been made private. New accessor ``rte_mcfg_*`` functions were introduced to provide replacement for direct access to the shared mem config. @@ -321,18 +253,6 @@ API Changes ABI Changes ----------- -.. This section should contain ABI changes. Sample format: - - * sample: Add a short 1-2 sentence description of the ABI change - which was announced in the previous releases and made in this release. - Start with a scope label like "ethdev:". - Use fixed width quotes for ``function_names`` or ``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. - ========================================================= - * eventdev: Event based Rx adapter callback The mbuf pointer array in the event eth Rx adapter callback @@ -365,16 +285,6 @@ ABI Changes Shared Library Versions ----------------------- -.. Update any library version updated in this release - and prepend with a ``+`` sign, like this: - - libfoo.so.1 - + libupdated.so.2 - libbar.so.1 - - 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 @@ -443,17 +353,6 @@ The libraries prepended with a plus sign were incremented in this version. 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. - ========================================================= - * **Unsuitable IOVA mode may be picked as the default.** Not all kernel drivers and not all devices support all IOVA modes. EAL will @@ -467,22 +366,6 @@ Known Issues 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