doc: add the doc for mlx5 specific header
PATCH 1/1 doc: add the doc for mlx5 specific header
The file "rte_pmd_mlx5.h" is used to provide mlx5 PMD specific APIs and it needs to be included in the document generation.
--- doc/api/doxy-api-index.md | 1 + doc/api/doxy-api.conf.in | 1 + 2 files changed, 2 insertions(+)
doc/api/doxy-api-index.md +1 -0
@@ -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**:
doc/api/doxy-api.conf.in +1 -0
@@ -16,6 +16,7 @@ INPUT = @TOPDIR@/doc/api/doxy-api-index.md \ @TOPDIR@/drivers/net/ice \ @TOPDIR@/drivers/net/ixgbe \ @TOPDIR@/drivers/net/softnic \ + @TOPDIR@/drivers/net/mlx5 \ @TOPDIR@/drivers/raw/dpaa2_cmdif \ @TOPDIR@/drivers/raw/dpaa2_qdma \ @TOPDIR@/drivers/raw/ioat \
Signature · 1 line
1.8.3.1
Hi
Quoted 39 lines
-----Original Message-----
From: dev <[email protected]> On Behalf Of Bing Zhao
Sent: Thursday, October 29, 2020 11:42 AM
Subject: [dpdk-dev] [PATCH] doc: add the doc for mlx5 specific headerThe 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 <[email protected]>--- doc/api/doxy-api-index.md | 1 + doc/api/doxy-api.conf.in | 1 + 2 files changed, 2 insertions(+)doc/api/doxy-api-index.md +1
-0@@ -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**:doc/api/doxy-api.conf.in +1
-0@@ -16,6 +16,7 @@ INPUT = @TOPDIR@/doc/api/doxy-api- index.md \ @TOPDIR@/drivers/net/ice \ @TOPDIR@/drivers/net/ixgbe \ @TOPDIR@/drivers/net/softnic \ + @TOPDIR@/drivers/net/mlx5 \ @TOPDIR@/drivers/raw/dpaa2_cmdif \ @TOPDIR@/drivers/raw/dpaa2_qdma \@TOPDIR@/drivers/raw/ioat \
Quoted 2 lines
--
1.8.3.1
Thanks,
Ori
29/10/2020 10:41, Bing Zhao:
Quoted 7 lines
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 <[email protected]>
doc/api/doxy-api.conf.in INPUT = @TOPDIR@/doc/api/doxy-api-index.md \ · line 22
Quoted 7 lines
doc/api/doxy-api.conf.in +1
-0@@ -16,6 +16,7 @@ INPUT = @TOPDIR@/doc/api/doxy-api-index.md \ @TOPDIR@/drivers/net/ice \ @TOPDIR@/drivers/net/ixgbe \ @TOPDIR@/drivers/net/softnic \ + @TOPDIR@/drivers/net/mlx5 \ @TOPDIR@/drivers/raw/dpaa2_cmdif \ @TOPDIR@/drivers/raw/dpaa2_qdma \ @TOPDIR@/drivers/raw/ioat \
In this alphabetical order, it should be before softnic.
Thanks a lot, I will send v2.
Quoted 31 lines
-----Original Message-----
From: Thomas Monjalon <[email protected]>
Sent: Friday, October 30, 2020 12:06 AM
To: [email protected]; Bing Zhao <[email protected]>
Cc: Ori Kam <[email protected]>; [email protected]
Subject: Re: [PATCH] doc: add the doc for mlx5 specific headerExternal email: Use caution opening links or attachments
29/10/2020 10:41, Bing Zhao:
Quoted 1 line
The file "
rte_pmd_mlx5.h" is used to provide mlx5 PMD specificAPIs
doc/api/doxy-api.conf.in INPUT = @TOPDIR@/doc/api/doxy-
Quoted 6 lines
and it needs to be included in the document generation.
Signed-off-by Bing Zhao <[email protected]>doc/api/doxy-api.conf.in +0
-0@@ -16,6 +16,7 @@ INPUT = @TOPDIR@/doc/api/doxy-api-index.md \
doc/api/doxy-api.conf.in INPUT = @TOPDIR@/doc/api/doxy-api-index.md \ · line 22
Quoted 7 lines
doc/api/doxy-api.conf.in +1
-0@TOPDIR@/drivers/net/ice \ @TOPDIR@/drivers/net/ixgbe \ @TOPDIR@/drivers/net/softnic \ + @TOPDIR@/drivers/net/mlx5 \ @TOPDIR@/drivers/raw/dpaa2_cmdif \ @TOPDIR@/drivers/raw/dpaa2_qdma \ @TOPDIR@/drivers/raw/ioat \In this alphabetical order, it should be before softnic.
PATCH v2 1/1 doc: add the doc for mlx5 specific header
In reply to Bing ZhaoThe file "rte_pmd_mlx5.h" is used to provide mlx5 PMD specific APIs and it needs to be included in the document generation.
---
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(+)
doc/api/doxy-api-index.md +1 -0
@@ -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**:
doc/api/doxy-api.conf.in +1 -0
@@ -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 \
Signature · 1 line
1.8.3.1