[dpdk-dev] [PATCH v4 1/3] doc: add platform 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 1/3] doc: add platform device
> 
> This commit adds a section to the docs listing the platform device PMDs
> available.
> 
> It then adds the octeontx platform driver to the listed platform devices.
> 
> Patch also removes platform specific duplicate setup information from
> eventdev/octeontx.rst, nics/octeontx.rst and update to
> plaform/octeontx.rst.
> 


> ...
> diff --git a/doc/guides/index.rst b/doc/guides/index.rst index
> 5b6eb7ec5..9c24dcb46 100644
> --- a/doc/guides/index.rst
> +++ b/doc/guides/index.rst
> @@ -47,3 +47,4 @@ DPDK documentation
>     contributing/index
>     rel_notes/index
>     faq/index
> +   platform/index

The new doc should go after the Event Device section and before the
Contributors guide.


> ...
> +Platform Device Drivers
> +=======================
> +
> +The following are a list of platform device PMD, That has information
> +about their common hw blocks and steps to setup platform device.


Maybe something like this instead:


Platform Specific Guides
========================

The following are platform specific guides and setup information.


John