diff mbox

[lng-odp] Added initial ODP files

Message ID 20131114115623.bebfcd6b64f65da9e63a8bc1@linaro.org
State Accepted, archived
Headers show

Commit Message

kim-phillips Nov. 14, 2013, 11:56 a.m. UTC 
On Wed, 13 Nov 2013 09:18:44 -0800 (PST)
Mike Holmes <mike.holmes@linaro.org> wrote:

> On Wednesday, November 13, 2013 7:00:56 AM UTC-5, Kim Phillips wrote:
> >
> > On Tue, 12 Nov 2013 20:32:19 +0400 
> > Maxim Uvarov <maxim....@linaro.org <javascript:>> wrote: 
> >
> > >  create mode 100644 odp/test/odp_test_api.c 
> >
> > so everything goes under odp/?  is there a reason this doesn't go under 
> > the root directory?  The header files have arch-independence built-in, 
> > and so should belong under a generic include directory, such as 
> > ${ODP_ROOT}/include. 
> >
> 
> There is a document that is aimed at migrating the current structure to 
> what we want it to be. 

where?  Even so, why can't we start with this patch?  After all,
patches supercede/override documents, IMO :)

> > > +SOURCE_TOOLTIPS        = YES 
> >
> > this gives me: 
> >
> > Warning: ignoring unsupported tag `SOURCE_TOOLTIPS        =' at line 928, 
> > file Doxyfile 
> >
> > So to avoid things like that, can we reduce this humungous file to only 
> > assign the necessary settings, and leave all the rest to their defaults? 
> >
> In long association with doxygen, it warns about many things, it quietly 
> does a good job of working anyway.

if it's issuing warnings it's not quiet.  Our objective should be *zero*
warnings, and this type of warning can easily be suppressed, so we
should aim to silence it.

>  I believe we should maintain our 
> definition in full and file to keep pace with the latest version of doxygen 
> and put the full definition in git.

that's just it: I'm assuming I'm using a different version of doxygen
than the one used to generate the doxygen configuration file -
something users shouldn't have to care about.

> I do not think we want to start fussing over tool flags in this file, I 
> think the config should be taken as updated by doxygen its self when you 
> run an old config on a new version of the tool. 

I'm not fussing over tool flags themselves, rather how to gen a config
file.

Done some experimenting: should be a matter of:

that would be in need of constant updating, and still issuing warnings
depending on users particular doxygen versions.

Kim
diff mbox

Patch

diff --git a/odp/arch/linux-generic/Makefile b/odp/arch/linux-generic/Makefile
index e86aebc..7c82c43 100644
--- a/odp/arch/linux-generic/Makefile
+++ b/odp/arch/linux-generic/Makefile
@@ -103,7 +103,11 @@  clean:
        rm -rf $(DOC_DIR)
 
 
-$(DOC_FILE): ./Doxyfile ./odp.h
+$(DOC_FILE): ./odp.h
+       doxygen -g
+       echo PROJECT_NAME = "OpenDataPlane API" >> Doxyfile
+       echo QUIET = YES >> Doxyfile
+       # blah, blah...rest of odp specific configs go here
        doxygen

there, that's *much* simpler than adding a 2000 line static Doxyfile