From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from out4-smtp.messagingengine.com (out4-smtp.messagingengine.com [66.111.4.28]) by dpdk.org (Postfix) with ESMTP id 591C91B294 for ; Wed, 8 Nov 2017 21:51:57 +0100 (CET) Received: from compute1.internal (compute1.nyi.internal [10.202.2.41]) by mailout.nyi.internal (Postfix) with ESMTP id D232E20D41; Wed, 8 Nov 2017 15:51:56 -0500 (EST) Received: from frontend2 ([10.202.2.161]) by compute1.internal (MEProxy); Wed, 08 Nov 2017 15:51:56 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=monjalon.net; h= cc:date:from:message-id:subject:to:x-me-sender:x-me-sender :x-sasl-enc; s=mesmtp; bh=ycTQ26+eRtNJOZzqDTHvN4OJ6CPi/H5fuwumYD vACGQ=; b=FRR4xvsS8cpyt5JqrsfgNgW9PlabPC4tIU/IO0EfPLET3PglTWB7dv 2HQVwtct0ll5ftx7HpRw2U6yCcq9k8heFGdm8AD9Q2PTnM/HAN/9AmJWXWz/Vy3b 2I5Tw4uiqUkDeZhZ5YnrHTgzhy7kSz//m6B1Uqbl6tnhubZLkJ69I= DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:date:from:message-id:subject:to :x-me-sender:x-me-sender:x-sasl-enc; s=fm1; bh=ycTQ26+eRtNJOZzqD THvN4OJ6CPi/H5fuwumYDvACGQ=; b=F88j3NnNv6y0MtkPYbxRk+ny6g6iOVmId nSGn6ysdxLNg/g9pYZn5x9/R2ZOA7CuY7omduXO+vila1zs4CUG84rWbLy4FqXDj rSyrbN3GecKCoPm1Z3979cwvYfCGrehN5cejAjRiueYYHlLbbMrPQWvVS1p4j6oJ H1YzTmhP6cNa4yv7xfZ2qhpmBsGDorhKXW2eZuSBCZyPaG89C100aGE9/TwiEDCE gsddDKqNVs7d2ymsjHAmxtW5PXqrc6vGm0feeNVmT1K8xvLskB6vA4MtiDKLMtKX nVQxhMAt9DQET7Ohzdm1TsidS/2zW5reewPogt9XjN+F5mIr5VEDw== X-ME-Sender: Received: from xps.monjalon.net (184.203.134.77.rev.sfr.net [77.134.203.184]) by mail.messagingengine.com (Postfix) with ESMTPA id 22494247F0; Wed, 8 Nov 2017 15:51:56 -0500 (EST) From: Thomas Monjalon To: john.mcnamara@intel.com, ferruh.yigit@intel.com Cc: dev@dpdk.org, shahafs@mellanox.com Date: Wed, 8 Nov 2017 21:51:47 +0100 Message-Id: <20171108205147.29923-1-thomas@monjalon.net> X-Mailer: git-send-email 2.14.2 Subject: [dpdk-dev] [PATCH] doc: move fast mbuf free feature in net guide 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, 08 Nov 2017 20:51:57 -0000 The feature was added at the end of the table. And the description was between the anchor _nic_features_timesync and its title. It is moved near related features with a new anchor. It is also renamed from "mbuf fast free" to "fast mbuf free". Fixes: d6f90afd3070 ("ethdev: add mbuf fast free Tx offload") Signed-off-by: Thomas Monjalon --- doc/guides/nics/features.rst | 21 ++++++++++++--------- doc/guides/nics/features/default.ini | 2 +- 2 files changed, 13 insertions(+), 10 deletions(-) diff --git a/doc/guides/nics/features.rst b/doc/guides/nics/features.rst index bfeae80ef..d9917d4f5 100644 --- a/doc/guides/nics/features.rst +++ b/doc/guides/nics/features.rst @@ -136,6 +136,18 @@ invoke rte_eth_tx_burst() concurrently on the same Tx queue without SW lock. * **[related] API**: ``rte_eth_tx_burst()``. +.. _nic_features_fast_mbuf_free: + +Fast mbuf free +-------------- + +Supports optimization for fast release of mbufs following successful Tx. +Requires that per queue, all mbufs come from the same mempool and has refcnt = 1. + +* **[uses] rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_MBUF_FAST_FREE``. +* **[provides] rte_eth_dev_info**: ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_MBUF_FAST_FREE``. + + .. _nic_features_free_tx_mbuf_on_demand: Free Tx mbuf on demand @@ -640,15 +652,6 @@ Supports packet type parsing and returns a list of supported types. .. _nic_features_timesync: -Mbuf fast free --------------- - -Supports optimization for fast release of mbufs following successful Tx. -Requires that per queue, all mbufs come from the same mempool and has refcnt = 1. - -* **[uses] rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_MBUF_FAST_FREE``. -* **[provides] rte_eth_dev_info**: ``tx_offload_capa,tx_queue_offload_capa:DEV_TX_OFFLOAD_MBUF_FAST_FREE``. - Timesync -------- diff --git a/doc/guides/nics/features/default.ini b/doc/guides/nics/features/default.ini index dc527ddf9..95c569869 100644 --- a/doc/guides/nics/features/default.ini +++ b/doc/guides/nics/features/default.ini @@ -14,6 +14,7 @@ Removal event = Queue status event = Rx interrupt = Lock-free Tx queue = +Fast mbuf free = Free Tx mbuf on demand = Queue start/stop = MTU update = @@ -76,4 +77,3 @@ x86-64 = Usage doc = Design doc = Perf doc = -Mbuf fast free = -- 2.14.2