doc: fix wrong tag for Inner RSS

Message ID 20190301111010.21990-1-ramirose@gmail.com
State Accepted, archived
Delegated to: Ferruh Yigit
Headers show
Series
  • doc: fix wrong tag for Inner RSS
Related show

Checks

Context Check Description
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

Rami Rosen March 1, 2019, 11:10 a.m.
This patch fixes a wrong tag in guides/nics/features.rst. 
The features tags should be, according to the 
"Features Overview" section in this doc, one of the following:
"uses", "implements", "provides", or "related".
Hence in Inner RSS section, it should be "uses"
instead of "users".

Fixes: d0a87d9aa8de ("doc: update mlx5 guide on tunnel offloading")

Signed-off-by: Rami Rosen <ramirose@gmail.com>
---
 doc/guides/nics/features.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Ferruh Yigit March 4, 2019, 6:11 p.m. | #1
On 3/1/2019 11:10 AM, Rami Rosen wrote:
> This patch fixes a wrong tag in guides/nics/features.rst. 
> The features tags should be, according to the 
> "Features Overview" section in this doc, one of the following:
> "uses", "implements", "provides", or "related".
> Hence in Inner RSS section, it should be "uses"
> instead of "users".
> 
> Fixes: d0a87d9aa8de ("doc: update mlx5 guide on tunnel offloading")
> 
> Signed-off-by: Rami Rosen <ramirose@gmail.com>

Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>

Applied to dpdk-next-net/master, thanks.

Patch

diff --git a/doc/guides/nics/features.rst b/doc/guides/nics/features.rst
index d3f904839..c5bf32222 100644
--- a/doc/guides/nics/features.rst
+++ b/doc/guides/nics/features.rst
@@ -285,7 +285,7 @@  Inner RSS
 
 Supports RX RSS hashing on Inner headers.
 
-* **[users]    rte_flow_action_rss**: ``level``.
+* **[uses]    rte_flow_action_rss**: ``level``.
 * **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_RSS_HASH``, ``mbuf.rss``.