| Message ID | 1452082946-26822-1-git-send-email-mike.holmes@linaro.org |
|---|---|
| State | Accepted |
| Commit | 3b7f7085fd128c0e32756b1d35b898c8aa5a74c0 |
| Headers | show |
On Wed, Jan 6, 2016 at 6:22 AM, Mike Holmes <mike.holmes@linaro.org> wrote: > The other documentation is contained in its own directory, the API guide > for the application should be no different. > This also makes way for a possible south-bound API for NIC drivers > > Signed-off-by: Mike Holmes <mike.holmes@linaro.org> > Reviewed-and-tested-by: Bill Fischofer <bill.fischofer@linaro.org> > --- > configure.ac | 3 +-- > doc/Makefile.am | 7 ------- > doc/application-api-guide/Makefile.am | 5 +++++ > doc/{ => application-api-guide}/api_guide_lines.dox | 0 > doc/{ => application-api-guide}/doxygen.cfg | 0 > doc/{ => application-api-guide}/examples.dox | 0 > doc/{ => application-api-guide}/odp.dox | 0 > doc/{ => application-api-guide}/release.dox | 0 > 8 files changed, 6 insertions(+), 9 deletions(-) > create mode 100644 doc/application-api-guide/Makefile.am > rename doc/{ => application-api-guide}/api_guide_lines.dox (100%) > rename doc/{ => application-api-guide}/doxygen.cfg (100%) > rename doc/{ => application-api-guide}/examples.dox (100%) > rename doc/{ => application-api-guide}/odp.dox (100%) > rename doc/{ => application-api-guide}/release.dox (100%) > > diff --git a/configure.ac b/configure.ac > index 2626fd7..e4e5dac 100644 > --- a/configure.ac > +++ b/configure.ac > @@ -141,8 +141,7 @@ AC_ARG_ENABLE([cunit_support], > ########################################################################## > DX_HTML_FEATURE(ON) > DX_PDF_FEATURE(ON) > -DX_INIT_DOXYGEN($PACKAGE_NAME, doc/doxygen.cfg, doc/output) > - > +DX_INIT_DOXYGEN($PACKAGE_NAME, doc/application-api-guide/doxygen.cfg, > doc/output) > ########################################################################## > # Enable/disable Unit tests > ########################################################################## > diff --git a/doc/Makefile.am b/doc/Makefile.am > index a1e9903..41d804b 100644 > --- a/doc/Makefile.am > +++ b/doc/Makefile.am > @@ -8,10 +8,3 @@ endif > if user_guide > SUBDIRS += implementers-guide users-guide process-guide > endif > - > -EXTRA_DIST = \ > - api_guide_lines.dox \ > - examples.dox \ > - images \ > - odp.dox \ > - release.dox > diff --git a/doc/application-api-guide/Makefile.am > b/doc/application-api-guide/Makefile.am > new file mode 100644 > index 0000000..10f6030 > --- /dev/null > +++ b/doc/application-api-guide/Makefile.am > @@ -0,0 +1,5 @@ > +EXTRA_DIST = \ > + api_guide_lines.dox \ > + examples.dox \ > + odp.dox \ > + release.dox > diff --git a/doc/api_guide_lines.dox > b/doc/application-api-guide/api_guide_lines.dox > similarity index 100% > rename from doc/api_guide_lines.dox > rename to doc/application-api-guide/api_guide_lines.dox > diff --git a/doc/doxygen.cfg b/doc/application-api-guide/doxygen.cfg > similarity index 100% > rename from doc/doxygen.cfg > rename to doc/application-api-guide/doxygen.cfg > diff --git a/doc/examples.dox b/doc/application-api-guide/examples.dox > similarity index 100% > rename from doc/examples.dox > rename to doc/application-api-guide/examples.dox > diff --git a/doc/odp.dox b/doc/application-api-guide/odp.dox > similarity index 100% > rename from doc/odp.dox > rename to doc/application-api-guide/odp.dox > diff --git a/doc/release.dox b/doc/application-api-guide/release.dox > similarity index 100% > rename from doc/release.dox > rename to doc/application-api-guide/release.dox > -- > 2.5.0 > > _______________________________________________ > lng-odp mailing list > lng-odp@lists.linaro.org > https://lists.linaro.org/mailman/listinfo/lng-odp >
ping On 7 January 2016 at 16:48, Bill Fischofer <bill.fischofer@linaro.org> wrote: > > > On Wed, Jan 6, 2016 at 6:22 AM, Mike Holmes <mike.holmes@linaro.org> > wrote: > >> The other documentation is contained in its own directory, the API guide >> for the application should be no different. >> This also makes way for a possible south-bound API for NIC drivers >> >> Signed-off-by: Mike Holmes <mike.holmes@linaro.org> >> > > Reviewed-and-tested-by: Bill Fischofer <bill.fischofer@linaro.org> > > >> --- >> configure.ac | 3 +-- >> doc/Makefile.am | 7 ------- >> doc/application-api-guide/Makefile.am | 5 +++++ >> doc/{ => application-api-guide}/api_guide_lines.dox | 0 >> doc/{ => application-api-guide}/doxygen.cfg | 0 >> doc/{ => application-api-guide}/examples.dox | 0 >> doc/{ => application-api-guide}/odp.dox | 0 >> doc/{ => application-api-guide}/release.dox | 0 >> 8 files changed, 6 insertions(+), 9 deletions(-) >> create mode 100644 doc/application-api-guide/Makefile.am >> rename doc/{ => application-api-guide}/api_guide_lines.dox (100%) >> rename doc/{ => application-api-guide}/doxygen.cfg (100%) >> rename doc/{ => application-api-guide}/examples.dox (100%) >> rename doc/{ => application-api-guide}/odp.dox (100%) >> rename doc/{ => application-api-guide}/release.dox (100%) >> >> diff --git a/configure.ac b/configure.ac >> index 2626fd7..e4e5dac 100644 >> --- a/configure.ac >> +++ b/configure.ac >> @@ -141,8 +141,7 @@ AC_ARG_ENABLE([cunit_support], >> >> ########################################################################## >> DX_HTML_FEATURE(ON) >> DX_PDF_FEATURE(ON) >> -DX_INIT_DOXYGEN($PACKAGE_NAME, doc/doxygen.cfg, doc/output) >> - >> +DX_INIT_DOXYGEN($PACKAGE_NAME, doc/application-api-guide/doxygen.cfg, >> doc/output) >> >> ########################################################################## >> # Enable/disable Unit tests >> >> ########################################################################## >> diff --git a/doc/Makefile.am b/doc/Makefile.am >> index a1e9903..41d804b 100644 >> --- a/doc/Makefile.am >> +++ b/doc/Makefile.am >> @@ -8,10 +8,3 @@ endif >> if user_guide >> SUBDIRS += implementers-guide users-guide process-guide >> endif >> - >> -EXTRA_DIST = \ >> - api_guide_lines.dox \ >> - examples.dox \ >> - images \ >> - odp.dox \ >> - release.dox >> diff --git a/doc/application-api-guide/Makefile.am >> b/doc/application-api-guide/Makefile.am >> new file mode 100644 >> index 0000000..10f6030 >> --- /dev/null >> +++ b/doc/application-api-guide/Makefile.am >> @@ -0,0 +1,5 @@ >> +EXTRA_DIST = \ >> + api_guide_lines.dox \ >> + examples.dox \ >> + odp.dox \ >> + release.dox >> diff --git a/doc/api_guide_lines.dox >> b/doc/application-api-guide/api_guide_lines.dox >> similarity index 100% >> rename from doc/api_guide_lines.dox >> rename to doc/application-api-guide/api_guide_lines.dox >> diff --git a/doc/doxygen.cfg b/doc/application-api-guide/doxygen.cfg >> similarity index 100% >> rename from doc/doxygen.cfg >> rename to doc/application-api-guide/doxygen.cfg >> diff --git a/doc/examples.dox b/doc/application-api-guide/examples.dox >> similarity index 100% >> rename from doc/examples.dox >> rename to doc/application-api-guide/examples.dox >> diff --git a/doc/odp.dox b/doc/application-api-guide/odp.dox >> similarity index 100% >> rename from doc/odp.dox >> rename to doc/application-api-guide/odp.dox >> diff --git a/doc/release.dox b/doc/application-api-guide/release.dox >> similarity index 100% >> rename from doc/release.dox >> rename to doc/application-api-guide/release.dox >> -- >> 2.5.0 >> >> _______________________________________________ >> 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
diff --git a/configure.ac b/configure.ac index 2626fd7..e4e5dac 100644 --- a/configure.ac +++ b/configure.ac @@ -141,8 +141,7 @@ AC_ARG_ENABLE([cunit_support], ########################################################################## DX_HTML_FEATURE(ON) DX_PDF_FEATURE(ON) -DX_INIT_DOXYGEN($PACKAGE_NAME, doc/doxygen.cfg, doc/output) - +DX_INIT_DOXYGEN($PACKAGE_NAME, doc/application-api-guide/doxygen.cfg, doc/output) ########################################################################## # Enable/disable Unit tests ########################################################################## diff --git a/doc/Makefile.am b/doc/Makefile.am index a1e9903..41d804b 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -8,10 +8,3 @@ endif if user_guide SUBDIRS += implementers-guide users-guide process-guide endif - -EXTRA_DIST = \ - api_guide_lines.dox \ - examples.dox \ - images \ - odp.dox \ - release.dox diff --git a/doc/application-api-guide/Makefile.am b/doc/application-api-guide/Makefile.am new file mode 100644 index 0000000..10f6030 --- /dev/null +++ b/doc/application-api-guide/Makefile.am @@ -0,0 +1,5 @@ +EXTRA_DIST = \ + api_guide_lines.dox \ + examples.dox \ + odp.dox \ + release.dox diff --git a/doc/api_guide_lines.dox b/doc/application-api-guide/api_guide_lines.dox similarity index 100% rename from doc/api_guide_lines.dox rename to doc/application-api-guide/api_guide_lines.dox diff --git a/doc/doxygen.cfg b/doc/application-api-guide/doxygen.cfg similarity index 100% rename from doc/doxygen.cfg rename to doc/application-api-guide/doxygen.cfg diff --git a/doc/examples.dox b/doc/application-api-guide/examples.dox similarity index 100% rename from doc/examples.dox rename to doc/application-api-guide/examples.dox diff --git a/doc/odp.dox b/doc/application-api-guide/odp.dox similarity index 100% rename from doc/odp.dox rename to doc/application-api-guide/odp.dox diff --git a/doc/release.dox b/doc/application-api-guide/release.dox similarity index 100% rename from doc/release.dox rename to doc/application-api-guide/release.dox
The other documentation is contained in its own directory, the API guide for the application should be no different. This also makes way for a possible south-bound API for NIC drivers Signed-off-by: Mike Holmes <mike.holmes@linaro.org> --- configure.ac | 3 +-- doc/Makefile.am | 7 ------- doc/application-api-guide/Makefile.am | 5 +++++ doc/{ => application-api-guide}/api_guide_lines.dox | 0 doc/{ => application-api-guide}/doxygen.cfg | 0 doc/{ => application-api-guide}/examples.dox | 0 doc/{ => application-api-guide}/odp.dox | 0 doc/{ => application-api-guide}/release.dox | 0 8 files changed, 6 insertions(+), 9 deletions(-) create mode 100644 doc/application-api-guide/Makefile.am rename doc/{ => application-api-guide}/api_guide_lines.dox (100%) rename doc/{ => application-api-guide}/doxygen.cfg (100%) rename doc/{ => application-api-guide}/examples.dox (100%) rename doc/{ => application-api-guide}/odp.dox (100%) rename doc/{ => application-api-guide}/release.dox (100%)