[dpdk-dev] [PATCH] doc/testpmd: update compile steps for bpf examples

[dpdk-dev] [PATCH] doc/testpmd: update compile steps for bpf examples

[Vipin Varghese]

Add the missing arguments for compiling t2.c and t3.c BPF examples.

Signed-off-by: Vipin Varghese <vipin.varghese@intel.com>
---
 doc/guides/testpmd_app_ug/testpmd_funcs.rst | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index 89d494c5b..d9023ab02 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -4657,6 +4657,10 @@ To load (not JITed) t1.o at TX queue 0, port 0::
 
    testpmd> bpf-load tx 0 0 - ./dpdk.org/examples/bpf/t1.o
 
+.. note::
+
+   In order to build t2.c and t3.c; pass DPDK target's include and library path as compiler options.
+
 bpf-unload
 ~~~~~~~~~~
 
-- 
2.17.1

[dpdk-dev] [PATCH] doc/testpmd: update compile steps for bpf examples

[Vipin Varghese]

Add the missing arguments for compiling t2.c and t3.c BPF examples.

Signed-off-by: Vipin Varghese <vipin.varghese@intel.com>
---
 doc/guides/testpmd_app_ug/testpmd_funcs.rst | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index 89d494c5b..d9023ab02 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -4657,6 +4657,10 @@ To load (not JITed) t1.o at TX queue 0, port 0::
 
    testpmd> bpf-load tx 0 0 - ./dpdk.org/examples/bpf/t1.o
 
+.. note::
+
+   In order to build t2.c and t3.c; pass DPDK target's include and library path as compiler options.
+
 bpf-unload
 ~~~~~~~~~~
 
-- 
2.17.1

Re: [dpdk-dev] [PATCH] doc/testpmd: update compile steps for bpf examples

[Mcnamara, John]

> -----Original Message-----
> From: Varghese, Vipin
> Sent: Tuesday, May 7, 2019 9:41 AM
> To: dev@dpdk.org; Kovacevic, Marko <marko.kovacevic@intel.com>; Mcnamara,
> John <john.mcnamara@intel.com>; Lu, Wenzhuo <wenzhuo.lu@intel.com>; Wu,
> Jingjing <jingjing.wu@intel.com>; Iremonger, Bernard
> <bernard.iremonger@intel.com>
> Cc: Padubidri, Sanjay A <sanjay.padubidri@intel.com>; Varghese, Vipin
> <vipin.varghese@intel.com>
> Subject: [PATCH] doc/testpmd: update compile steps for bpf examples
> 
> Add the missing arguments for compiling t2.c and t3.c BPF examples.
> 

Acked from a doc point of view. Maintainers should check if the instructions are okay.


Acked-by: John McNamara <john.mcnamara@intel.com>

Re: [dpdk-dev] [PATCH] doc/testpmd: update compile steps for bpf examples

[Mcnamara, John]

> -----Original Message-----
> From: Varghese, Vipin
> Sent: Tuesday, May 7, 2019 9:41 AM
> To: dev@dpdk.org; Kovacevic, Marko <marko.kovacevic@intel.com>; Mcnamara,
> John <john.mcnamara@intel.com>; Lu, Wenzhuo <wenzhuo.lu@intel.com>; Wu,
> Jingjing <jingjing.wu@intel.com>; Iremonger, Bernard
> <bernard.iremonger@intel.com>
> Cc: Padubidri, Sanjay A <sanjay.padubidri@intel.com>; Varghese, Vipin
> <vipin.varghese@intel.com>
> Subject: [PATCH] doc/testpmd: update compile steps for bpf examples
> 
> Add the missing arguments for compiling t2.c and t3.c BPF examples.
> 

Acked from a doc point of view. Maintainers should check if the instructions are okay.


Acked-by: John McNamara <john.mcnamara@intel.com>

Re: [dpdk-dev] [PATCH] doc/testpmd: update compile steps for bpf examples

