| Message ID | 1461022165-6734-1-git-send-email-mike.holmes@linaro.org |
|---|---|
| State | Accepted |
| Commit | 91e9e9d9e4707bde2312c7c37b6db66e5b24870f |
| Headers | show |
Any objections, I will work on having the helpers build their own doc if we agree that the helpers are not part of the ODP API. On 18 April 2016 at 19:29, Mike Holmes <mike.holmes@linaro.org> wrote: > The helper apis are not part of the odp specification, don't publish them > in > the application user guide for the odp api. > > Signed-off-by: Mike Holmes <mike.holmes@linaro.org> > --- > doc/application-api-guide/doxygen.cfg | 3 +-- > 1 file changed, 1 insertion(+), 2 deletions(-) > > diff --git a/doc/application-api-guide/doxygen.cfg > b/doc/application-api-guide/doxygen.cfg > index 4d6506d..c3caf89 100644 > --- a/doc/application-api-guide/doxygen.cfg > +++ b/doc/application-api-guide/doxygen.cfg > @@ -14,8 +14,7 @@ INPUT = $(SRCDIR)/doc \ > $(SRCDIR)/doc/users-guide \ > $(SRCDIR)/include \ > $(SRCDIR)/platform/$(WITH_PLATFORM)/include/odp \ > - $(SRCDIR)/platform/$(WITH_PLATFORM)/arch/$(WITH_ARCH) \ > - $(SRCDIR)/helper/include > + $(SRCDIR)/platform/$(WITH_PLATFORM)/arch/$(WITH_ARCH) > FILE_PATTERNS = *.h odp*.c *.dox > RECURSIVE = YES > SOURCE_BROWSER = YES > -- > 2.5.0 > > -- Mike Holmes Technical Manager - Linaro Networking Group Linaro.org <http://www.linaro.org/> *│ *Open source software for ARM SoCs "Work should be fun and collaborative, the rest follows"
that looks reasonable. It has to be in separate package and probably we to install it to different location. But actually we need doxygen generation on helper files. Otherwise new contribution will be with different style of errors. Maxim. On 04/20/16 18:45, Mike Holmes wrote: > Any objections, I will work on having the helpers build their own doc > if we agree that the helpers are not part of the ODP API. > > On 18 April 2016 at 19:29, Mike Holmes <mike.holmes@linaro.org > <mailto:mike.holmes@linaro.org>> wrote: > > The helper apis are not part of the odp specification, don't > publish them in > the application user guide for the odp api. > > Signed-off-by: Mike Holmes <mike.holmes@linaro.org > <mailto:mike.holmes@linaro.org>> > --- > doc/application-api-guide/doxygen.cfg | 3 +-- > 1 file changed, 1 insertion(+), 2 deletions(-) > > diff --git a/doc/application-api-guide/doxygen.cfg > b/doc/application-api-guide/doxygen.cfg > index 4d6506d..c3caf89 100644 > --- a/doc/application-api-guide/doxygen.cfg > +++ b/doc/application-api-guide/doxygen.cfg > @@ -14,8 +14,7 @@ INPUT = $(SRCDIR)/doc \ > $(SRCDIR)/doc/users-guide \ > $(SRCDIR)/include \ > $(SRCDIR)/platform/$(WITH_PLATFORM)/include/odp \ > - $(SRCDIR)/platform/$(WITH_PLATFORM)/arch/$(WITH_ARCH) \ > - $(SRCDIR)/helper/include > + $(SRCDIR)/platform/$(WITH_PLATFORM)/arch/$(WITH_ARCH) > FILE_PATTERNS = *.h odp*.c *.dox > RECURSIVE = YES > SOURCE_BROWSER = YES > -- > 2.5.0 > > > > > -- > Mike Holmes > Technical Manager - Linaro Networking Group > Linaro.org <http://www.linaro.org/>***│ *Open source software for ARM SoCs > "Work should be fun and collaborative, the rest follows" > > > > _______________________________________________ > lng-odp mailing list > lng-odp@lists.linaro.org > https://lists.linaro.org/mailman/listinfo/lng-odp
I think we need to get this in now becasue Monarch closes at the end of the week and the helpers should not be in the public API. I believe we can add the new docs in the following weeks, just need a review. On 25 April 2016 at 09:21, Maxim Uvarov <maxim.uvarov@linaro.org> wrote: > that looks reasonable. It has to be in separate package and probably we to > install it to different location. > But actually we need doxygen generation on helper files. Otherwise new > contribution will be with different > style of errors. > > Maxim. > > On 04/20/16 18:45, Mike Holmes wrote: > >> Any objections, I will work on having the helpers build their own doc if >> we agree that the helpers are not part of the ODP API. >> >> On 18 April 2016 at 19:29, Mike Holmes <mike.holmes@linaro.org <mailto: >> mike.holmes@linaro.org>> wrote: >> >> The helper apis are not part of the odp specification, don't >> publish them in >> the application user guide for the odp api. >> >> Signed-off-by: Mike Holmes <mike.holmes@linaro.org >> <mailto:mike.holmes@linaro.org>> >> --- >> doc/application-api-guide/doxygen.cfg | 3 +-- >> 1 file changed, 1 insertion(+), 2 deletions(-) >> >> diff --git a/doc/application-api-guide/doxygen.cfg >> b/doc/application-api-guide/doxygen.cfg >> index 4d6506d..c3caf89 100644 >> --- a/doc/application-api-guide/doxygen.cfg >> +++ b/doc/application-api-guide/doxygen.cfg >> @@ -14,8 +14,7 @@ INPUT = $(SRCDIR)/doc \ >> $(SRCDIR)/doc/users-guide \ >> $(SRCDIR)/include \ >> $(SRCDIR)/platform/$(WITH_PLATFORM)/include/odp \ >> - $(SRCDIR)/platform/$(WITH_PLATFORM)/arch/$(WITH_ARCH) \ >> - $(SRCDIR)/helper/include >> + $(SRCDIR)/platform/$(WITH_PLATFORM)/arch/$(WITH_ARCH) >> FILE_PATTERNS = *.h odp*.c *.dox >> RECURSIVE = YES >> SOURCE_BROWSER = YES >> -- >> 2.5.0 >> >> >> >> >> -- >> Mike Holmes >> Technical Manager - Linaro Networking Group >> Linaro.org <http://www.linaro.org/>***│ *Open source software for ARM >> SoCs >> "Work should be fun and collaborative, the rest follows" >> >> >> >> _______________________________________________ >> lng-odp mailing list >> lng-odp@lists.linaro.org >> https://lists.linaro.org/mailman/listinfo/lng-odp >> > > _______________________________________________ > lng-odp mailing list > lng-odp@lists.linaro.org > https://lists.linaro.org/mailman/listinfo/lng-odp > -- Mike Holmes Technical Manager - Linaro Networking Group Linaro.org <http://www.linaro.org/> *│ *Open source software for ARM SoCs "Work should be fun and collaborative, the rest follows"
As we discussed today, this seems reasonable and should be part of Monarch. On Mon, Apr 18, 2016 at 6:29 PM, Mike Holmes <mike.holmes@linaro.org> wrote: > The helper apis are not part of the odp specification, don't publish them > in > the application user guide for the odp api. > > Signed-off-by: Mike Holmes <mike.holmes@linaro.org> > Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org> > --- > doc/application-api-guide/doxygen.cfg | 3 +-- > 1 file changed, 1 insertion(+), 2 deletions(-) > > diff --git a/doc/application-api-guide/doxygen.cfg > b/doc/application-api-guide/doxygen.cfg > index 4d6506d..c3caf89 100644 > --- a/doc/application-api-guide/doxygen.cfg > +++ b/doc/application-api-guide/doxygen.cfg > @@ -14,8 +14,7 @@ INPUT = $(SRCDIR)/doc \ > $(SRCDIR)/doc/users-guide \ > $(SRCDIR)/include \ > $(SRCDIR)/platform/$(WITH_PLATFORM)/include/odp \ > - $(SRCDIR)/platform/$(WITH_PLATFORM)/arch/$(WITH_ARCH) \ > - $(SRCDIR)/helper/include > + $(SRCDIR)/platform/$(WITH_PLATFORM)/arch/$(WITH_ARCH) > FILE_PATTERNS = *.h odp*.c *.dox > RECURSIVE = YES > SOURCE_BROWSER = YES > -- > 2.5.0 > > _______________________________________________ > lng-odp mailing list > lng-odp@lists.linaro.org > https://lists.linaro.org/mailman/listinfo/lng-odp >
Merged, Maxim. On 04/26/16 01:34, Bill Fischofer wrote: > As we discussed today, this seems reasonable and should be part of > Monarch. > > On Mon, Apr 18, 2016 at 6:29 PM, Mike Holmes <mike.holmes@linaro.org > <mailto:mike.holmes@linaro.org>> wrote: > > The helper apis are not part of the odp specification, don't > publish them in > the application user guide for the odp api. > > Signed-off-by: Mike Holmes <mike.holmes@linaro.org > <mailto:mike.holmes@linaro.org>> > > > Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org > <mailto:bill.fischofer@linaro.org>> > > --- > doc/application-api-guide/doxygen.cfg | 3 +-- > 1 file changed, 1 insertion(+), 2 deletions(-) > > diff --git a/doc/application-api-guide/doxygen.cfg > b/doc/application-api-guide/doxygen.cfg > index 4d6506d..c3caf89 100644 > --- a/doc/application-api-guide/doxygen.cfg > +++ b/doc/application-api-guide/doxygen.cfg > @@ -14,8 +14,7 @@ INPUT = $(SRCDIR)/doc \ > $(SRCDIR)/doc/users-guide \ > $(SRCDIR)/include \ > $(SRCDIR)/platform/$(WITH_PLATFORM)/include/odp \ > - $(SRCDIR)/platform/$(WITH_PLATFORM)/arch/$(WITH_ARCH) \ > - $(SRCDIR)/helper/include > + $(SRCDIR)/platform/$(WITH_PLATFORM)/arch/$(WITH_ARCH) > FILE_PATTERNS = *.h odp*.c *.dox > RECURSIVE = YES > SOURCE_BROWSER = YES > -- > 2.5.0 > > _______________________________________________ > lng-odp mailing list > lng-odp@lists.linaro.org <mailto:lng-odp@lists.linaro.org> > https://lists.linaro.org/mailman/listinfo/lng-odp > > > > > _______________________________________________ > lng-odp mailing list > lng-odp@lists.linaro.org > https://lists.linaro.org/mailman/listinfo/lng-odp
diff --git a/doc/application-api-guide/doxygen.cfg b/doc/application-api-guide/doxygen.cfg index 4d6506d..c3caf89 100644 --- a/doc/application-api-guide/doxygen.cfg +++ b/doc/application-api-guide/doxygen.cfg @@ -14,8 +14,7 @@ INPUT = $(SRCDIR)/doc \ $(SRCDIR)/doc/users-guide \ $(SRCDIR)/include \ $(SRCDIR)/platform/$(WITH_PLATFORM)/include/odp \ - $(SRCDIR)/platform/$(WITH_PLATFORM)/arch/$(WITH_ARCH) \ - $(SRCDIR)/helper/include + $(SRCDIR)/platform/$(WITH_PLATFORM)/arch/$(WITH_ARCH) FILE_PATTERNS = *.h odp*.c *.dox RECURSIVE = YES SOURCE_BROWSER = YES
The helper apis are not part of the odp specification, don't publish them in the application user guide for the odp api. Signed-off-by: Mike Holmes <mike.holmes@linaro.org> --- doc/application-api-guide/doxygen.cfg | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-)