doc: add the doc for mlx5 specific header
Checks
Commit Message
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
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
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.
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.
>
>
@@ -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**:
@@ -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 \