Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/17003/?format=api
{ "id": 17003, "url": "https://patches.dpdk.org/api/patches/17003/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/patch/1478865882-15315-1-git-send-email-john.mcnamara@intel.com/", "project": { "id": 1, "url": "https://patches.dpdk.org/api/projects/1/?format=api", "name": "DPDK", "link_name": "dpdk", "list_id": "dev.dpdk.org", "list_email": "dev@dpdk.org", "web_url": "http://core.dpdk.org", "scm_url": "git://dpdk.org/dpdk", "webscm_url": "http://git.dpdk.org/dpdk", "list_archive_url": "https://inbox.dpdk.org/dev", "list_archive_url_format": "https://inbox.dpdk.org/dev/{}", "commit_url_format": "" }, "msgid": "<1478865882-15315-1-git-send-email-john.mcnamara@intel.com>", "list_archive_url": "https://inbox.dpdk.org/dev/1478865882-15315-1-git-send-email-john.mcnamara@intel.com", "date": "2016-11-11T12:04:42", "name": "[dpdk-dev,v1] doc: fix release notes for 16.11", "commit_ref": null, "pull_url": null, "state": "accepted", "archived": true, "hash": "ed04345a6a366790ae102de3a5a9063bcf1c6eb4", "submitter": { "id": 154, "url": "https://patches.dpdk.org/api/people/154/?format=api", "name": "John McNamara", "email": "john.mcnamara@intel.com" }, "delegate": null, "mbox": "https://patches.dpdk.org/project/dpdk/patch/1478865882-15315-1-git-send-email-john.mcnamara@intel.com/mbox/", "series": [], "comments": "https://patches.dpdk.org/api/patches/17003/comments/", "check": "success", "checks": "https://patches.dpdk.org/api/patches/17003/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@dpdk.org", "Delivered-To": "patchwork@dpdk.org", "Received": [ "from [92.243.14.124] (localhost [IPv6:::1])\n\tby dpdk.org (Postfix) with ESMTP id 8F81FD54E;\n\tFri, 11 Nov 2016 13:04:48 +0100 (CET)", "from mga05.intel.com (mga05.intel.com [192.55.52.43])\n\tby dpdk.org (Postfix) with ESMTP id 8418BD54C\n\tfor <dev@dpdk.org>; Fri, 11 Nov 2016 13:04:46 +0100 (CET)", "from fmsmga001.fm.intel.com ([10.253.24.23])\n\tby fmsmga105.fm.intel.com with ESMTP; 11 Nov 2016 04:04:45 -0800", "from sivswdev02.ir.intel.com (HELO localhost.localdomain)\n\t([10.237.217.46])\n\tby fmsmga001.fm.intel.com with ESMTP; 11 Nov 2016 04:04:44 -0800" ], "X-ExtLoop1": "1", "X-IronPort-AV": "E=Sophos; i=\"5.31,621,1473145200\"; d=\"scan'208\";\n\ta=\"1067153927\"", "From": "John McNamara <john.mcnamara@intel.com>", "To": "dev@dpdk.org", "Cc": "John McNamara <john.mcnamara@intel.com>", "Date": "Fri, 11 Nov 2016 12:04:42 +0000", "Message-Id": "<1478865882-15315-1-git-send-email-john.mcnamara@intel.com>", "X-Mailer": "git-send-email 1.7.0.7", "Subject": "[dpdk-dev] [PATCH v1] doc: fix release notes for 16.11", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.15", "Precedence": "list", "List-Id": "patches and discussions about DPDK <dev.dpdk.org>", "List-Unsubscribe": "<http://dpdk.org/ml/options/dev>,\n\t<mailto:dev-request@dpdk.org?subject=unsubscribe>", "List-Archive": "<http://dpdk.org/ml/archives/dev/>", "List-Post": "<mailto:dev@dpdk.org>", "List-Help": "<mailto:dev-request@dpdk.org?subject=help>", "List-Subscribe": "<http://dpdk.org/ml/listinfo/dev>,\n\t<mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org", "Sender": "\"dev\" <dev-bounces@dpdk.org>" }, "content": "Fix grammar, spelling and formatting of DPDK 16.11 release notes.\n\nSigned-off-by: John McNamara <john.mcnamara@intel.com>\n---\n doc/guides/rel_notes/release_16_11.rst | 171 ++++++++++++++++-----------------\n 1 file changed, 83 insertions(+), 88 deletions(-)", "diff": "diff --git a/doc/guides/rel_notes/release_16_11.rst b/doc/guides/rel_notes/release_16_11.rst\nindex 365b5a3..6f40f59 100644\n--- a/doc/guides/rel_notes/release_16_11.rst\n+++ b/doc/guides/rel_notes/release_16_11.rst\n@@ -42,7 +42,7 @@ New Features\n * Added a new function ``rte_pktmbuf_read()`` to read the packet data from an\n mbuf chain, linearizing if required.\n * Added a new function ``rte_net_get_ptype()`` to parse an Ethernet packet\n- in an mbuf chain and retrieve its packet type by software.\n+ in an mbuf chain and retrieve its packet type from software.\n * Added new functions ``rte_get_ptype_*()`` to dump a packet type as a string.\n \n * **Improved offloads support in mbuf.**\n@@ -52,102 +52,108 @@ New Features\n * Added new Rx checksum flags in mbufs to describe more states: unknown,\n good, bad, or not present (useful for virtual drivers). This modification\n was done for IP and L4.\n- * Added a new RX LRO mbuf flag, used when packets are coalesced. This\n+ * Added a new Rx LRO mbuf flag, used when packets are coalesced. This\n flag indicates that the segment size of original packets is known.\n \n-* **Added vhost-user dequeue zero copy support**\n+* **Added vhost-user dequeue zero copy support.**\n \n- The copy in dequeue path is saved, which is meant to improve the performance.\n+ The copy in the dequeue path is avoided in order to improve the performance.\n In the VM2VM case, the boost is quite impressive. The bigger the packet size,\n- the bigger performance boost you may get. However, for VM2NIC case, there\n- are some limitations, yet the boost is not that impressive as VM2VM case.\n+ the bigger performance boost you may get. However, for the VM2NIC case, there\n+ are some limitations, so the boost is not as impressive as the VM2VM case.\n It may even drop quite a bit for small packets.\n \n- For such reason, this feature is disabled by default. It can be enabled when\n- ``RTE_VHOST_USER_DEQUEUE_ZERO_COPY`` flag is given. Check the vhost section\n- at programming guide for more information.\n+ For that reason, this feature is disabled by default. It can be enabled when\n+ the ``RTE_VHOST_USER_DEQUEUE_ZERO_COPY`` flag is set. Check the VHost section\n+ of the Programming Guide for more information.\n \n * **Added vhost-user indirect descriptors support.**\n \n- If indirect descriptor feature is negotiated, each packet sent by the guest\n- will take exactly one slot in the enqueue virtqueue. Without the feature, in\n- current version, even 64 bytes packets take two slots with Virtio PMD on guest\n+ If the indirect descriptor feature is enabled, each packet sent by the guest\n+ will take exactly one slot in the enqueue virtqueue. Without this feature, as in\n+ the current version, even 64 bytes packets take two slots with Virtio PMD on guest\n side.\n \n The main impact is better performance for 0% packet loss use-cases, as it\n behaves as if the virtqueue size was enlarged, so more packets can be buffered\n- in case of system perturbations. On the downside, small performance degradation\n- is measured when running micro-benchmarks.\n+ in the case of system perturbations. On the downside, small performance degradations\n+ were measured when running micro-benchmarks.\n \n * **Added vhost PMD xstats.**\n \n- Added extended statistics to vhost PMD from per port perspective.\n+ Added extended statistics to vhost PMD from a per port perspective.\n \n * **Supported offloads with virtio.**\n \n- * Rx/Tx checksums\n- * LRO\n- * TSO\n+ Added support for the following offloads in virtio:\n+\n+ * Rx/Tx checksums.\n+ * LRO.\n+ * TSO.\n \n * **Added virtio NEON support for ARM.**\n \n+ Added NEON support for ARM based virtio.\n+\n * **Updated the ixgbe base driver.**\n \n Updated the ixgbe base driver, including the following changes:\n \n- * add X550em_a 10G PHY support\n- * support flow control auto negotiation for X550em_a 1G PHY\n- * add X550em_a FW ALEF support\n- * increase mailbox version to ixgbe_mbox_api_13\n- * add two MAC ops for Hyper-V support\n+ * Added X550em_a 10G PHY support.\n+ * Added support for flow control auto negotiation for X550em_a 1G PHY.\n+ * Added X550em_a FW ALEF support.\n+ * Increased mailbox version to ``ixgbe_mbox_api_13``.\n+ * Added two MAC operations for Hyper-V support.\n \n-* **Added API's for VF management to the ixgbe PMD.**\n+* **Added APIs for VF management to the ixgbe PMD.**\n \n- Eight new API's have been added to the ixgbe PMD for VF management from the PF.\n+ Eight new APIs have been added to the ixgbe PMD for VF management from the PF.\n The declarations for the API's can be found in ``rte_pmd_ixgbe.h``.\n \n * **Updated the enic driver.**\n \n- * Use interrupt for link status checking instead of polling\n- * More flow director modes on UCS Blade with firmware version >= 2.0(13e)\n- * Full support for MTU update\n- * Support for rte_eth_rx_queue_count function\n+ * Added update to use interrupt for link status checking instead of polling.\n+ * Added more flow director modes on UCS Blade with firmware version >= 2.0(13e).\n+ * Added full support for MTU update.\n+ * Added support for the ``rte_eth_rx_queue_count`` function.\n \n * **Updated the mlx5 driver.**\n \n- * Add support for RSS hash result\n- * Several performance improvements\n- * Several bug fixes\n+ * Added support for RSS hash results.\n+ * Added several performance improvements.\n+ * Added several bug fixes.\n \n * **Updated the QAT PMD.**\n \n- The QAT PMD was updated with following support:\n+ The QAT PMD was updated with additional support for:\n \n- * MD5_HMAC algorithm\n- * SHA224-HMAC algorithm\n- * SHA384-HMAC algorithm\n- * GMAC algorithm\n- * KASUMI (F8 and F9) algorithm\n- * 3DES algorithm\n- * NULL algorithm\n- * C3XXX device\n- * C62XX device\n+ * MD5_HMAC algorithm.\n+ * SHA224-HMAC algorithm.\n+ * SHA384-HMAC algorithm.\n+ * GMAC algorithm.\n+ * KASUMI (F8 and F9) algorithm.\n+ * 3DES algorithm.\n+ * NULL algorithm.\n+ * C3XXX device.\n+ * C62XX device.\n \n * **Added openssl PMD.**\n \n- A new crypto PMD has been added, which provides several ciphering and hashing.\n- All cryptography operations are using Openssl library crypto API.\n+ A new crypto PMD has been added, which provides several ciphering and hashing algorithms.\n+ All cryptography operations use the Openssl library crypto API.\n+\n+* **Updated the IPsec example.**\n \n-* **Updated the IPsec example with following support:**\n+ Updated the IPsec example with the following support:\n \n- * configuration file\n- * AES CBC IV generation with cipher forward function\n- * AES GCM/CTR mode\n+ * Configuration file support.\n+ * AES CBC IV generation with cipher forward function.\n+ * AES GCM/CTR mode.\n \n * **Added support for new gcc -march option.**\n \n The GCC 4.9 ``-march`` option supports the Intel processor code names.\n- The config option ``RTE_MACHINE`` can be used to pass code names to the compiler as ``-march`` flag.\n+ The config option ``RTE_MACHINE`` can be used to pass code names to the compiler via the ``-march`` flag.\n \n \n Resolved Issues\n@@ -164,10 +170,6 @@ Resolved Issues\n This section is a comment. Make sure to start the actual text at the margin.\n \n \n-EAL\n-~~~\n-\n-\n Drivers\n ~~~~~~~\n \n@@ -178,17 +180,6 @@ Drivers\n * **enic: Fixed high driver overhead when servicing Rx queues beyond the first.**\n \n \n-Libraries\n-~~~~~~~~~\n-\n-\n-Examples\n-~~~~~~~~\n-\n-\n-Other\n-~~~~~\n-\n \n Known Issues\n ------------\n@@ -204,14 +195,14 @@ Known Issues\n \n * **L3fwd-power app does not work properly when Rx vector is enabled.**\n \n- Using some drivers with vector enabled, makes L3fwd-power app not work\n- properly, since the queue monitoring works differently when using\n- scalar compared to vector, making the frequency scaling not to work correctly.\n- In addition, L3fwd-power requires the mbuf to have correct packet type,\n- but in some drivers, the vector mode must be disabled for this.\n+ The L3fwd-power app doesn't work properly with some drivers in vector mode\n+ since the queue monitoring works differently between scalar and vector modes\n+ leading to incorrect frequency scaling. In addition, L3fwd-power application\n+ requires the mbuf to have correct packet type set but in some drivers the\n+ vector mode must be disabled for this.\n \n Therefore, in order to use L3fwd-power, vector mode should be disabled\n- from the config file.\n+ via the config file.\n \n \n API Changes\n@@ -224,38 +215,42 @@ API Changes\n \n This section is a comment. Make sure to start the actual text at the margin.\n \n-* The driver names have been changed. It especially impacts ``--vdev`` arguments.\n- Examples: ``eth_pcap`` becomes ``net_pcap``\n- and ``cryptodev_aesni_mb_pmd`` becomes ``crypto_aesni_mb``.\n+* The driver naming convention has been changed to make them more\n+ consistent. It especially impacts ``--vdev`` arguments. For example\n+ ``eth_pcap`` becomes ``net_pcap`` and ``cryptodev_aesni_mb_pmd`` becomes\n+ ``crypto_aesni_mb``.\n+\n+ For backward compatibility an alias feature has been enabled to support the\n+ original names.\n \n-* The log history is removed.\n+* The log history has been removed.\n \n * The ``rte_ivshmem`` feature (including library and EAL code) has been removed\n in 16.11 because it had some design issues which were not planned to be fixed.\n \n * The ``file_name`` data type of ``struct rte_port_source_params`` and\n- ``struct rte_port_sink_params`` is changed from `char *`` to ``const char *``.\n+ ``struct rte_port_sink_params`` is changed from ``char *`` to ``const char *``.\n \n-* **Improved device/driver hierarchy and generalized hotplugging**\n+* **Improved device/driver hierarchy and generalized hotplugging.**\n \n- Device and driver relationship has been restructured by introducing generic\n- classes. This paves way for having PCI, VDEV and other device types as\n- just instantiated objects rather than classes in themselves. Hotplugging too\n- has been generalized into EAL so that ethernet or crypto devices can use the\n+ The device and driver relationship has been restructured by introducing generic\n+ classes. This paves the way for having PCI, VDEV and other device types as\n+ instantiated objects rather than classes in themselves. Hotplugging has also\n+ been generalized into EAL so that Ethernet or crypto devices can use the\n common infrastructure.\n \n- * removed ``pmd_type`` as way of segregation of devices\n- * moved ``numa_node`` and ``devargs`` into ``rte_driver`` from\n+ * Removed ``pmd_type`` as a way of segregation of devices.\n+ * Moved ``numa_node`` and ``devargs`` into ``rte_driver`` from\n ``rte_pci_driver``. These can now be used by any instantiated object of\n ``rte_driver``.\n- * added ``rte_device`` class and all PCI and VDEV devices inherit from it\n- * renamed devinit/devuninit handlers to probe/remove to make it more\n- semantically correct with respect to device<=>driver relationship\n- * moved hotplugging support to EAL. Hereafter, PCI and vdev can use the\n+ * Added ``rte_device`` class and all PCI and VDEV devices inherit from it\n+ * Renamed devinit/devuninit handlers to probe/remove to make it more\n+ semantically correct with respect to the device <=> driver relationship.\n+ * Moved hotplugging support to EAL. Hereafter, PCI and vdev can use the\n APIs ``rte_eal_dev_attach`` and ``rte_eal_dev_detach``.\n- * helpers and support macros have been renamed to make them more synonymous\n+ * Renamed helpers and support macros to make them more synonymous\n with their device types\n- (e.g. ``PMD_REGISTER_DRIVER`` => ``RTE_PMD_REGISTER_PCI``)\n+ (e.g. ``PMD_REGISTER_DRIVER`` => ``RTE_PMD_REGISTER_PCI``).\n * Device naming functions have been generalized from ethdev and cryptodev\n to EAL. ``rte_eal_pci_device_name`` has been introduced for obtaining\n unique device name from PCI Domain-BDF description.\n", "prefixes": [ "dpdk-dev", "v1" ] }