[Thomas Monjalon]

07/05/2019 10:41, Vipin Varghese:
> --- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> +++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> @@ -4657,6 +4657,10 @@ To load (not JITed) t1.o at TX queue 0, port 0::
>  
>     testpmd> bpf-load tx 0 0 - ./dpdk.org/examples/bpf/t1.o
>  
> +.. note::
> +
> +   In order to build t2.c and t3.c; pass DPDK target's include and library path as compiler options.

This note should be below the compilation command.
When adding more BPF examples, it will be easily outdated.
We could say "to build other examples, more arguments may be required".
About the compiler options, I suggest to name them: -I, -L?

Re: [dpdk-dev] [PATCH] doc/testpmd: update compile steps for bpf examples

[Thomas Monjalon]

07/05/2019 10:41, Vipin Varghese:
> --- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> +++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> @@ -4657,6 +4657,10 @@ To load (not JITed) t1.o at TX queue 0, port 0::
>  
>     testpmd> bpf-load tx 0 0 - ./dpdk.org/examples/bpf/t1.o
>  
> +.. note::
> +
> +   In order to build t2.c and t3.c; pass DPDK target's include and library path as compiler options.

This note should be below the compilation command.
When adding more BPF examples, it will be easily outdated.
We could say "to build other examples, more arguments may be required".
About the compiler options, I suggest to name them: -I, -L?

Re: [dpdk-dev] [PATCH] doc/testpmd: update compile steps for bpf examples

[Varghese, Vipin]

snipped
> 
> 07/05/2019 10:41, Vipin Varghese:
> > --- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> > +++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> > @@ -4657,6 +4657,10 @@ To load (not JITed) t1.o at TX queue 0, port 0::
> >
> >     testpmd> bpf-load tx 0 0 - ./dpdk.org/examples/bpf/t1.o
> >
> > +.. note::
> > +
> > +   In order to build t2.c and t3.c; pass DPDK target's include and library path as
> compiler options.
> 
> This note should be below the compilation command.
I agree, I will make the change.

> When adding more BPF examples, it will be easily outdated.
Thanks, can we get some update on BPF examples. Reasoning, we are planning to add dpdk-example specific BPF code but not in test/bpf.

> We could say "to build other examples, more arguments may be required".
> About the compiler options, I suggest to name them: -I, -L?
Sure

> 
> 

Re: [dpdk-dev] [PATCH] doc/testpmd: update compile steps for bpf examples

[Varghese, Vipin]

snipped
> 
> 07/05/2019 10:41, Vipin Varghese:
> > --- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> > +++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> > @@ -4657,6 +4657,10 @@ To load (not JITed) t1.o at TX queue 0, port 0::
> >
> >     testpmd> bpf-load tx 0 0 - ./dpdk.org/examples/bpf/t1.o
> >
> > +.. note::
> > +
> > +   In order to build t2.c and t3.c; pass DPDK target's include and library path as
> compiler options.
> 
> This note should be below the compilation command.
I agree, I will make the change.

> When adding more BPF examples, it will be easily outdated.
Thanks, can we get some update on BPF examples. Reasoning, we are planning to add dpdk-example specific BPF code but not in test/bpf.

> We could say "to build other examples, more arguments may be required".
> About the compiler options, I suggest to name them: -I, -L?
Sure

> 
> 

[dpdk-dev] [PATCH v2] doc/testpmd: update compile steps for bpf examples

[Vipin Varghese]

Add note in the missing arguments for compiling BPF examples.

Signed-off-by: Vipin Varghese <vipin.varghese@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>

---

V2:
 - ACK for documentation - John McNamara
 - move to compile section - Thomas Monjalon
---
 doc/guides/testpmd_app_ug/testpmd_funcs.rst | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index cb83a3ce8..88a66b9a8 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -4651,6 +4651,10 @@ For example:
    cd examples/bpf
    clang -O2 -target bpf -c t1.c
 
