[PATCH v1 2/2] doc: update poll mode driver guide

[PATCH v1 2/2] doc: update poll mode driver guide

[Bernard Iremonger]

add information about new ixgbe PMD API.

Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com>
---
 doc/guides/prog_guide/poll_mode_drv.rst | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/doc/guides/prog_guide/poll_mode_drv.rst b/doc/guides/prog_guide/poll_mode_drv.rst
index bf3ea9f..3a400b2 100644
--- a/doc/guides/prog_guide/poll_mode_drv.rst
+++ b/doc/guides/prog_guide/poll_mode_drv.rst
@@ -356,3 +356,9 @@ Some additions in the metadata scheme are as follows:
 An example where queue numbers are used is as follows: ``tx_q7_bytes`` which
 indicates this statistic applies to queue number 7, and represents the number
 of transmitted bytes on that queue.
+
+Extended ixgbe PMD API
+~~~~~~~~~~~~~~~~~~~~~~
+
+In DPDK release v16.11 an API for ixgbe specific functions has been added to the ixgbe PMD.
+The declarations for the API functions are in the header ``rte_pmd_ixgbe.h``.
-- 
2.10.1

Re: [PATCH v1 2/2] doc: update poll mode driver guide

[Mcnamara, John]

> -----Original Message-----
> From: Iremonger, Bernard
> Sent: Friday, October 14, 2016 5:35 PM
> To: dev@dpdk.org; Mcnamara, John <john.mcnamara@intel.com>
> Cc: Iremonger, Bernard <bernard.iremonger@intel.com>
> Subject: [PATCH v1 2/2] doc: update poll mode driver guide
> 
> add information about new ixgbe PMD API.
> 
> Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com>

Acked-by: John McNamara <john.mcnamara@intel.com>

Re: [PATCH v1 2/2] doc: update poll mode driver guide

[Thomas Monjalon]

2016-10-14 17:35, Bernard Iremonger:
> --- a/doc/guides/prog_guide/poll_mode_drv.rst
> +++ b/doc/guides/prog_guide/poll_mode_drv.rst
> @@ -356,3 +356,9 @@ Some additions in the metadata scheme are as follows:
>  An example where queue numbers are used is as follows: ``tx_q7_bytes`` which
>  indicates this statistic applies to queue number 7, and represents the number
>  of transmitted bytes on that queue.
> +
> +Extended ixgbe PMD API
> +~~~~~~~~~~~~~~~~~~~~~~
> +
> +In DPDK release v16.11 an API for ixgbe specific functions has been added to the ixgbe PMD.
> +The declarations for the API functions are in the header ``rte_pmd_ixgbe.h``.

NACK
I think we should not add driver-specific details in this high-level and
generic doc.