doc: add the doc for mlx5 specific header
diff mbox series

Message ID 1603964500-165177-1-git-send-email-bingz@nvidia.com
State Superseded
Delegated to: Ferruh Yigit
Headers show
Series
  • doc: add the doc for mlx5 specific header
Related show

Checks

Context Check Description
ci/travis-robot success Travis build: passed
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

Bing Zhao Oct. 29, 2020, 9:41 a.m. UTC
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(+)

Comments

Ori Kam Oct. 29, 2020, 2:43 p.m. UTC | #1
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
Thomas Monjalon Oct. 29, 2020, 4:05 p.m. UTC | #2
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.
Bing Zhao Oct. 30, 2020, 5:38 a.m. UTC | #3
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.
> 
>

Patch
diff mbox series

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 \