Move ODP examples from under tests

The expectations of example code vs testing code is significantly
different. This difference is more easily managed if tests and
examples have their own root directory especially as the number
of validation tests is increased for the ODP 1.0 release.
For example test cases may be significantly more complex than
a good example might be expected to be. In addition tests are
not expected to have Doxygen documentation and tests will
not be expected to be coherent, they will test isolated APIs
and to do so may perform illegal combinations of calls making them
poor examples.

Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
Signed-off-by: Anders Roxell <anders.roxell@linaro.org>
Reviewed-and-Tested-by: Ciprian Barbu <ciprian.barbu@linaro.org>

21 files changed, 48 insertions, 31 deletions

diff --git a/.gitignore b/.gitignore
index 57429075e..ca9e71677 100644
--- a/.gitignore
+++ b/.gitignore
@@ -25,21 +25,21 @@ include/config.h
 include/stamp-h1
 libtool
 pkgconfig/libodp.pc
-platform/*/.deps/
-test/*/.deps/
+.deps/
 cscope.out
 tags
 lib/
 obj/
 build/
-test/example/odp_example
-test/packet/odp_packet
-test/packet_netmap/odp_packet_netmap
-test/api_test/odp_atomic
-test/api_test/odp_shm
-test/api_test/odp_ring
-test/api_test/odp_timer
-test/packet/odp_pktio
-test/timer/odp_timer_test
-test/generator/odp_generator
-test/l2fwd/odp_l2fwd
+odp_example
+odp_packet
+odp_packet_netmap
+odp_atomic
+odp_shm
+odp_ring
+odp_timer
+odp_pktio
+odp_timer_test
+odp_generator
+odp_l2fwd
+doxygen-doc
diff --git a/Makefile.am b/Makefile.am
index 36d5c2389..21f1b11cd 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,7 +1,7 @@
 ACLOCAL_AMFLAGS=-I m4
 AUTOMAKE_OPTIONS = foreign
 
-SUBDIRS = platform test
+SUBDIRS = platform example test
 
 include $(top_srcdir)/aminclude.am
 
diff --git a/configure.ac b/configure.ac
index 732016234..97089e9fd 100644
--- a/configure.ac
+++ b/configure.ac
@@ -109,14 +109,15 @@ AC_CONFIG_FILES([Makefile
 		 platform/linux-generic/Makefile
 		 platform/linux-keystone2/Makefile
 		 platform/linux-dpdk/Makefile
+		 example/Makefile
+		 example/generator/Makefile
+		 example/l2fwd/Makefile
+		 example/odp_example/Makefile
+		 example/packet/Makefile
+		 example/packet_netmap/Makefile
+		 example/timer/Makefile
 		 test/Makefile
 		 test/api_test/Makefile
-		 test/example/Makefile
-		 test/generator/Makefile
-		 test/l2fwd/Makefile
-		 test/packet/Makefile
-		 test/packet_netmap/Makefile
-		 test/timer/Makefile
 		 pkgconfig/libodp.pc])
 
 AC_SEARCH_LIBS([timer_create],[rt posix4])
diff --git a/doxygen.cfg b/doxygen.cfg
index 6c787129d..86fe92a74 100644
--- a/doxygen.cfg
+++ b/doxygen.cfg
@@ -9,7 +9,7 @@ TYPEDEF_HIDES_STRUCT = YES
 EXTRACT_STATIC = YES
 SORT_MEMBER_DOCS = NO
 WARN_NO_PARAMDOC = YES
-INPUT = $(SRCDIR)/doc $(SRCDIR)/include $(SRCDIR)/test
+INPUT = $(SRCDIR)/doc $(SRCDIR)/include $(SRCDIR)/example
 FILE_PATTERNS = odp*.h odp*.c *.dox
 RECURSIVE = YES
 SOURCE_BROWSER = YES
@@ -23,7 +23,7 @@ CLASS_DIAGRAMS = NO
 HAVE_DOT = YES
 CALL_GRAPH = YES
 DOT_MULTI_TARGETS = NO
-EXAMPLE_PATH = $(SRCDIR)/test
+EXAMPLE_PATH = $(SRCDIR)/example
 EXAMPLE_PATTERNS = *.c
 EXAMPLE_RECURSIVE = YES
 IMAGE_PATH = $(SRCDIR)/doc/images
diff --git a/example/Makefile.am b/example/Makefile.am
new file mode 100644
index 000000000..01a330578
--- /dev/null
+++ b/example/Makefile.am
@@ -0,0 +1 @@
+SUBDIRS = generator l2fwd odp_example packet packet_netmap timer
diff --git a/example/Makefile.inc b/example/Makefile.inc
new file mode 100644
index 000000000..b549001fc
--- /dev/null
+++ b/example/Makefile.inc
@@ -0,0 +1,10 @@
+include $(top_srcdir)/Makefile.inc
+LIB   = $(top_builddir)/lib
+LDADD = $(LIB)/libodp.la
+AM_CFLAGS += \
+	-I$(srcdir) \
+	-I$(top_srcdir)/platform/@with_platform@/include/api \
+	-I$(top_srcdir)/platform/linux-generic/include/api \
+	-I$(top_srcdir)/include
+
+AM_LDFLAGS += -L$(LIB)
diff --git a/example/README b/example/README
new file mode 100644
index 000000000..3f8596981
--- /dev/null
+++ b/example/README
@@ -0,0 +1,3 @@
+Files in this directory are intended to be part of the ODP documentation.
+They should not introduce any Doxygen warnings or errors and will be
+part of the generated documentation.
diff --git a/test/generator/Makefile.am b/example/generator/Makefile.am
index bd6f2005d..d3bd5bfb7 100644
--- a/test/generator/Makefile.am
+++ b/example/generator/Makefile.am
@@ -1,4 +1,4 @@
-include $(top_srcdir)/test/Makefile.inc
+include $(top_srcdir)/example/Makefile.inc
 
 bin_PROGRAMS = odp_generator
 
