diff mbox series

doc: replace testpmd with ./<build_dir>/app/dpdk-testpmd in all commands

Message ID 20210210115619.8637-1-sarosh.arif@emumba.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers show
Series doc: replace testpmd with ./<build_dir>/app/dpdk-testpmd in all commands | expand

Checks

Context Check Description
ci/checkpatch warning coding style issues
ci/intel-Testing success Testing PASS
ci/Intel-compilation success Compilation OK

Commit Message

Sarosh Arif Feb. 10, 2021, 11:56 a.m. UTC
replace testpmd with ./<build_dir>/app/dpdk-testpmd in all commands
because on compilation through meson, dpdk-testpmd is the default 
application name.

Signed-off-by: Sarosh Arif <sarosh.arif@emumba.com>
---
 doc/guides/nics/bnxt.rst    | 8 ++++----
 doc/guides/nics/e1000em.rst | 2 +-
 doc/guides/nics/kni.rst     | 4 ++--
 doc/guides/nics/mlx4.rst    | 2 +-
 doc/guides/nics/mlx5.rst    | 2 +-
 doc/guides/nics/qede.rst    | 2 +-
 doc/guides/nics/virtio.rst  | 2 +-
 7 files changed, 11 insertions(+), 11 deletions(-)

Comments

Ferruh Yigit Feb. 10, 2021, 12:54 p.m. UTC | #1
On 2/10/2021 11:56 AM, Sarosh Arif wrote:
> replace testpmd with ./<build_dir>/app/dpdk-testpmd in all commands
> because on compilation through meson, dpdk-testpmd is the default
> application name.
> 
> Signed-off-by: Sarosh Arif <sarosh.arif@emumba.com>
> ---
>   doc/guides/nics/bnxt.rst    | 8 ++++----
>   doc/guides/nics/e1000em.rst | 2 +-
>   doc/guides/nics/kni.rst     | 4 ++--
>   doc/guides/nics/mlx4.rst    | 2 +-
>   doc/guides/nics/mlx5.rst    | 2 +-
>   doc/guides/nics/qede.rst    | 2 +-
>   doc/guides/nics/virtio.rst  | 2 +-
>   7 files changed, 11 insertions(+), 11 deletions(-)
> 
> diff --git a/doc/guides/nics/bnxt.rst b/doc/guides/nics/bnxt.rst
> index 801ec3ca5..1e2f78a2e 100644
> --- a/doc/guides/nics/bnxt.rst
> +++ b/doc/guides/nics/bnxt.rst
> @@ -361,7 +361,7 @@ The application enables multiple TX and RX queues when it is started.
>   
>   .. code-block:: console
>   
> -    testpmd -l 1,3,5 --main-lcore 1 --txq=2 –rxq=2 --nb-cores=2
> +    ./<build_dir>/app/dpdk-testpmd -l 1,3,5 --main-lcore 1 --txq=2 –rxq=2 --nb-cores=2
>   

Ok to replace 'testpmd' -> 'dpdk-testpmd', but do we really need to add the 
relative path?
Users can be calling the application from installed folder, and this additional 
information brings additional maintenance cost with a small to none benefit, 
what do you think to drop the folder path?
Sarosh Arif Feb. 11, 2021, 7:06 a.m. UTC | #2
Yes, I think we can drop the relative path. I'll make this change in
the next version.