+.. note::
+
+   To built other BPF examples, the compiler requires additional command-line options.
+
 Then to load (and JIT compile) t1.o at RX queue 0, port 1:
 
 .. code-block:: console
-- 
2.17.1

Re: [dpdk-dev] [PATCH v2] doc/testpmd: update compile steps for bpf examples

[Thomas Monjalon]

23/05/2019 15:47, Vipin Varghese:
> --- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> +++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> @@ -4651,6 +4651,10 @@ For example:
>     cd examples/bpf
>     clang -O2 -target bpf -c t1.c
>  
> +.. note::
> +
> +   To built other BPF examples, the compiler requires additional command-line options.

"To built" -> "To build"

I think this note is vague. Don't you think it may confuse user
if we don't explicit which kind of options are required?

Re: [dpdk-dev] [PATCH v2] doc/testpmd: update compile steps for bpf examples

[Varghese, Vipin]

HI Thomas,

Snipped

> > +
> > +   To built other BPF examples, the compiler requires additional command-
> line options.
> 
> "To built" -> "To build"
ok

> 
> I think this note is vague. Don't you think it may confuse user if we don't
> explicit which kind of options are required?

Ok, the `v1` content was `In order to build t2.c and t3.c; pass DPDK targets include and library path as compiler options.`. But as user adds other library functions are added to `examples/bpf' these may vary too.

Hence should we state as, `To build other BPF examples, appropriate libraries and dependencies is to be passed as command line options.`

[dpdk-dev] [PATCH v3] doc/testpmd: update compile steps for bpf examples

[Vipin Varghese]

Add note in the missing arguments for compiling BPF examples.

Signed-off-by: Vipin Varghese <vipin.varghese@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>

---

V3:
 - update the dependency for DPDK and others - Thomas Monjalon

V2:
 - ACK for documentation - John McNamara
 - move to compile section - Thomas Monjalon
---
 doc/guides/testpmd_app_ug/testpmd_funcs.rst | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index cb83a3ce8..09cabec8c 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -4651,6 +4651,12 @@ For example:
    cd examples/bpf
    clang -O2 -target bpf -c t1.c
 
+.. note::
+
+   To build DPDK based example, appropriate include and library path is to be
+   passed to compiler. For other examples, corresponding dependencies is to be
+   passed for include and libraries.
+
 Then to load (and JIT compile) t1.o at RX queue 0, port 1:
 
 .. code-block:: console
-- 
2.17.1

Re: [dpdk-dev] [PATCH v3] doc/testpmd: update compile steps for bpf examples

[Stephen Hemminger]

On Mon, 10 Jun 2019 11:11:21 +0530
Vipin Varghese <vipin.varghese@intel.com> wrote:

> Add note in the missing arguments for compiling BPF examples.
> 
> Signed-off-by: Vipin Varghese <vipin.varghese@intel.com>
> Acked-by: John McNamara <john.mcnamara@intel.com>
> 
> ---
> 
> V3:
>  - update the dependency for DPDK and others - Thomas Monjalon
> 
> V2:
>  - ACK for documentation - John McNamara
>  - move to compile section - Thomas Monjalon
> ---
>  doc/guides/testpmd_app_ug/testpmd_funcs.rst | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> index cb83a3ce8..09cabec8c 100644
> --- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> +++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> @@ -4651,6 +4651,12 @@ For example:
>     cd examples/bpf
>     clang -O2 -target bpf -c t1.c
>  
> +.. note::
> +
> +   To build DPDK based example, appropriate include and library path is to be
> +   passed to compiler. For other examples, corresponding dependencies is to be
> +   passed for include and libraries.
> +
>  Then to load (and JIT compile) t1.o at RX queue 0, port 1:
>  
>  .. code-block:: console

I am ok with this but the wording is so generic it doesn't really help
the user. A real example on a real distribution would be better.
Could someone update this patch and resubmit it? Or better yet
just have a make or meson script in examples/bpf?