[v3] doc/testpmd: update compile steps for bpf examples

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

Checks

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

Commit Message

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

Patch

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