From: "Mcnamara, John" <john.mcnamara@intel.com>
To: Santosh Shukla <santosh.shukla@caviumnetworks.com>,
"dev@dpdk.org" <dev@dpdk.org>,
"olivier.matz@6wind.com" <olivier.matz@6wind.com>
Cc: "jerin.jacob@caviumnetworks.com" <jerin.jacob@caviumnetworks.com>,
"thomas@monjalon.net" <thomas@monjalon.net>,
"hemant.agrawal@nxp.com" <hemant.agrawal@nxp.com>
Subject: Re: [dpdk-dev] [PATCH v2 10/10] doc: add mempool and octeontx mempool device
Date: Tue, 19 Sep 2017 13:52:41 +0000 [thread overview]
Message-ID: <B27915DBBA3421428155699D51E4CFE23EDAA99D@IRSMSX103.ger.corp.intel.com> (raw)
In-Reply-To: <20170831063719.19273-11-santosh.shukla@caviumnetworks.com>
> -----Original Message-----
> From: Santosh Shukla [mailto:santosh.shukla@caviumnetworks.com]
> Sent: Thursday, August 31, 2017 7:37 AM
> To: dev@dpdk.org; olivier.matz@6wind.com
> Cc: jerin.jacob@caviumnetworks.com; Mcnamara, John
> <john.mcnamara@intel.com>; thomas@monjalon.net; hemant.agrawal@nxp.com;
> Santosh Shukla <santosh.shukla@caviumnetworks.com>
> Subject: [PATCH v2 10/10] doc: add mempool and octeontx mempool device
>
> This commit adds a section to the docs listing the mempool device PMDs
> available.
>
> It then adds the octeontx fpavf mempool PMD to the listed mempool devices.
>
> Cc: John McNamara <john.mcnamara@intel.com>
>
> Signed-off-by: Santosh Shukla <santosh.shukla@caviumnetworks.com>
> Signed-off-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
Minor comments below.
> +
> +OCTEONTX FPAVF Mempool Driver
> +==============================
Underscores should match the length of the title.
> +
> +Features OCTEONTX FPAVF PMD (**librte_mempool_octeontx**) is mempool
> +driver for offload mempool device found in **Cavium OCTEONTX** SoC
> +family.
I'd suggest something like:
The OCTEONTX FPAVF PMD (**librte_mempool_octeontx**) is a mempool
driver for offload mempool device found in **Cavium OCTEONTX** SoC
family.
> +
> +More information can be found at `Cavium, Inc Official Website
> +<http://www.cavium.com/OCTEON-TX_ARM_Processors.html>`_.
> +
> +Feature
> +--------
> +
> +Features of the OCTEONTX FPAVF PMD are:
> +- 32 SR-IOV Virtual functions
> +- 32 Pools
> +- HW mempool manager
A bullet list requires a blank line between the previous paragraph to render properly:
Features of the OCTEONTX FPAVF PMD are:
- 32 SR-IOV Virtual functions
- 32 Pools
- HW mempool manager
> +
> +Supported OCTEONTX SoCs
> +-----------------------
> +- CN83xx
Add a blank line after the title.
> + SDK and related information can be obtained from: `Cavium support site
> <https://support.cavium.com/>`_.
> +
> +- Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to
> setup the basic DPDK environment.
Remove the "-" bullet at the start of this line.
> +Initialization
> +--------------
> +
> +The octeontx fpavf mempool initialization similar to other mempool
> +drivers like ring. However user need to pass --base-virtaddr as command
> +line input to application example test_mempool.c application.
> +
> +Example:
> +
> +.. code-block:: console
> +
> + ./build/app/test -c 0xf --base-virtaddr=0x100000000000 --mbuf-pool-
> ops="octeontx_fpavf"
Wrap the long commandline for the pdf docs:
.. code-block:: console
./build/app/test -c 0xf --base-virtaddr=0x100000000000 \
--mbuf-pool-ops="octeontx_fpavf"
Reviewed-by: John McNamara <john.mcnamara@intel.com>
next prev parent reply other threads:[~2017-09-19 13:52 UTC|newest]
Thread overview: 78+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-08-24 13:28 [dpdk-dev] [PATCH v1 00/11] Cavium Octeontx external mempool driver Santosh Shukla
2017-08-24 13:28 ` [dpdk-dev] [PATCH v1 01/11] mempool/octeontx: add HW constants Santosh Shukla
2017-08-24 13:28 ` [dpdk-dev] [PATCH v1 02/11] mempool/octeontx: add build and log infrastructure Santosh Shukla
2017-08-24 13:28 ` [dpdk-dev] [PATCH v1 03/11] mempool/octeontx: probe fpavf pcie devices Santosh Shukla
2017-08-24 13:28 ` [dpdk-dev] [PATCH v1 04/11] mempool/octeontx: implement pool alloc Santosh Shukla
2017-08-24 13:28 ` [dpdk-dev] [PATCH v1 05/11] mempool/octeontx: implement pool free Santosh Shukla
2017-08-24 13:28 ` [dpdk-dev] [PATCH v1 06/11] mempool/octeontx: implement pool enq and deq Santosh Shukla
2017-08-24 13:28 ` [dpdk-dev] [PATCH v1 07/11] mempool/octeontx: implement pool get count Santosh Shukla
2017-08-24 13:29 ` [dpdk-dev] [PATCH v1 08/11] mempool/octeontx: implement pool get capability Santosh Shukla
2017-08-24 13:29 ` [dpdk-dev] [PATCH v1 09/11] mempool/octeontx: implement pool update range Santosh Shukla
2017-08-24 13:29 ` [dpdk-dev] [PATCH v1 10/11] mempool/octeontx: translate handle to pool Santosh Shukla
2017-08-24 13:29 ` [dpdk-dev] [PATCH v1 11/11] doc: add mempool and octeontx mempool device Santosh Shukla
2017-08-31 6:37 ` [dpdk-dev] [PATCH v2 00/10] Cavium Octeontx external mempool driver Santosh Shukla
2017-08-31 6:37 ` [dpdk-dev] [PATCH v2 01/10] mempool/octeontx: add HW constants Santosh Shukla
2017-08-31 6:37 ` [dpdk-dev] [PATCH v2 02/10] mempool/octeontx: add build and log infrastructure Santosh Shukla
2017-08-31 6:37 ` [dpdk-dev] [PATCH v2 03/10] mempool/octeontx: probe fpavf pcie devices Santosh Shukla
2017-08-31 6:37 ` [dpdk-dev] [PATCH v2 04/10] mempool/octeontx: implement pool alloc Santosh Shukla
2017-10-06 20:51 ` Thomas Monjalon
2017-10-07 3:49 ` santosh
2017-08-31 6:37 ` [dpdk-dev] [PATCH v2 05/10] mempool/octeontx: implement pool free Santosh Shukla
2017-08-31 6:37 ` [dpdk-dev] [PATCH v2 06/10] mempool/octeontx: implement pool enq and deq Santosh Shukla
2017-08-31 6:37 ` [dpdk-dev] [PATCH v2 07/10] mempool/octeontx: implement pool get count Santosh Shukla
2017-08-31 6:37 ` [dpdk-dev] [PATCH v2 08/10] mempool/octeontx: implement pool get capability Santosh Shukla
2017-08-31 6:37 ` [dpdk-dev] [PATCH v2 09/10] mempool/octeontx: implement pool update range Santosh Shukla
2017-08-31 6:37 ` [dpdk-dev] [PATCH v2 10/10] doc: add mempool and octeontx mempool device Santosh Shukla
2017-09-19 13:52 ` Mcnamara, John [this message]
2017-09-19 8:29 ` [dpdk-dev] [PATCH v2 00/10] Cavium Octeontx external mempool driver santosh
2017-10-06 20:55 ` Thomas Monjalon
2017-10-07 3:51 ` santosh
2017-10-07 4:26 ` Ferruh Yigit
2017-10-07 4:46 ` santosh
2017-10-08 13:12 ` santosh
2017-10-08 12:40 ` [dpdk-dev] [PATCH v3 " Santosh Shukla
2017-10-08 12:40 ` [dpdk-dev] [PATCH v3 01/10] mempool/octeontx: add HW constants Santosh Shukla
2017-10-08 12:40 ` [dpdk-dev] [PATCH v3 02/10] mempool/octeontx: add build and log infrastructure Santosh Shukla
2017-10-08 17:16 ` Thomas Monjalon
2017-10-09 5:03 ` santosh
2017-10-08 12:40 ` [dpdk-dev] [PATCH v3 03/10] mempool/octeontx: probe fpavf pcie devices Santosh Shukla
2017-10-08 12:40 ` [dpdk-dev] [PATCH v3 04/10] mempool/octeontx: add support for alloc Santosh Shukla
2017-10-08 12:40 ` [dpdk-dev] [PATCH v3 05/10] mempool/octeontx: add support for free Santosh Shukla
2017-10-08 12:40 ` [dpdk-dev] [PATCH v3 06/10] mempool/octeontx: add support for enq and deq Santosh Shukla
2017-10-08 12:40 ` [dpdk-dev] [PATCH v3 07/10] mempool/octeontx: add support for get count Santosh Shukla
2017-10-08 12:40 ` [dpdk-dev] [PATCH v3 08/10] mempool/octeontx: add support for get capability Santosh Shukla
2017-10-08 12:40 ` [dpdk-dev] [PATCH v3 09/10] mempool/octeontx: add support for memory area ops Santosh Shukla
2017-10-08 12:40 ` [dpdk-dev] [PATCH v3 10/10] doc: add mempool and octeontx mempool device Santosh Shukla
2017-10-08 16:43 ` Thomas Monjalon
2017-10-09 5:01 ` santosh
2017-10-09 5:46 ` santosh
2017-10-09 8:48 ` Thomas Monjalon
2017-10-09 9:19 ` santosh
2017-10-18 12:17 ` santosh
2017-10-18 13:45 ` Thomas Monjalon
2017-10-18 14:02 ` santosh
2017-10-18 14:26 ` Thomas Monjalon
2017-10-18 14:36 ` Jerin Jacob
2017-10-18 15:11 ` Thomas Monjalon
2017-10-20 15:21 ` [dpdk-dev] [PATCH v4 0/3] Octeontx doc misc Santosh Shukla
2017-10-20 15:21 ` [dpdk-dev] [PATCH v4 1/3] doc: add platform device Santosh Shukla
2017-10-21 9:41 ` Jerin Jacob
2017-10-21 21:09 ` Thomas Monjalon
2017-10-23 14:35 ` Mcnamara, John
2017-10-20 15:21 ` [dpdk-dev] [PATCH v4 2/3] doc: add mempool and octeontx mempool device Santosh Shukla
2017-10-23 14:48 ` Mcnamara, John
2017-10-20 15:21 ` [dpdk-dev] [PATCH v4 3/3] doc: use correct mempool ops handle name Santosh Shukla
2017-10-21 9:42 ` Jerin Jacob
2017-10-23 13:12 ` Mcnamara, John
2017-10-20 16:07 ` [dpdk-dev] [PATCH v4 0/3] Octeontx doc misc Mcnamara, John
2017-10-20 21:10 ` Thomas Monjalon
2017-10-23 14:02 ` Mcnamara, John
2017-11-07 6:59 ` [dpdk-dev] [PATCH v5 0/3] Doc misc Santosh Shukla
2017-11-07 6:59 ` [dpdk-dev] [PATCH v5 1/3] doc: add platform guide Santosh Shukla
2017-11-10 17:42 ` Mcnamara, John
2017-11-07 6:59 ` [dpdk-dev] [PATCH v5 2/3] doc: add mempool and octeontx mempool device Santosh Shukla
2017-11-10 17:43 ` Mcnamara, John
2017-11-07 6:59 ` [dpdk-dev] [PATCH v5 3/3] doc: use correct mempool ops handle name Santosh Shukla
2017-11-10 17:43 ` Mcnamara, John
2017-11-12 3:52 ` [dpdk-dev] [PATCH v5 0/3] Doc misc Thomas Monjalon
2017-10-08 17:16 ` [dpdk-dev] [PATCH v3 00/10] Cavium Octeontx external mempool driver 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=B27915DBBA3421428155699D51E4CFE23EDAA99D@IRSMSX103.ger.corp.intel.com \
--to=john.mcnamara@intel.com \
--cc=dev@dpdk.org \
--cc=hemant.agrawal@nxp.com \
--cc=jerin.jacob@caviumnetworks.com \
--cc=olivier.matz@6wind.com \
--cc=santosh.shukla@caviumnetworks.com \
--cc=thomas@monjalon.net \
/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).