[v2] doc/testpmd: update compile steps for bpf examples
Checks
Commit Message
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(+)
Comments
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?
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.`
@@ -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