From: Thomas Monjalon Date: Wed, 8 Nov 2017 20:44:10 +0000 (+0100) Subject: doc: move fast mbuf free feature in net guide X-Git-Tag: spdx-start~846 X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=651982e5efe2834e3aca51dcdee370beb51d457c;p=dpdk.git doc: move fast mbuf free feature in net guide 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 Acked-by: Ferruh Yigit --- diff --git a/doc/guides/nics/features.rst b/doc/guides/nics/features.rst index bfeae80eff..d9917d4f58 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 dc527ddf9e..95c5698690 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 =