Message ID | 1413810753-2051-1-git-send-email-ciprian.barbu@linaro.org |
---|---|
State | New |
Headers | show |
ping On Mon, Oct 20, 2014 at 4:12 PM, Ciprian Barbu <ciprian.barbu@linaro.org> wrote: > Signed-off-by: Ciprian Barbu <ciprian.barbu@linaro.org> > --- > v2: > - Added linux-generic back to users guide > - Added information about default platform in linux-netmap README > > doc/doxygen.cfg | 2 +- > doc/users-guide/guide.dox | 6 ++---- > platform/linux-netmap/README | 14 +++++++++++++- > 3 files changed, 16 insertions(+), 6 deletions(-) > > diff --git a/doc/doxygen.cfg b/doc/doxygen.cfg > index a77ae1e..fc56317 100644 > --- a/doc/doxygen.cfg > +++ b/doc/doxygen.cfg > @@ -1,4 +1,4 @@ > -PROJECT_NAME = "API Reference Manual" > +PROJECT_NAME = "ODP Netmap API Reference Manual" > PROJECT_LOGO = $(SRCDIR)/doc/images/ODP-Logo-HQ.png > QUIET = YES > OUTPUT_DIRECTORY = $(DOCDIR) > diff --git a/doc/users-guide/guide.dox b/doc/users-guide/guide.dox > index 314d295..11ec395 100644 > --- a/doc/users-guide/guide.dox > +++ b/doc/users-guide/guide.dox > @@ -10,9 +10,7 @@ > * > * @section sec_gene Linux Generic > * @verbinclude linux-generic/README > - * @section sec_dpdk Linux DPDK > - * @verbinclude linux-dpdk/README > - * @section sec_keys Linux Keystone2 > - * @verbinclude linux-keystone2/README > + * @section sec_netm Linux Netmap > + * @verbinclude linux-netmap/README > * > */ > diff --git a/platform/linux-netmap/README b/platform/linux-netmap/README > index 6021445..795a6fc 100644 > --- a/platform/linux-netmap/README > +++ b/platform/linux-netmap/README > @@ -66,8 +66,20 @@ Now compile netmap: > 2.2 Building ODP > ---------------- > > +This default platform for this repository is linux-netmap, if not otherwise > +specified using the --with-platform configure variable. > +The optional --with-sdk-install-path variable is used to point to the netmap > +sources, if it's not specified the build system will try to find netmap header > +files in the standard include directories. > + > ./bootstrap > - ./configure --with-platform=linux-netmap --with-sdk-install-path=<netmap> > + > +To configure ODP for linux-netmap: > + ./configure --with-sdk-install-path=<netmap> > + > +To configure ODP for linux-generic: > + ./configure --with-platform=linux-generic > + > make > > 3. Running the example application > -- > 1.8.3.2 >
diff --git a/doc/doxygen.cfg b/doc/doxygen.cfg index a77ae1e..fc56317 100644 --- a/doc/doxygen.cfg +++ b/doc/doxygen.cfg @@ -1,4 +1,4 @@ -PROJECT_NAME = "API Reference Manual" +PROJECT_NAME = "ODP Netmap API Reference Manual" PROJECT_LOGO = $(SRCDIR)/doc/images/ODP-Logo-HQ.png QUIET = YES OUTPUT_DIRECTORY = $(DOCDIR) diff --git a/doc/users-guide/guide.dox b/doc/users-guide/guide.dox index 314d295..11ec395 100644 --- a/doc/users-guide/guide.dox +++ b/doc/users-guide/guide.dox @@ -10,9 +10,7 @@ * * @section sec_gene Linux Generic * @verbinclude linux-generic/README - * @section sec_dpdk Linux DPDK - * @verbinclude linux-dpdk/README - * @section sec_keys Linux Keystone2 - * @verbinclude linux-keystone2/README + * @section sec_netm Linux Netmap + * @verbinclude linux-netmap/README * */ diff --git a/platform/linux-netmap/README b/platform/linux-netmap/README index 6021445..795a6fc 100644 --- a/platform/linux-netmap/README +++ b/platform/linux-netmap/README @@ -66,8 +66,20 @@ Now compile netmap: 2.2 Building ODP ---------------- +This default platform for this repository is linux-netmap, if not otherwise +specified using the --with-platform configure variable. +The optional --with-sdk-install-path variable is used to point to the netmap +sources, if it's not specified the build system will try to find netmap header +files in the standard include directories. + ./bootstrap - ./configure --with-platform=linux-netmap --with-sdk-install-path=<netmap> + +To configure ODP for linux-netmap: + ./configure --with-sdk-install-path=<netmap> + +To configure ODP for linux-generic: + ./configure --with-platform=linux-generic + make 3. Running the example application
Signed-off-by: Ciprian Barbu <ciprian.barbu@linaro.org> --- v2: - Added linux-generic back to users guide - Added information about default platform in linux-netmap README doc/doxygen.cfg | 2 +- doc/users-guide/guide.dox | 6 ++---- platform/linux-netmap/README | 14 +++++++++++++- 3 files changed, 16 insertions(+), 6 deletions(-)