diff mbox

[dpdk-dev] doc: add PMD specific API

Message ID 20170127122720.13768-1-ferruh.yigit@intel.com (mailing list archive)
State Superseded, archived
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel compilation success Compilation OK

Commit Message

Ferruh Yigit Jan. 27, 2017, 12:27 p.m. UTC 
  Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
---
 doc/api/doxy-api-index.md | 4 ++++
 doc/api/doxy-api.conf     | 2 ++
 2 files changed, 6 insertions(+)

Comments

Thomas Monjalon Jan. 30, 2017, 5:57 p.m. UTC | #1 
2017-01-27 12:27, Ferruh Yigit:
> --- a/doc/api/doxy-api-index.md
> +++ b/doc/api/doxy-api-index.md
> @@ -153,3 +153,7 @@ There are many libraries, so their headers may be grouped by topics:
>    [ABI compat]         (@ref rte_compat.h),
>    [keepalive]          (@ref rte_keepalive.h),
>    [version]            (@ref rte_version.h)
> +
> +- **PMD specific**:
> +  [ixgbe]              (@ref rte_pmd_ixgbe.h),
> +  [i40e]               (@ref rte_pmd_i40e.h)

They could be grouped with bonding, vhost and KNI
in a section device-specific, below "device" section.
diff mbox

Patch

diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md
index f9958c4..525d2e1 100644
--- a/doc/api/doxy-api-index.md
+++ b/doc/api/doxy-api-index.md
@@ -153,3 +153,7 @@  There are many libraries, so their headers may be grouped by topics:
   [ABI compat]         (@ref rte_compat.h),
   [keepalive]          (@ref rte_keepalive.h),
   [version]            (@ref rte_version.h)
+
+- **PMD specific**:
+  [ixgbe]              (@ref rte_pmd_ixgbe.h),
+  [i40e]               (@ref rte_pmd_i40e.h)
diff --git a/doc/api/doxy-api.conf b/doc/api/doxy-api.conf
index 6892315..b8a5fd8 100644
--- a/doc/api/doxy-api.conf
+++ b/doc/api/doxy-api.conf
@@ -32,6 +32,8 @@  PROJECT_NAME            = DPDK
 INPUT                   = doc/api/doxy-api-index.md \
                           doc/api/examples.dox \
                           drivers/net/bonding \
+                          drivers/net/i40e \
+                          drivers/net/ixgbe \
                           lib/librte_eal/common/include \
                           lib/librte_eal/common/include/generic \
                           lib/librte_acl \