On Wed, Feb 10, 2021 at 5:54 PM Ferruh Yigit <ferruh.yigit@intel.com> wrote:
>
> On 2/10/2021 11:56 AM, Sarosh Arif wrote:
> > replace testpmd with ./<build_dir>/app/dpdk-testpmd in all commands
> > because on compilation through meson, dpdk-testpmd is the default
> > application name.
> >
> > Signed-off-by: Sarosh Arif <sarosh.arif@emumba.com>
> > ---
> >   doc/guides/nics/bnxt.rst    | 8 ++++----
> >   doc/guides/nics/e1000em.rst | 2 +-
> >   doc/guides/nics/kni.rst     | 4 ++--
> >   doc/guides/nics/mlx4.rst    | 2 +-
> >   doc/guides/nics/mlx5.rst    | 2 +-
> >   doc/guides/nics/qede.rst    | 2 +-
> >   doc/guides/nics/virtio.rst  | 2 +-
> >   7 files changed, 11 insertions(+), 11 deletions(-)
> >
> > diff --git a/doc/guides/nics/bnxt.rst b/doc/guides/nics/bnxt.rst
> > index 801ec3ca5..1e2f78a2e 100644
> > --- a/doc/guides/nics/bnxt.rst
> > +++ b/doc/guides/nics/bnxt.rst
> > @@ -361,7 +361,7 @@ The application enables multiple TX and RX queues when it is started.
> >
> >   .. code-block:: console
> >
> > -    testpmd -l 1,3,5 --main-lcore 1 --txq=2 –rxq=2 --nb-cores=2
> > +    ./<build_dir>/app/dpdk-testpmd -l 1,3,5 --main-lcore 1 --txq=2 –rxq=2 --nb-cores=2
> >
>
> Ok to replace 'testpmd' -> 'dpdk-testpmd', but do we really need to add the
> relative path?
> Users can be calling the application from installed folder, and this additional
> information brings additional maintenance cost with a small to none benefit,
> what do you think to drop the folder path?
diff mbox series

Patch

diff --git a/doc/guides/nics/bnxt.rst b/doc/guides/nics/bnxt.rst
index 801ec3ca5..1e2f78a2e 100644
--- a/doc/guides/nics/bnxt.rst
+++ b/doc/guides/nics/bnxt.rst
@@ -361,7 +361,7 @@  The application enables multiple TX and RX queues when it is started.
 
 .. code-block:: console
 
-    testpmd -l 1,3,5 --main-lcore 1 --txq=2 –rxq=2 --nb-cores=2
+    ./<build_dir>/app/dpdk-testpmd -l 1,3,5 --main-lcore 1 --txq=2 –rxq=2 --nb-cores=2
 
 **TSS**
 
@@ -753,7 +753,7 @@  The sample command line with the new ``devargs`` looks like this::
 
 .. code-block:: console
 
-	testpmd -l1-4 -n2 -a 0008:01:00.0,host-based-truflow=1,\
+	./<build_dir>/app/dpdk-testpmd -l1-4 -n2 -a 0008:01:00.0,host-based-truflow=1,\
 	representor=[0], rep-based-pf=8,rep-is-pf=0,rep-q-r2f=1,rep-fc-r2f=1,\
 	rep-q-f2r=0,rep-fc-f2r=1 --log-level="pmd.*",8 -- -i --rxq=3 --txq=3
 
@@ -847,8 +847,8 @@  DPDK implements a light-weight library to allow PMDs to be bonded together and p
 
 .. code-block:: console
 
-    testpmd -l 0-3 -n4 --vdev 'net_bonding0,mode=0,slave=<PCI B:D.F device 1>,slave=<PCI B:D.F device 2>,mac=XX:XX:XX:XX:XX:XX’ – --socket_num=1 – -i --port-topology=chained
-    (ex) testpmd -l 1,3,5,7,9 -n4 --vdev 'net_bonding0,mode=0,slave=0000:82:00.0,slave=0000:82:00.1,mac=00:1e:67:1d:fd:1d' – --socket-num=1 – -i --port-topology=chained
+    ./<build_dir>/app/dpdk-testpmd -l 0-3 -n4 --vdev 'net_bonding0,mode=0,slave=<PCI B:D.F device 1>,slave=<PCI B:D.F device 2>,mac=XX:XX:XX:XX:XX:XX’ – --socket_num=1 – -i --port-topology=chained
+    (ex) ./<build_dir>/app/dpdk-testpmd -l 1,3,5,7,9 -n4 --vdev 'net_bonding0,mode=0,slave=0000:82:00.0,slave=0000:82:00.1,mac=00:1e:67:1d:fd:1d' – --socket-num=1 – -i --port-topology=chained
 
 Vector Processing
 -----------------
diff --git a/doc/guides/nics/e1000em.rst b/doc/guides/nics/e1000em.rst
index b6a2534e3..57668215b 100644
--- a/doc/guides/nics/e1000em.rst
+++ b/doc/guides/nics/e1000em.rst
@@ -146,7 +146,7 @@  The following are known limitations:
     Therefore, rte_mbuf should be big enough to hold the whole packet.
     For example, to allow testpmd to receive jumbo frames, use the following:
 
