DPDK patches and discussions
 help / color / mirror / Atom feed

From: "Mcnamara, John" <john.mcnamara@intel.com>
To: "Wang, Zhihong" <zhihong.wang@intel.com>, "dev@dpdk.org" <dev@dpdk.org>
Cc: "Wang, Zhihong" <zhihong.wang@intel.com>
Subject: Re: [dpdk-dev] [PATCH] doc: virtio pmd versions
Date: Thu, 9 Jun 2016 12:35:32 +0000	[thread overview]
Message-ID: <B27915DBBA3421428155699D51E4CFE20257E55D@IRSMSX103.ger.corp.intel.com> (raw)
In-Reply-To: <1461210924-104947-1-git-send-email-zhihong.wang@intel.com>

> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Zhihong Wang
> Sent: Thursday, April 21, 2016 4:55 AM
> To: dev@dpdk.org
> Cc: Wang, Zhihong <zhihong.wang@intel.com>
> Subject: [dpdk-dev] [PATCH] doc: virtio pmd versions
> 
> This patch explains all the versions of current virtio pmd implementation,
> what's the difference, and how to choose the right version.

Hi,

Thanks for the clarification docs. That should hopefully answer a frequently
asked question.

Some minor comments below.


> +
> +Virtio PMD Versions
> +-------------------
> +
> +Virtio driver has 3 versions of rx functions and 2 versions of tx
> functions.

In some places RX/TX is used and in some rx/tx. I would suggest the
uppercase versions throughout.



> +
> +RX functions:
> +
> +*   ``virtio_recv_pkts``:
> +
> +    Regular version without mergeable rx buffers support


Since these could be a numbered list I would suggest using "#." (numbered
list) instead of "*" (bullet list). Also it would be better without a blank
line between the name and the definition so that they appear on the same
line in the generated docs.


> +
> +    Simple version without mergeable rx buffers support, also fixes the
> + avail ring and uses vector instructions to optimize performance

s/avail/available in 2 places.

Also should that be "available ring size" or "number of available rings"
or something else?


> +Example to use the simple version of virtio poll mode driver in testpmd:
> +
> +.. code-block:: console
> +
> +./x86_64-native-linuxapp-gcc/app/testpmd -c 0x7 -n 4
> +    --  -i --txqflags=0xf01 --rxq=1 --txq=1 --nb-cores=1


The code/commandline needs to be indented 3-4 spaces to be rendered
correctly. I'd also suggest omitting "./x86_64-native-linuxapp-gcc/app/" and
just using "testpmd" since that commandline is target dependent. The command
would also fit on one line like that.

Thanks,

John.
-- 

next prev parent reply	other threads:[~2016-06-09 12:35 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-04-21  3:55 Zhihong Wang
2016-06-09 12:35 ` Mcnamara, John [this message]
2016-06-09 12:52   ` Richardson, Bruce
2016-06-09 12:56     ` Mcnamara, John
2016-06-15  6:59       ` Wang, Zhihong
2016-06-14 23:53 ` [dpdk-dev] [PATCH v2] " Zhihong Wang
2016-06-24 16:03   ` Mcnamara, John
2016-06-29  3:27   ` Yuanhan Liu
2016-07-01  3:28 ` [dpdk-dev] [PATCH v3] doc: virtio PMD Rx/Tx callbacks Zhihong Wang
2016-07-04  2:56   ` Yuanhan Liu
2016-07-04  3:00     ` Wang, Zhihong

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=B27915DBBA3421428155699D51E4CFE20257E55D@IRSMSX103.ger.corp.intel.com \
    --to=john.mcnamara@intel.com \
    --cc=dev@dpdk.org \
    --cc=zhihong.wang@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

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