[dpdk-dev] [PATCH v2 10/10] doc: add mempool and octeontx mempool device

[Mcnamara, John]

> -----Original Message-----
> From: Santosh Shukla [mailto:santosh.shukla at caviumnetworks.com]
> Sent: Thursday, August 31, 2017 7:37 AM
> To: dev at dpdk.org; olivier.matz at 6wind.com
> Cc: jerin.jacob at caviumnetworks.com; Mcnamara, John
> <john.mcnamara at intel.com>; thomas at monjalon.net; hemant.agrawal at nxp.com;
> Santosh Shukla <santosh.shukla at 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 at intel.com>
> 
> Signed-off-by: Santosh Shukla <santosh.shukla at caviumnetworks.com>
> Signed-off-by: Jerin Jacob <jerin.jacob at 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 at intel.com>