[dpdk-dev] [PATCH] doc: move fast mbuf free feature in net guide

Thomas Monjalon thomas at monjalon.net
Wed Nov 8 21:51:47 CET 2017


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 <thomas at monjalon.net>
---
 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



More information about the dev mailing list