diff --git a/test/generator/odp_generator.c b/example/generator/odp_generator.c
index e4a72fad8..e4a72fad8 100644
--- a/test/generator/odp_generator.c
+++ b/example/generator/odp_generator.c
diff --git a/test/l2fwd/Makefile.am b/example/l2fwd/Makefile.am
index 2637a2cd0..9b5a7ef04 100644
--- a/test/l2fwd/Makefile.am
+++ b/example/l2fwd/Makefile.am
@@ -1,4 +1,4 @@
-include $(top_srcdir)/test/Makefile.inc
+include $(top_srcdir)/example/Makefile.inc
 
 bin_PROGRAMS = odp_l2fwd
 
diff --git a/test/l2fwd/odp_l2fwd.c b/example/l2fwd/odp_l2fwd.c
index 035f710b7..e331ff262 100644
--- a/test/l2fwd/odp_l2fwd.c
+++ b/example/l2fwd/odp_l2fwd.c
@@ -7,7 +7,7 @@
 /**
  * @file
  *
- * @example l2fwd.c  ODP basic forwarding application
+ * @example odp_l2fwd.c  ODP basic forwarding application
  */
 
 #include <stdlib.h>
diff --git a/test/example/Makefile.am b/example/odp_example/Makefile.am
index aeee0e981..c1b4ed327 100644
--- a/test/example/Makefile.am
+++ b/example/odp_example/Makefile.am
@@ -1,4 +1,4 @@
-include $(top_srcdir)/test/Makefile.inc
+include $(top_srcdir)/example/Makefile.inc
 
 bin_PROGRAMS = odp_example
 
diff --git a/test/example/odp_example.c b/example/odp_example/odp_example.c
index be9609356..be9609356 100644
--- a/test/example/odp_example.c
+++ b/example/odp_example/odp_example.c
diff --git a/test/packet/Makefile.am b/example/packet/Makefile.am
index 0a800fce0..2d778ddd6 100644
--- a/test/packet/Makefile.am
+++ b/example/packet/Makefile.am
@@ -1,4 +1,4 @@
-include $(top_srcdir)/test/Makefile.inc
+include $(top_srcdir)/example/Makefile.inc
 
 bin_PROGRAMS = odp_pktio
 
diff --git a/test/packet/odp_pktio.c b/example/packet/odp_pktio.c
index 91aa6d141..edf8cfd6f 100644
--- a/test/packet/odp_pktio.c
+++ b/example/packet/odp_pktio.c
@@ -7,7 +7,7 @@
 /**
  * @file
  *
- * @example odp_example_pktio.c  ODP basic packet IO loopback test application
+ * @example odp_pktio.c  ODP basic packet IO loopback test application
  */
 
 #include <stdlib.h>
diff --git a/test/packet_netmap/Makefile.am b/example/packet_netmap/Makefile.am
index 50e7f85ac..6db0f98d5 100644
--- a/test/packet_netmap/Makefile.am
+++ b/example/packet_netmap/Makefile.am
@@ -1,4 +1,4 @@
-include $(top_srcdir)/test/Makefile.inc
+include $(top_srcdir)/example/Makefile.inc
 
 if ODP_NETMAP_ENABLED
 bin_PROGRAMS = odp_pktio_netmap
diff --git a/test/packet_netmap/odp_pktio_netmap.c b/example/packet_netmap/odp_pktio_netmap.c
index 7d33b19b5..7d33b19b5 100644
--- a/test/packet_netmap/odp_pktio_netmap.c
+++ b/example/packet_netmap/odp_pktio_netmap.c
diff --git a/test/timer/Makefile.am b/example/timer/Makefile.am
index 096ff49de..09253a6f0 100644
--- a/test/timer/Makefile.am
+++ b/example/timer/Makefile.am
@@ -1,4 +1,4 @@
-include $(top_srcdir)/test/Makefile.inc
+include $(top_srcdir)/example/Makefile.inc
 
 bin_PROGRAMS = odp_timer_test
 
diff --git a/test/timer/odp_timer_test.c b/example/timer/odp_timer_test.c
index dbe0e5bed..dbe0e5bed 100644
--- a/test/timer/odp_timer_test.c
+++ b/example/timer/odp_timer_test.c
diff --git a/test/Makefile.am b/test/Makefile.am
index bae381e17..9bd7db171 100644
--- a/test/Makefile.am
+++ b/test/Makefile.am
@@ -1 +1 @@
-SUBDIRS = api_test example generator l2fwd packet packet_netmap timer
+SUBDIRS = api_test
diff --git a/test/README b/test/README
new file mode 100644
index 000000000..045f88b2b
--- /dev/null
+++ b/test/README
@@ -0,0 +1,2 @@
+Files in this directory are intended to be terse checks that help ensure
+that the ODP API Implementations all perform identically and to specification.