[dpdk-dev] [PATCH v4 2/3] doc: add mempool and octeontx mempool device

[Mcnamara, John]

> -----Original Message-----
> From: Santosh Shukla [mailto:santosh.shukla at caviumnetworks.com]
> Sent: Friday, October 20, 2017 4:21 PM
> To: dev at dpdk.org
> Cc: thomas at monjalon.net; jerin.jacob at caviumnetworks.com; Mcnamara, John
> <john.mcnamara at intel.com>; Santosh Shukla
> <santosh.shukla at caviumnetworks.com>
> Subject: [PATCH v4 2/3] 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.
> 


> ...
> diff --git a/doc/guides/index.rst b/doc/guides/index.rst index
> 9c24dcb46..c92bb8003 100644
> --- a/doc/guides/index.rst
> +++ b/doc/guides/index.rst
> @@ -48,3 +48,4 @@ DPDK documentation
>     rel_notes/index
>     faq/index
>     platform/index
> +   mempool/index

This new section should go before platform and after evendev.





> +Feature
> +-------

Probably "Features" is better.



> +
> +Features of the OCTEONTX FPAVF PMD are:
> +
> +- 32 SR-IOV Virtual functions
> +- 32 Pools
> +- HW mempool manager
> +
> +Supported OCTEONTX SoCs
> +-----------------------
> +
> +- CN83xx
> +
> +Prerequisites
> +-------------
> +
> +Ref: `OCTEONTX Platform Driver` for setup information of PMD.

You could use a link here, like this:

See :doc:`../platform/octeontx` for setup information.

John