-    testpmd [options] -- --mbuf-size=<your-max-packet-size>
+    ./<build_dir>/app/dpdk-testpmd [options] -- --mbuf-size=<your-max-packet-size>
 
 #.  Qemu e1000 does not validate the checksum of incoming packets.
 
diff --git a/doc/guides/nics/kni.rst b/doc/guides/nics/kni.rst
index 80ba459d4..6da459c1c 100644
--- a/doc/guides/nics/kni.rst
+++ b/doc/guides/nics/kni.rst
@@ -33,7 +33,7 @@  Usage
 
 EAL ``--vdev`` argument can be used to create KNI device instance, like::
 
-        testpmd --vdev=net_kni0 --vdev=net_kn1 -- -i
+        ./<build_dir>/app/dpdk-testpmd --vdev=net_kni0 --vdev=net_kn1 -- -i
 
 Above command will create ``kni0`` and ``kni1`` Linux network interfaces,
 those interfaces can be controlled by standard Linux tools.
@@ -77,7 +77,7 @@  requests itself.
 
 Argument usage::
 
-        testpmd --vdev "net_kni0,no_request_thread=1" -- -i
+        ./<build_dir>/app/dpdk-testpmd --vdev "net_kni0,no_request_thread=1" -- -i
 
 
 PMD log messages
diff --git a/doc/guides/nics/mlx4.rst b/doc/guides/nics/mlx4.rst
index 354c2bb82..b811abd48 100644
--- a/doc/guides/nics/mlx4.rst
+++ b/doc/guides/nics/mlx4.rst
@@ -409,7 +409,7 @@  devices managed by librte_net_mlx4.
 
 #. Start testpmd with basic parameters::
 
-      testpmd -l 8-15 -n 4 -a 0000:83:00.0 -a 0000:84:00.0 -- --rxq=2 --txq=2 -i
+      ./<build_dir>/app/dpdk-testpmd -l 8-15 -n 4 -a 0000:83:00.0 -a 0000:84:00.0 -- --rxq=2 --txq=2 -i
 
    Example output::
 
diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index 51d81a020..24dd12e37 100644
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -1714,7 +1714,7 @@  ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices managed by librte_net_mlx5.
 
 #. Start testpmd with basic parameters::
 
-      testpmd -l 8-15 -n 4 -a 05:00.0 -a 05:00.1 -a 06:00.0 -a 06:00.1 -- --rxq=2 --txq=2 -i
+      ./<build_dir>/app/dpdk-testpmd -l 8-15 -n 4 -a 05:00.0 -a 05:00.1 -a 06:00.0 -a 06:00.1 -- --rxq=2 --txq=2 -i
 
    Example output::
 
diff --git a/doc/guides/nics/qede.rst b/doc/guides/nics/qede.rst
index bb127ca21..6e4de7e79 100644
--- a/doc/guides/nics/qede.rst
+++ b/doc/guides/nics/qede.rst
@@ -272,7 +272,7 @@  This section provides instructions to configure SR-IOV with Linux OS.
 
    .. code-block:: console
 
-      testpmd -l 0,4-11 -n 4 -- -i --nb-cores=8 --portmask=0xf --rxd=4096 \
+      ./<build_dir>/app/dpdk-testpmd -l 0,4-11 -n 4 -- -i --nb-cores=8 --portmask=0xf --rxd=4096 \
       --txd=4096 --txfreet=4068 --enable-rx-cksum --rxq=4 --txq=4 \
       --rss-ip --rss-udp
 
diff --git a/doc/guides/nics/virtio.rst b/doc/guides/nics/virtio.rst
index b7be3aca1..fc09432f5 100644
--- a/doc/guides/nics/virtio.rst
+++ b/doc/guides/nics/virtio.rst
@@ -266,7 +266,7 @@  There is no vector callbacks for packed virtqueue for now.
 Example of using the vector version of the virtio poll mode driver in
 ``testpmd``::
 
-   testpmd -l 0-2 -n 4 -- -i --rxq=1 --txq=1 --nb-cores=1
+   ./<build_dir>/app/dpdk-testpmd -l 0-2 -n 4 -- -i --rxq=1 --txq=1 --nb-cores=1
 
 In-order callbacks only work on simulated virtio user vdev.