From: "Mcnamara, John" <john.mcnamara@intel.com>
To: "Rao, Nikhil" <nikhil.rao@intel.com>,
"jerin.jacob@caviumnetworks.com" <jerin.jacob@caviumnetworks.com>
Cc: "dev@dpdk.org" <dev@dpdk.org>
Subject: Re: [dpdk-dev] [PATCH v2] doc: add event eth Rx adapter programmer's guide
Date: Mon, 23 Oct 2017 12:19:14 +0000 [thread overview]
Message-ID: <B27915DBBA3421428155699D51E4CFE23EDE131E@IRSMSX103.ger.corp.intel.com> (raw)
In-Reply-To: <1508320690-12047-1-git-send-email-nikhil.rao@intel.com>
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Nikhil Rao
> Sent: Wednesday, October 18, 2017 10:58 AM
> To: jerin.jacob@caviumnetworks.com
> Cc: dev@dpdk.org
> Subject: [dpdk-dev] [PATCH v2] doc: add event eth Rx adapter programmer's
> guide
>
> Add programmer's guide doc to explain the use of the Event Ethernet Rx
> Adapter library.
>
> Signed-off-by: Nikhil Rao <nikhil.rao@intel.com>
> +
> +Event Ethernet Rx Adapter Library
> +=================================
> +
> +The DPDK Eventdev API allows the application to use an event driven
> +programming model for packet processing. In this model, the application
> +polls an event device port for receiving events that reference packets
> +instead of polling Rx queues of ethdev ports. Packet transfer between
> +ethdev and the event device can be supported in hardware or require a
> +software thread to receive packets from the ethdev port using ethdev
> +poll mode APIs and enqueue these as events to the event device using
> +the eventdev API. Both transfer mechanisms may be present on the same
> platform depending on the particular combination of the ethdev and the
> event device.
In general the text in paragraphs should be wrapped at 80 chars:
http://dpdk.org/doc/guides/contributing/documentation.html#line-length
> +
> +For SW based packet transfers from ethdev to eventdev, the the adapter
s/the the/the/
> +.. code-block:: c
> +
> + int err;
> + uint8_t dev_id;
> + struct rte_event_dev_info dev_info;
> + struct rte_event_port_conf rx_p_conf;
Code in the docs should be indented with spaces not tabs:
http://dpdk.org/doc/guides/contributing/documentation.html#whitespace
> +
> +Querying Adapter Capabilties
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~
s/Capabilties/Capabilities/ Also adjust the underline length to match.
> +Adding Rx Queues to the Adapter Instance
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +
> +Ethdev Rx queues are added to the instance using the
> +rte_event_eth_rx_adapter_queue_add() function. Configuration for the Rx
> +queue is passed in using a struct rte_event_eth_rx_adapter_queue_conf
> +parameter. Event information for packets from this Rx queue is encoded
> +in the ''ev'' field of struct rte_event_eth_rx_adapter_queue_conf. The
Probably ''ev'' should be in backquotes: ``ev``. Also all function and
struct names in the doc should be in backquotes.
http://dpdk.org/doc/guides/contributing/documentation.html#code-and-literal-block-sections
Also, could you mark the previous version of this doc as superseded in patchwork:
http://dpdk.org/dev/patchwork/project/dpdk/list/?submitter=&state=&q=doc%3A+add+event+eth+Rx+adapter+programmer&archive=&delegate=
Thanks,
John
next prev parent reply other threads:[~2017-10-23 12:19 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-10-18 9:15 [dpdk-dev] [PATCH] " Nikhil Rao
2017-10-18 9:58 ` [dpdk-dev] [PATCH v2] " Nikhil Rao
2017-10-21 15:56 ` Jerin Jacob
2017-10-23 12:19 ` Mcnamara, John [this message]
2017-10-24 9:13 ` [dpdk-dev] [PATCH v3] " Nikhil Rao
2017-11-07 22:09 ` Thomas Monjalon
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=B27915DBBA3421428155699D51E4CFE23EDE131E@IRSMSX103.ger.corp.intel.com \
--to=john.mcnamara@intel.com \
--cc=dev@dpdk.org \
--cc=jerin.jacob@caviumnetworks.com \
--cc=nikhil.rao@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).