diff mbox

example: odp_l2fwd place readme with symlink

Message ID 1469185546-22262-1-git-send-email-maxim.uvarov@linaro.org
State Superseded
Headers show

Commit Message

Maxim Uvarov July 22, 2016, 11:05 a.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>

---
 example/l2fwd/README      | 8 ++++++++
 example/l2fwd/odp_l2fwd.c | 1 +
 2 files changed, 9 insertions(+)
 create mode 100644 example/l2fwd/README
 create mode 120000 example/l2fwd/odp_l2fwd.c

-- 
2.7.1.250.gff4ea60

Comments

Maxim Uvarov Aug. 11, 2016, 2:09 p.m. UTC | #1
ping

On 07/22/16 14:05, Maxim Uvarov 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>

> ---

>   example/l2fwd/README      | 8 ++++++++

>   example/l2fwd/odp_l2fwd.c | 1 +

>   2 files changed, 9 insertions(+)

>   create mode 100644 example/l2fwd/README

>   create mode 120000 example/l2fwd/odp_l2fwd.c

>

> 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
Mike Holmes Aug. 11, 2016, 2:21 p.m. UTC | #2
We need to also add this
to ~/git/odp/doc/application-api-guide/examples.dox so that it gets seen in
the application users guide if we really want to get the maximum exposure
to it.

On 11 August 2016 at 10:09, Maxim Uvarov <maxim.uvarov@linaro.org> wrote:

> ping

>

>

> On 07/22/16 14:05, Maxim Uvarov 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>

>> ---

>>   example/l2fwd/README      | 8 ++++++++

>>   example/l2fwd/odp_l2fwd.c | 1 +

>>   2 files changed, 9 insertions(+)

>>   create mode 100644 example/l2fwd/README

>>   create mode 120000 example/l2fwd/odp_l2fwd.c

>>

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

>>

>

>



-- 
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. 11, 2016, 2:23 p.m. UTC | #3
ok. Can we do it in separate patch for l3fwd and l2fwd  together? Or I and
Forest have to update our patches.

Maxim.

On 11 August 2016 at 17:21, Mike Holmes <mike.holmes@linaro.org> wrote:

> We need to also add this to ~/git/odp/doc/application-api-guide/examples.dox

> so that it gets seen in the application users guide if we really want to

> get the maximum exposure to it.

>

> On 11 August 2016 at 10:09, Maxim Uvarov <maxim.uvarov@linaro.org> wrote:

>

>> ping

>>

>>

>> On 07/22/16 14:05, Maxim Uvarov 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>

>>> ---

>>>   example/l2fwd/README      | 8 ++++++++

>>>   example/l2fwd/odp_l2fwd.c | 1 +

>>>   2 files changed, 9 insertions(+)

>>>   create mode 100644 example/l2fwd/README

>>>   create mode 120000 example/l2fwd/odp_l2fwd.c

>>>

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

>>>

>>

>>

>

>

> --

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

>

>

>
Mike Holmes Aug. 11, 2016, 4:06 p.m. UTC | #4
Why dont we do it as part of this patch, the patch says it is to make it
easy to find ?
We just need to make an entry in the file at a minimum, I 'd like it to be
more but that moves us forward.
In all example cases we need better descriptions, they have none at all in
the generated doxygen.

Agree L3fwd need to also get pulled in, but that is an unknown amount of
time in the future and a different patch series.


On 11 August 2016 at 10:23, Maxim Uvarov <maxim.uvarov@linaro.org> wrote:

> ok. Can we do it in separate patch for l3fwd and l2fwd  together? Or I and

> Forest have to update our patches.

>

> Maxim.

>

> On 11 August 2016 at 17:21, Mike Holmes <mike.holmes@linaro.org> wrote:

>

>> We need to also add this to ~/git/odp/doc/application-api-guide/examples.dox

>> so that it gets seen in the application users guide if we really want to

>> get the maximum exposure to it.

>>

>> On 11 August 2016 at 10:09, Maxim Uvarov <maxim.uvarov@linaro.org> wrote:

>>

>>> ping

>>>

>>>

>>> On 07/22/16 14:05, Maxim Uvarov 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>

>>>> ---

>>>>   example/l2fwd/README      | 8 ++++++++

>>>>   example/l2fwd/odp_l2fwd.c | 1 +

>>>>   2 files changed, 9 insertions(+)

>>>>   create mode 100644 example/l2fwd/README

>>>>   create mode 120000 example/l2fwd/odp_l2fwd.c

>>>>

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

>>>>

>>>

>>>

>>

>>

>> --

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

>>

>>

>>

>



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