[v2,7/8] doc: fix description of L2TPV2 flow item
Checks
Commit Message
From: Thomas Monjalon <thomas@monjalon.net>
The flow item structure includes the protocol definition
from the directory lib/net/, so it is reflected in the guide.
Section title underlining is also fixed around.
Fixes: 3a929df1f286 ("ethdev: support L2TPv2 and PPP procotol")
Cc: stable@dpdk.org
Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
Acked-by: Ferruh Yigit <ferruh.yigit@amd.com>
---
Cc: jie1x.wang@intel.com
---
doc/guides/prog_guide/rte_flow.rst | 13 +++----------
1 file changed, 3 insertions(+), 10 deletions(-)
@@ -1485,22 +1485,15 @@ rte_flow_flex_item_create() routine.
value and mask.
Item: ``L2TPV2``
-^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^
Matches a L2TPv2 header.
-- ``flags_version``: flags(12b), version(4b).
-- ``length``: total length of the message.
-- ``tunnel_id``: identifier for the control connection.
-- ``session_id``: identifier for a session within a tunnel.
-- ``ns``: sequence number for this date or control message.
-- ``nr``: sequence number expected in the next control message to be received.
-- ``offset_size``: offset of payload data.
-- ``offset_padding``: offset padding, variable length.
+- ``hdr``: header definition (``rte_l2tpv2.h``).
- Default ``mask`` matches flags_version only.
Item: ``PPP``
-^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^
Matches a PPP header.