* [dpdk-dev] [PATCH] doc: add the doc for mlx5 specific header
@ 2020-10-29 9:41 Bing Zhao
2020-10-29 14:43 ` Ori Kam
` (2 more replies)
0 siblings, 3 replies; 5+ messages in thread
From: Bing Zhao @ 2020-10-29 9:41 UTC (permalink / raw)
To: orika, ferruh.yigit, thomas; +Cc: dev
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@nvidia.com>
---
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..932d10b 100644
--- a/doc/api/doxy-api.conf.in
+++ b/doc/api/doxy-api.conf.in
@@ -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 \
--
1.8.3.1
^ permalink raw reply [flat|nested] 5+ messages in thread* Re: [dpdk-dev] [PATCH] doc: add the doc for mlx5 specific header
2020-10-29 9:41 [dpdk-dev] [PATCH] doc: add the doc for mlx5 specific header Bing Zhao
@ 2020-10-29 14:43 ` Ori Kam
2020-10-29 16:05 ` Thomas Monjalon
2020-10-30 9:29 ` [dpdk-dev] [PATCH v2] " Bing Zhao
2 siblings, 0 replies; 5+ messages in thread
From: Ori Kam @ 2020-10-29 14:43 UTC (permalink / raw)
To: Bing Zhao, ferruh.yigit, NBU-Contact-Thomas Monjalon; +Cc: dev
Hi
> -----Original Message-----
> From: dev <dev-bounces@dpdk.org> On Behalf Of Bing Zhao
> Sent: Thursday, October 29, 2020 11:42 AM
> Subject: [dpdk-dev] [PATCH] 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.
>
> Signed-off-by: Bing Zhao <bingz@nvidia.com>
> ---
> 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..932d10b 100644
> --- a/doc/api/doxy-api.conf.in
> +++ b/doc/api/doxy-api.conf.in
> @@ -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 \
> --
> 1.8.3.1
Acked-by: Ori Kam <orika@nvidia.com>
Thanks,
Ori
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [dpdk-dev] [PATCH] doc: add the doc for mlx5 specific header
2020-10-29 9:41 [dpdk-dev] [PATCH] doc: add the doc for mlx5 specific header Bing Zhao
2020-10-29 14:43 ` Ori Kam
@ 2020-10-29 16:05 ` Thomas Monjalon
2020-10-30 5:38 ` Bing Zhao
2020-10-30 9:29 ` [dpdk-dev] [PATCH v2] " Bing Zhao
2 siblings, 1 reply; 5+ messages in thread
From: Thomas Monjalon @ 2020-10-29 16:05 UTC (permalink / raw)
To: ferruh.yigit, Bing Zhao; +Cc: orika, dev
29/10/2020 10:41, Bing Zhao:
> 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@nvidia.com>
> --- a/doc/api/doxy-api.conf.in
> +++ b/doc/api/doxy-api.conf.in
> @@ -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.
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [dpdk-dev] [PATCH] doc: add the doc for mlx5 specific header
2020-10-29 16:05 ` Thomas Monjalon
@ 2020-10-30 5:38 ` Bing Zhao
0 siblings, 0 replies; 5+ messages in thread
From: Bing Zhao @ 2020-10-30 5:38 UTC (permalink / raw)
To: NBU-Contact-Thomas Monjalon, ferruh.yigit; +Cc: Ori Kam, dev
Thanks a lot, I will send v2.
> -----Original Message-----
> From: Thomas Monjalon <thomas@monjalon.net>
> Sent: Friday, October 30, 2020 12:06 AM
> To: ferruh.yigit@intel.com; Bing Zhao <bingz@nvidia.com>
> Cc: Ori Kam <orika@nvidia.com>; dev@dpdk.org
> Subject: Re: [PATCH] doc: add the doc for mlx5 specific header
>
> External email: Use caution opening links or attachments
>
>
> 29/10/2020 10:41, Bing Zhao:
> > 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@nvidia.com>
> > --- a/doc/api/doxy-api.conf.in
> > +++ b/doc/api/doxy-api.conf.in
> > @@ -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.
>
>
^ permalink raw reply [flat|nested] 5+ messages in thread
* [dpdk-dev] [PATCH v2] doc: add the doc for mlx5 specific header
2020-10-29 9:41 [dpdk-dev] [PATCH] doc: add the doc for mlx5 specific header Bing Zhao
2020-10-29 14:43 ` Ori Kam
2020-10-29 16:05 ` Thomas Monjalon
@ 2020-10-30 9:29 ` Bing Zhao
2 siblings, 0 replies; 5+ messages in thread
From: Bing Zhao @ 2020-10-30 9:29 UTC (permalink / raw)
To: orika, ferruh.yigit, thomas; +Cc: dev
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@nvidia.com>
Reviewed-by: Thomas Monjalon <thomas@monjalon.net>
Acked-by: Ori Kam <orika@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
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2020-10-30 9:29 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-10-29 9:41 [dpdk-dev] [PATCH] doc: add the doc for mlx5 specific header Bing Zhao
2020-10-29 14:43 ` Ori Kam
2020-10-29 16:05 ` Thomas Monjalon
2020-10-30 5:38 ` Bing Zhao
2020-10-30 9:29 ` [dpdk-dev] [PATCH v2] " Bing Zhao
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).