> -----Original Message-----
> From: lng-odp [mailto:lng-odp-boun...@lists.linaro.org] On Behalf Of EXT
> Anders Roxell
> Sent: Tuesday, February 09, 2016 12:42 PM
> To: hongbo.zh...@linaro.org
> Cc: lng-odp@lists.linaro.org
> Subject: Re: [lng-odp] [PATCH v3 API-NEXT 1/4] linux-generic: separate x86
> ODP_CACHE_LINE_SIZE to its arch file
> 
> On 2016-02-05 16:56, hongbo.zh...@linaro.org wrote:
> > From: Hongbo Zhang <hongbo.zh...@linaro.org>
> >
> > Currently all ODP_CACHE_LINE_SIZE macros for different architectures are
> > held in one header file, they should be moved to their own arch file.
> > This patch moves ODP_CACHE_LINE_SIZE for x86.
> >
> > Signed-off-by: Hongbo Zhang <hongbo.zh...@linaro.org>
> > ---
> >  doc/application-api-guide/doxygen.cfg          |  1 +
> >  include/odp/api/align.h                        |  5 -----
> >  platform/linux-generic/arch/x86/odp/cpu_arch.h | 14 ++++++++++++++
> >  platform/linux-generic/include/odp/align.h     |  9 ++-------
> >  4 files changed, 17 insertions(+), 12 deletions(-)
> >
> > diff --git a/doc/application-api-guide/doxygen.cfg b/doc/application-
> api-guide/doxygen.cfg
> > index 7951e9e..c585108 100644
> > --- a/doc/application-api-guide/doxygen.cfg
> > +++ b/doc/application-api-guide/doxygen.cfg
> > @@ -14,6 +14,7 @@ INPUT = $(SRCDIR)/doc \
> >     $(SRCDIR)/doc/users-guide \
> >     $(SRCDIR)/include \
> >     $(SRCDIR)/platform/$(WITH_PLATFORM)/include/odp \
> > +   $(SRCDIR)/platform/$(WITH_PLATFORM)/arch/ \
> >     $(SRCDIR)/helper/include
> >  FILE_PATTERNS = *.h odp*.c *.dox
> >  RECURSIVE = YES
> > diff --git a/include/odp/api/align.h b/include/odp/api/align.h
> > index 677ff12..f4b4be6 100644
> > --- a/include/odp/api/align.h
> > +++ b/include/odp/api/align.h
> > @@ -47,11 +47,6 @@ extern "C" {
> >   */
> >
> >  /**
> > - * @def ODP_CACHE_LINE_SIZE
> > - * Cache line size
> > - */
> > -
> > -/**
> 
> I'm not convinced that we should move the documentation away from the
> "generic" header file.
> 
> Cheers,
> Anders

Yes, the doxygen documentation (API spec) of this API definition must stay in 
the main API header file. Arch specific files are for implementation and must 
not doxygen document API definitions.

-Petri


_______________________________________________
lng-odp mailing list
lng-odp@lists.linaro.org
https://lists.linaro.org/mailman/listinfo/lng-odp

Reply via email to