doc/testpmd: update compile steps for bpf examples

Message ID 20190507084112.35296-1-vipin.varghese@intel.com
State New
Delegated to: Thomas Monjalon
Headers show
Series
  • doc/testpmd: update compile steps for bpf examples
Related show

Checks

Context Check Description
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

Varghese, Vipin May 7, 2019, 8:41 a.m.
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(+)

Comments

Mcnamara, John May 7, 2019, 3:07 p.m. | #1
> -----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>
Thomas Monjalon May 9, 2019, 10:31 p.m. | #2
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?
Varghese, Vipin May 10, 2019, 1:41 a.m. | #3
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

> 
>

Patch

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