From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from out1-smtp.messagingengine.com (out1-smtp.messagingengine.com [66.111.4.25]) by dpdk.org (Postfix) with ESMTP id 1A8C14C93 for ; Wed, 30 May 2018 22:54:55 +0200 (CEST) Received: from compute1.internal (compute1.nyi.internal [10.202.2.41]) by mailout.nyi.internal (Postfix) with ESMTP id A40D621AD2; Wed, 30 May 2018 16:54:54 -0400 (EDT) Received: from mailfrontend1 ([10.202.2.162]) by compute1.internal (MEProxy); Wed, 30 May 2018 16:54:54 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=monjalon.net; h= cc:content-transfer-encoding:content-type:date:from:in-reply-to :message-id:mime-version:references:subject:to:x-me-sender :x-me-sender:x-sasl-enc; s=mesmtp; bh=DScc+Wz9pCSrDa1iEYYyuWHazY xg/kqfoNHcNpmN3ZY=; b=LzfCTlnxInC6GUu+MBk81NuTkc5s3viPRPhykSiM/B 69ukcjSkvyZhhLGLdIaQwOamC3XXMKnlohpIz9mmfNBS+E8rwS0a4gzmS1NXgID3 zJCr7uMCSSPgxJN2/JAl8HrPsSP3OlmlK3KGlBt1p8zFhPMtWvDUMH4TO2V+K2BU c= DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:content-transfer-encoding:content-type :date:from:in-reply-to:message-id:mime-version:references :subject:to:x-me-sender:x-me-sender:x-sasl-enc; s=fm2; bh=DScc+W z9pCSrDa1iEYYyuWHazYxg/kqfoNHcNpmN3ZY=; b=nicIlK5udwzvdKlLfvfF2o pce19P2zZlQkeTrmUAdhRtIf1dMedzYquC3Y1H4rhrFz9sWBMnJmiZGDj/Rh5BSd nZHwp37Jp3sgMz6Yb8G4UTmi4acWbwOsvqAG2RVIH/wmJjlUfCwjOmV1SQbwKre7 2VMQ9FCmMIEqktyeBrmqkTo0LPGzlxZyvGtr7z8JMDnyBeCRIGi8fWptUeP7tPWH LfZxa3p9J+y/BbeumbNSi9YweRJQs8rowHM20jFgUtJfZ0Omcyqh0TScdjGg1zyj dxXOOs4n5I6IsiyypUWo9CvuU2wcEYNErXwGt3+L4F7jiOaWk1viwk+rdYLheujA == X-ME-Proxy: X-ME-Proxy: X-ME-Proxy: X-ME-Proxy: X-ME-Proxy: X-ME-Proxy: X-ME-Sender: Received: from xps.localnet (184.203.134.77.rev.sfr.net [77.134.203.184]) by mail.messagingengine.com (Postfix) with ESMTPA id E2C9BE40A3; Wed, 30 May 2018 16:54:53 -0400 (EDT) From: Thomas Monjalon To: John McNamara Cc: dev@dpdk.org Date: Wed, 30 May 2018 22:54:52 +0200 Message-ID: <1968993.EMgpX6MGvE@xps> In-Reply-To: <1527711903-27143-1-git-send-email-john.mcnamara@intel.com> References: <1527711903-27143-1-git-send-email-john.mcnamara@intel.com> MIME-Version: 1.0 Content-Transfer-Encoding: 7Bit Content-Type: text/plain; charset="us-ascii" Subject: Re: [dpdk-dev] [PATCH v1] doc: update release notes for 18.05 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 30 May 2018 20:54:55 -0000 30/05/2018 22:25, John McNamara: > Fix grammar, spelling and formatting of DPDK 18.05 release notes. > > Signed-off-by: John McNamara Applied with few more changes below, thanks. --- b/doc/guides/rel_notes/release_18_05.rst +++ a/doc/guides/rel_notes/release_18_05.rst @@ -350,7 +350,7 @@ API Changes Also, make sure to start the actual text at the margin. ========================================================= -* service cores: Service cores no longer marked as experimental. +* service cores: No longer marked as experimental. The service cores functions are no longer marked as experimental, and have become part of the normal DPDK API and ABI. Any future ABI changes will be @@ -412,7 +412,7 @@ API Changes * ethdev: In struct ``struct rte_eth_dev_info``, field ``rte_pci_device *pci_dev`` has been replaced with field ``struct rte_device *device``. -* Changes to the semantics of ``rte_eth_dev_configure()`` parameters. +* ethdev: Changes to the semantics of ``rte_eth_dev_configure()`` parameters. If both the ``nb_rx_q`` and ``nb_tx_q`` parameters are zero, ``rte_eth_dev_configure()`` will now use PMD-recommended queue sizes, or if @@ -420,7 +420,7 @@ API Changes fall-back values. Previously setting both of the parameters to zero would have resulted in ``-EINVAL`` being returned. -* Changes to the semantics of ``rte_eth_rx_queue_setup()`` parameters. +* ethdev: Changes to the semantics of ``rte_eth_rx_queue_setup()`` parameters. If the ``nb_rx_desc`` parameter is zero, ``rte_eth_rx_queue_setup`` will now use the PMD-recommended Rx ring size, or in the case where the PMD @@ -428,7 +428,7 @@ API Changes fall-back value. Previously, setting ``nb_rx_desc`` to zero would have resulted in an error. -* Changes to the semantics of ``rte_eth_tx_queue_setup()`` parameters. +* ethdev: Changes to the semantics of ``rte_eth_tx_queue_setup()`` parameters. If the ``nb_tx_desc`` parameter is zero, ``rte_eth_tx_queue_setup`` will now use the PMD-recommended Tx ring size, or in the case where the PMD @@ -436,7 +436,7 @@ API Changes fall-back value. Previously, setting ``nb_tx_desc`` to zero would have resulted in an error. -* ethdev: several changes were made to the flow API. +* ethdev: Several changes were made to the flow API. * The unused DUP action was removed. * Actions semantics in flow rules: list order now matters ("first @@ -479,12 +479,12 @@ API Changes * ``RTE_FLOW_ACTION_TYPE_MARK`` item type has been added to match a flow against a previously marked flow. -* ethdev: change flow APIs regarding count action: +* ethdev: Change flow APIs regarding count action: * ``rte_flow_create()`` API count action now requires the ``struct rte_flow_action_count``. * ``rte_flow_query()`` API parameter changed from action type to action structure. -* ethdev: changes to offload API +* ethdev: Changes to offload API A pure per-port offloading isn't requested to be repeated in [rt]x_conf->offloads to ``rte_eth_[rt]x_queue_setup()``. Now any offloading enabled in ``rte_eth_dev_configure()`` @@ -492,7 +492,7 @@ API Changes not been enabled in ``rte_eth_dev_configure()`` and is requested to be enabled in ``rte_eth_[rt]x_queue_setup()`` must be per-queue type, or otherwise trigger an error log. -* ethdev: runtime queue setup: +* ethdev: Runtime queue setup ``rte_eth_rx_queue_setup`` and ``rte_eth_tx_queue_setup`` can be called after ``rte_eth_dev_start`` if the device supports runtime queue setup. The device driver can @@ -520,7 +520,7 @@ ABI Changes structure and the offset of the fields remains the same on platforms with 64B cache line, but changes on other platforms. -* mempool: Some Ops have changed. +* mempool: Some ops have changed. A new callback ``calc_mem_size`` has been added to ``rte_mempool_ops`` to allow customization of the required memory size calculation. @@ -532,7 +532,7 @@ ABI Changes Callback ``register_memory_area`` has been removed from ``rte_mempool_ops`` since the new callback ``populate`` may be used instead of it. -* **Additional fields in rte_eth_dev_info.** +* ethdev: Additional fields in rte_eth_dev_info. The ``rte_eth_dev_info`` structure has had two extra entries appended to the end of it: ``default_rxportconf`` and ``default_txportconf``. Each of these @@ -553,32 +553,19 @@ ABI Changes sanity fix in the VLAN pattern item (``struct rte_flow_item_vlan``) and new transfer attribute (``struct rte_flow_attr``). -**New parameter added to rte_bbdev_op_cap_turbo_dec.** +* bbdev: New parameter added to rte_bbdev_op_cap_turbo_dec. A new parameter ``max_llr_modulus`` has been added to ``rte_bbdev_op_cap_turbo_dec`` structure to specify maximal LLR (likelihood ratio) absolute value. -* **BBdev Queue Groups split into UL/DL Groups.** +* bbdev: Queue Groups split into UL/DL Groups. Queue Groups have been split into UL/DL Groups in the Turbo Software Driver. They are independent for Decode/Encode. ``rte_bbdev_driver_info`` reflects introduced 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. - ========================================================= - - Known Issues ------------