[dpdk-dev] [PATCH v2] doc: add the doc for mlx5 specific header
Bing Zhao
bingz at nvidia.com
Fri Oct 30 10:29:22 CET 2020
The file "rte_pmd_mlx5.h" is used to provide mlx5 PMD specific APIs
and it needs to be included in the document generation.
Signed-off-by: Bing Zhao <bingz at nvidia.com>
Reviewed-by: Thomas Monjalon <thomas at monjalon.net>
Acked-by: Ori Kam <orika at nvidia.com>
---
v2: use alphabet order properly for "doxy-api.conf.in"
---
doc/api/doxy-api-index.md | 1 +
doc/api/doxy-api.conf.in | 1 +
2 files changed, 2 insertions(+)
diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md
index a9c12d1..8ea2c4d 100644
--- a/doc/api/doxy-api-index.md
+++ b/doc/api/doxy-api-index.md
@@ -51,6 +51,7 @@ The public API headers are grouped by topics:
[dpaa2_mempool] (@ref rte_dpaa2_mempool.h),
[dpaa2_cmdif] (@ref rte_pmd_dpaa2_cmdif.h),
[dpaa2_qdma] (@ref rte_pmd_dpaa2_qdma.h),
+ [mlx5] (@ref rte_pmd_mlx5.h),
[crypto_scheduler] (@ref rte_cryptodev_scheduler.h)
- **memory**:
diff --git a/doc/api/doxy-api.conf.in b/doc/api/doxy-api.conf.in
index e37f8c2..567fe62 100644
--- a/doc/api/doxy-api.conf.in
+++ b/doc/api/doxy-api.conf.in
@@ -15,6 +15,7 @@ INPUT = @TOPDIR@/doc/api/doxy-api-index.md \
@TOPDIR@/drivers/net/i40e \
@TOPDIR@/drivers/net/ice \
@TOPDIR@/drivers/net/ixgbe \
+ @TOPDIR@/drivers/net/mlx5 \
@TOPDIR@/drivers/net/softnic \
@TOPDIR@/drivers/raw/dpaa2_cmdif \
@TOPDIR@/drivers/raw/dpaa2_qdma \
--
1.8.3.1
More information about the dev
mailing list