This looks good, but I think it makes more sense for this to be API-NEXT and considered part of Tiger Moth since we're not doing anything at all with drivers in Monarch and this inclusion could be confusing to readers.
On Tue, Jul 5, 2016 at 7:47 AM, Mike Holmes <[email protected]> wrote: > Add an initial driver API document structure for the existing driver > framework. > > Signed-off-by: Mike Holmes <[email protected]> > Reviewed-and-tested-by: Bill Fischofer <[email protected]> > --- > configure.ac | 4 +++- > doc/Makefile.am | 6 +++++- > doc/driver-api-guide/.gitignore | 1 + > doc/driver-api-guide/Doxyfile | 14 ++++++++++++++ > doc/driver-api-guide/Makefile.am | 5 +++++ > doc/driver-api-guide/odp.dox | 20 ++++++++++++++++++++ > doc/m4/configure.m4 | 3 ++- > 7 files changed, 50 insertions(+), 3 deletions(-) > create mode 100644 doc/driver-api-guide/.gitignore > create mode 100644 doc/driver-api-guide/Doxyfile > create mode 100644 doc/driver-api-guide/Makefile.am > create mode 100644 doc/driver-api-guide/odp.dox > > diff --git a/configure.ac b/configure.ac > index c0eb207..d1e410a 100644 > --- a/configure.ac > +++ b/configure.ac > @@ -188,7 +188,9 @@ DX_INIT_DOXYGEN($PACKAGE_NAME, > ${srcdir}/doc/helper-guide/Doxyfile, > ${builddir}/doc/helper-guide/output, > ${srcdir}/doc/platform-api-guide/Doxyfile, > - ${builddir}/doc/platform-api-guide/output) > + ${builddir}/doc/platform-api-guide/output, > + ${srcdir}/doc/driver-api-guide/Doxyfile, > + ${builddir}/doc/driver-api-guide/output) > > ########################################################################## > # Enable/disable ODP_DEBUG_PRINT > diff --git a/doc/Makefile.am b/doc/Makefile.am > index d49d84b..59d6a6c 100644 > --- a/doc/Makefile.am > +++ b/doc/Makefile.am > @@ -1,4 +1,8 @@ > -SUBDIRS = application-api-guide helper-guide platform-api-guide > +SUBDIRS = \ > + application-api-guide \ > + helper-guide \ > + platform-api-guide \ > + driver-api-guide > > if user_guide > SUBDIRS += implementers-guide users-guide process-guide > diff --git a/doc/driver-api-guide/.gitignore > b/doc/driver-api-guide/.gitignore > new file mode 100644 > index 0000000..53752db > --- /dev/null > +++ b/doc/driver-api-guide/.gitignore > @@ -0,0 +1 @@ > +output > diff --git a/doc/driver-api-guide/Doxyfile b/doc/driver-api-guide/Doxyfile > new file mode 100644 > index 0000000..eff3285 > --- /dev/null > +++ b/doc/driver-api-guide/Doxyfile > @@ -0,0 +1,14 @@ > +@INCLUDE = $(SRCDIR)/doc/Doxyfile_common > + > +PROJECT_NAME = "Driver Reference Manual" > +PROJECT_NUMBER = $(VERSION) > +PROJECT_LOGO = $(SRCDIR)/doc/images/ODP-Logo-HQ.svg > +INPUT = $(SRCDIR)/doc/driver-api-guide \ > + $(SRCDIR)/include/odp/drv \ > + $(SRCDIR)/include/odp_drv.h > +EXCLUDE_PATTERNS = drv* odp_drv.h > +EXAMPLE_PATH = $(SRCDIR)/example $(SRCDIR) > +PREDEFINED = __GNUC__ \ > + "ODP_HANDLE_T(type)=odp_handle_t type" \ > + odpdrv_bool_t=int > +WARNINGS = NO > diff --git a/doc/driver-api-guide/Makefile.am > b/doc/driver-api-guide/Makefile.am > new file mode 100644 > index 0000000..4fc4755 > --- /dev/null > +++ b/doc/driver-api-guide/Makefile.am > @@ -0,0 +1,5 @@ > +EXTRA_DIST = \ > + odp.dox > + > +clean-local: > + rm -rf output > diff --git a/doc/driver-api-guide/odp.dox b/doc/driver-api-guide/odp.dox > new file mode 100644 > index 0000000..687a79e > --- /dev/null > +++ b/doc/driver-api-guide/odp.dox > @@ -0,0 +1,20 @@ > +/* Copyright (c) 2016, Linaro Limited > + * All rights reserved > + * > + * SPDX-License-Identifier: BSD-3-Clause > + */ > + > +/** > + * @mainpage > + * > + * @section sec_1 Introduction > + * > + * OpenDataPlane (ODP) provides a driver interface > + > + * > + * @section contact Contact Details > + * - The main web site is http://www.opendataplane.org/ > + * - The git repo is https://git.linaro.org/lng/odp.git > + * - Bug tracking is > https://bugs.linaro.org/buglist.cgi?product=OpenDataPlane > + * > + */ > diff --git a/doc/m4/configure.m4 b/doc/m4/configure.m4 > index ed9451d..6e02f76 100644 > --- a/doc/m4/configure.m4 > +++ b/doc/m4/configure.m4 > @@ -42,4 +42,5 @@ AC_CONFIG_FILES([doc/application-api-guide/Makefile > doc/Makefile > doc/platform-api-guide/Makefile > doc/process-guide/Makefile > - doc/users-guide/Makefile]) > + doc/users-guide/Makefile > + doc/driver-api-guide/Makefile]) > -- > 2.7.4 > > _______________________________________________ > lng-odp mailing list > [email protected] > https://lists.linaro.org/mailman/listinfo/lng-odp >
