DPDK patches and discussions
 help / color / mirror / Atom feed
From: Rami Rosen <ramirose@gmail.com>
To: dev@dpdk.org
Cc: tiago.lam@intel.com, ferruh.yigit@intel.com,
	Rami Rosen <ramirose@gmail.com>
Subject: [dpdk-dev] [dpdk-next-net] [PATCH] net/af_packet: fix docs guide
Date: Tue, 18 Dec 2018 09:10:37 +0200	[thread overview]
Message-ID: <20181218071037.7762-1-ramirose@gmail.com> (raw)

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(-)

diff --git a/doc/guides/nics/af_packet.rst b/doc/guides/nics/af_packet.rst
index 188a6efe1..1260bb2c6 100644
--- a/doc/guides/nics/af_packet.rst
+++ b/doc/guides/nics/af_packet.rst
@@ -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
 
-- 
2.17.1

             reply	other threads:[~2018-12-18  7:10 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-12-18  7:10 Rami Rosen [this message]
2018-12-20 18:54 ` Ferruh Yigit

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20181218071037.7762-1-ramirose@gmail.com \
    --to=ramirose@gmail.com \
    --cc=dev@dpdk.org \
    --cc=ferruh.yigit@intel.com \
    --cc=tiago.lam@intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).