[dpdk-next-net] net/af_packet: fix docs guide
Checks
Commit Message
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 <ramirose@gmail.com>
---
doc/guides/nics/af_packet.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
Comments
On 12/18/2018 7:10 AM, Rami Rosen wrote:
> 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 <ramirose@gmail.com>
Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>
(Squashed into relevant commit in next-net, thanks.)
@@ -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