diff mbox

[PATCHv2] example: odp_l2fwd place readme with symlink

Message ID 1470933870-25845-1-git-send-email-maxim.uvarov@linaro.org
State Accepted
Commit c2bd39436032f544f1a211425d39d7d68c47d193
Headers show

Commit Message

Maxim Uvarov Aug. 11, 2016, 4:44 p.m. UTC
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>

---
 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

-- 
2.7.1.250.gff4ea60

Comments

Mike Holmes Aug. 12, 2016, 1:41 p.m. UTC | #1
On 11 August 2016 at 12:44, Maxim Uvarov <maxim.uvarov@linaro.org> wrote:

> 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>

>


Reviewd-by: Mike Holmes <mike.holmes@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

>

>



-- 
Mike Holmes
Technical Manager - Linaro Networking Group
Linaro.org <http://www.linaro.org/> *│ *Open source software for ARM SoCs
"Work should be fun and collaborative, the rest follows"
Maxim Uvarov Aug. 12, 2016, 5:03 p.m. UTC | #2
Merged,
Maxim.

On 08/12/16 16:41, Mike Holmes wrote:
>

>

> On 11 August 2016 at 12:44, Maxim Uvarov <maxim.uvarov@linaro.org 

> <mailto:maxim.uvarov@linaro.org>> wrote:

>

>     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

>     <mailto:maxim.uvarov@linaro.org>>

>

>

> Reviewd-by: Mike Holmes <mike.holmes@linaro.org 

> <mailto:mike.holmes@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

>

>

>

>

> -- 

> Mike Holmes

> Technical Manager - Linaro Networking Group

> Linaro.org <http://www.linaro.org/>***│ *Open source software for ARM SoCs

> "Work should be fun and collaborative, the rest follows"

>
diff mbox

Patch

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