X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Frel_notes%2Frelease_19_02.rst;h=e2b8200739f22b89d6505882cba716e68e06557b;hb=eab2ae4bc4c2553c4fb933a8daab7e89e2785d66;hp=6bacbdb8f9cc32cdaa27cc77c345b10050db2980;hpb=bf9a90e2b562cf32f80152f96152557f17a41a61;p=dpdk.git diff --git a/doc/guides/rel_notes/release_19_02.rst b/doc/guides/rel_notes/release_19_02.rst index 6bacbdb8f9..e2b8200739 100644 --- a/doc/guides/rel_notes/release_19_02.rst +++ b/doc/guides/rel_notes/release_19_02.rst @@ -4,56 +4,9 @@ DPDK Release 19.02 ================== -.. **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_02.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. - ========================================================= - * **Added support for freeing hugepages exactly as originally allocated.** Some applications using memory event callbacks (especially for managing @@ -109,8 +62,8 @@ New Features ``CONFIG_RTE_IBVERBS_LINK_DLOPEN`` for make and ``ibverbs_link`` for meson. * Added static linkage of ``mlx`` dependency. * Improved stability of E-Switch flow driver. - * Added new make build configuration to set the cacheline size for Bluefield - correctly - ``arm64-bluefield-linuxapp-gcc``. + * Added new make build configuration to set the cacheline size for BlueField + correctly - ``arm64-bluefield-linux-gcc``. * **Updated the enic driver.** @@ -197,18 +150,6 @@ New Features 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. - ========================================================= - * eal: Function ``rte_bsf64`` in ``rte_bitmap.h`` has been renamed to ``rte_bsf64_safe`` and moved to ``rte_common.h``. A new ``rte_bsf64`` function has been added in ``rte_common.h`` that follows the convention set @@ -250,26 +191,14 @@ 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. - ========================================================= - * mbuf: The format of the sched field of ``rte_mbuf`` has been changed to include the following fields: ``queue ID``, ``traffic class``, ``color``. -* cryptodev: as shown in the the 18.11 deprecation notice, the structure +* cryptodev: as shown in the 18.11 deprecation notice, the structure ``rte_cryptodev_qp_conf`` has added two parameters for symmetric session mempool and symmetric session private data mempool. -* cryptodev: as shown in the the 18.11 deprecation notice, the structure +* cryptodev: as shown in the 18.11 deprecation notice, the structure ``rte_cryptodev_sym_session`` has been updated to contain more information to ensure safely accessing the session and session private data. @@ -281,16 +210,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 @@ -356,17 +275,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. - ========================================================= - * ``AVX-512`` support has been disabled for ``GCC`` builds when ``binutils 2.30`` is detected [1] because of a crash [2]. This can affect ``native`` machine type build targets on the platforms that support ``AVX512F`` like ``Intel Skylake`` @@ -386,22 +294,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