[dpdk-dev] [PATCH v8 20/23] event/dlb2: add PMD's token pop public interface

[McDaniel, Timothy]

> -----Original Message-----
> From: David Marchand <david.marchand at redhat.com>
> Sent: Saturday, October 31, 2020 4:39 PM
> To: McDaniel, Timothy <timothy.mcdaniel at intel.com>
> Cc: Ray Kinsella <mdr at ashroe.eu>; Neil Horman <nhorman at tuxdriver.com>;
> dev <dev at dpdk.org>; Carrillo, Erik G <erik.g.carrillo at intel.com>; Eads, Gage
> <gage.eads at intel.com>; Van Haaren, Harry <harry.van.haaren at intel.com>;
> Jerin Jacob Kollanukkaran <jerinj at marvell.com>; Thomas Monjalon
> <thomas at monjalon.net>
> Subject: Re: [dpdk-dev] [PATCH v8 20/23] event/dlb2: add PMD's token pop
> public interface
> 
> On Sat, Oct 31, 2020 at 8:19 PM McDaniel, Timothy
> <timothy.mcdaniel at intel.com> wrote:
> > I have made the requested changes to doc/api/doxy-api-index.md in DLB and
> DLB2 repos, but I still see this error:
> > /home/travis/build/ovsrobot/dpdk/doc/api/doxy-api-index.md:54: error:
> unable to resolve reference to `rte_pmd_dlb.h' for \ref command (warning
> treated as error, aborting
> >
> > I was hoping that the formatting issues were the culprit, but apparently not.
> Any thoughts?
> 
> You must instruct where to find this header via doxy-api.conf.in
> 
> Applied following diff, it works:
> diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md
> index 2ff3f74413..1400fde9c0 100644
> --- a/doc/api/doxy-api-index.md
> +++ b/doc/api/doxy-api-index.md
> @@ -52,7 +52,7 @@ The public API headers are grouped by topics:
>    [dpaa2_cmdif]        (@ref rte_pmd_dpaa2_cmdif.h),
>    [dpaa2_qdma]         (@ref rte_pmd_dpaa2_qdma.h),
>    [crypto_scheduler]   (@ref rte_cryptodev_scheduler.h),
> -  [dlb]                (@ref rte_pmd_dlb.h),
> +  [dlb]                (@ref rte_pmd_dlb.h)
> 
>  - **memory**:
>    [memseg]             (@ref rte_memory.h),
> diff --git a/doc/api/doxy-api.conf.in b/doc/api/doxy-api.conf.in
> index e37f8c2e80..176e7d7857 100644
> --- a/doc/api/doxy-api.conf.in
> +++ b/doc/api/doxy-api.conf.in
> @@ -7,6 +7,7 @@ USE_MDFILE_AS_MAINPAGE  = @TOPDIR@/doc/api/doxy-
> api-index.md
>  INPUT                   = @TOPDIR@/doc/api/doxy-api-index.md \
>                            @TOPDIR@/drivers/bus/vdev \
>                            @TOPDIR@/drivers/crypto/scheduler \
> +                          @TOPDIR@/drivers/event/dlb \
>                            @TOPDIR@/drivers/mempool/dpaa2 \
>                            @TOPDIR@/drivers/net/bnxt \
>                            @TOPDIR@/drivers/net/bonding \
> 
> 
> I spotted more issues, I'll reply on the patches.
> 
> 
> 
> --
> David Marchand

Thank you, David. Much appreciated.