diff options
| author | Maxim Uvarov <maxim.uvarov@linaro.org> | 2016-08-11 19:44:30 +0300 |
|---|---|---|
| committer | Maxim Uvarov <maxim.uvarov@linaro.org> | 2016-08-12 20:00:34 +0300 |
| commit | c2bd39436032f544f1a211425d39d7d68c47d193 (patch) | |
| tree | 0e265f0e1a4e45079c9d91551f643fcd41fc27b9 | |
| parent | d5295a9c745e82fbf002d71d3fa8a32ebfb48047 (diff) | |
example: odp_l2fwd place readme with symlink
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.uvarov@linaro.org>
Reviewed-by: Mike Holmes <mike.holmes@linaro.org>
| -rw-r--r-- | doc/application-api-guide/examples.dox | 15 | ||||
| -rw-r--r-- | example/l2fwd/README | 8 | ||||
| l--------- | example/l2fwd/odp_l2fwd.c | 1 |
3 files changed, 19 insertions, 5 deletions
diff --git a/doc/application-api-guide/examples.dox b/doc/application-api-guide/examples.dox index 2dccd7f82..60d4058f9 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 000000000..891620bd7 --- /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 000000000..eea3a34c4 --- /dev/null +++ b/example/l2fwd/odp_l2fwd.c @@ -0,0 +1 @@ +../../test/common_plat/performance/odp_l2fwd.c
\ No newline at end of file |