odp_l2fwd is standalone application which can be used as example or as performance test. Hiding it inside performance tests might be not new users friendly way. Create symlink with small readme file for better finding it.
Signed-off-by: Maxim Uvarov <maxim.uva...@linaro.org> --- v2: add to examples.dox (alphabetical) doc/application-api-guide/examples.dox | 15 ++++++++++----- example/l2fwd/README | 8 ++++++++ example/l2fwd/odp_l2fwd.c | 1 + 3 files changed, 19 insertions(+), 5 deletions(-) create mode 100644 example/l2fwd/README create mode 120000 example/l2fwd/odp_l2fwd.c diff --git a/doc/application-api-guide/examples.dox b/doc/application-api-guide/examples.dox index 2dccd7f..60d4058 100644 --- a/doc/application-api-guide/examples.dox +++ b/doc/application-api-guide/examples.dox @@ -5,11 +5,21 @@ */ /** + * @example odp_classifier.c + * ODP classifier example application + */ + +/** * @example odp_generator.c * ODP loopback demo application */ /** + * @example odp_l2fwd.c + * ODP l2fwd example application + */ + +/** *@example odp_pktio.c * ODP basic packet IO loopback test application */ @@ -18,8 +28,3 @@ * @example odp_timer_test.c * ODP timer example application */ - -/** - * @example odp_classifier.c - * ODP classifier example application - */ diff --git a/example/l2fwd/README b/example/l2fwd/README new file mode 100644 index 0000000..891620b --- /dev/null +++ b/example/l2fwd/README @@ -0,0 +1,8 @@ + ODP L2FWD application + +Source code and Makefiles placed under test/common_plat/performance/ +directory. + +This L2 forwarding application can be used as example reference as well +as performance test for different odp modes (direct, queue or scheduler +with parallel, atomic or ordered queues). diff --git a/example/l2fwd/odp_l2fwd.c b/example/l2fwd/odp_l2fwd.c new file mode 120000 index 0000000..eea3a34 --- /dev/null +++ b/example/l2fwd/odp_l2fwd.c @@ -0,0 +1 @@ +../../test/common_plat/performance/odp_l2fwd.c \ No newline at end of file -- 2.7.1.250.gff4ea60
