DPDK patches and discussions
 help / color / mirror / Atom feed
From: Ben Pfaff <blp@ovn.org>
To: dev@dpdk.org
Cc: Thomas Monjalon <thomas@monjalon.net>, Ben Pfaff <blp@ovn.org>
Subject: [dpdk-dev] [PATCH v2] app/testpmd: Document what the application does.
Date: Mon, 13 Sep 2021 11:33:44 -0700	[thread overview]
Message-ID: <20210913183344.1513132-1-blp@ovn.org> (raw)

I could not find anything in the documentation that says what
testpmd does.  This should save other people time trying to
figure that out in the future.

Signed-off-by: Ben Pfaff <blp@ovn.org>
v1->v2: Revise introduction instead of option documentation.
  Thanks to Thomas Monjalon for advice.

 doc/guides/testpmd_app_ug/intro.rst | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

diff --git a/doc/guides/testpmd_app_ug/intro.rst b/doc/guides/testpmd_app_ug/intro.rst
index 5d8d8cf4eb..1129f53c62 100644
--- a/doc/guides/testpmd_app_ug/intro.rst
+++ b/doc/guides/testpmd_app_ug/intro.rst
@@ -6,9 +6,13 @@ Introduction
 This document is a user guide for the ``testpmd`` example application that is shipped as part of the Data Plane Development Kit.
-The ``testpmd`` application can be used to test the DPDK in a packet forwarding mode
-and also to access NIC hardware features such as Flow Director.
-It also serves as a example of how to build a more fully-featured application using the DPDK SDK.
+``testpmd`` is a tool to test ethdev NIC features, including NIC
+hardware features such as Flow Director.  It receives packets on each
+configured port and forwards them.  By default, packets received on
+port 0 are forwarded to port 1, and vice versa, and similarly for
+ports 2 and 3, ports 4 and 5, and so on.  If an odd number of ports is
+configured, packets received on the last port are sent back out on the
+same port.
 The guide shows how to build and run the testpmd application and
 how to configure the application from the command line and the run-time environment.

             reply	other threads:[~2021-09-13 18:33 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-09-13 18:33 Ben Pfaff [this message]
2021-09-13 18:58 ` Thomas Monjalon
2021-09-14  0:26   ` Ajit Khaparde
2021-09-14  0:28     ` Ajit Khaparde
2021-09-14  8:08 ` Ferruh Yigit

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210913183344.1513132-1-blp@ovn.org \
    --to=blp@ovn.org \
    --cc=dev@dpdk.org \
    --cc=thomas@monjalon.net \


* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).