@@ -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)
@@ -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
*
*/
@@ -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> --- Resending v3 with correct version to version change description v3: Added linux-generic back to User's Guide v2: Removed all but linux-netmap from User's Guide; Renamed PROJECT_NAME to "ODP Netmap API Reference Manual" v1: Added linux-netmap instructions to User's Guide alongside the descriptions for the other platforms doc/doxygen.cfg | 2 +- doc/users-guide/guide.dox | 6 ++---- platform/linux-netmap/README | 14 +++++++++++++- 3 files changed, 16 insertions(+), 6 deletions(-)