Skip to contentSkip to conversation

net/af_packet: fix docs guide

PATCH In review Rami Rosen 2 participants 2 messages Dec 18, 2018 – Dec 20, 2018

lore
Share & tools
lore

Rami Rosen

author
#0 lore raw

PATCH 1/1 net/af_packet: fix docs guide

The framecnt option represents a counter (integer) that does not reflect size. It is somewhat parallel in this sense to the framecount member of pkt_rx_queue/pkt_tx_queue (or tp_frame_nr in tpacket_req). This patch removes the size indicator of bytes ("B") from framecnt in the af_packet guide.

Fixes c8dba1ee6cde ("doc: add af_packet PMD guide")
Signed-off-by Rami Rosen <[email protected]>
---
 doc/guides/nics/af_packet.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
doc/guides/nics/af_packet.rst +2 -2
index 188a6efe1..1260bb2c6 100644
@@ -28,7 +28,7 @@ Some of these, in turn, will be used to configure the PAKET_MMAP settings.
 *   ``blocksz`` - PACKET_MMAP block size (optional, default 4096);
 *   ``framesz`` - PACKET_MMAP frame size (optional, default 2048B; Note: multiple
     of 16B);
-*   ``framecnt`` - PACKET_MMAP frame count (optional, default 512B).
+*   ``framecnt`` - PACKET_MMAP frame count (optional, default 512).
 
 Because this implementation is based on PACKET_MMAP, and PACKET_MMAP has its
 own pre-requisites, it should be noted that the inner workings of PACKET_MMAP

@@ -60,7 +60,7 @@ Set up an af_packet interface
 
 The following example will set up an af_packet interface in DPDK with the
 default options described above (blocksz=4096B, framesz=2048B and
-framecnt=512B):
+framecnt=512):
 
 .. code-block:: console
Signature · 1 line
2.17.1
Reviewed-by on v1 1/1
#1 lore raw
Quoted 9 lines · Rami Rosen

The framecnt option represents a counter (integer) that does not reflect size. It is somewhat parallel in this sense to the framecount member of pkt_rx_queue/pkt_tx_queue (or tp_frame_nr in tpacket_req). This patch removes the size indicator of bytes ("B") from framecnt in the af_packet guide.

Fixes c8dba1ee6cde ("doc: add af_packet PMD guide")
Signed-off-by Rami Rosen <[email protected]>
Reviewed-by Ferruh Yigit <[email protected]>

(Squashed into relevant commit in next-net, thanks.)