From patchwork Fri Sep 10 17:57:34 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ben Pfaff X-Patchwork-Id: 98671 X-Patchwork-Delegate: ferruh.yigit@amd.com Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 69C8CA0547; Fri, 10 Sep 2021 19:58:12 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 2C7A9410DA; Fri, 10 Sep 2021 19:58:12 +0200 (CEST) Received: from relay8-d.mail.gandi.net (relay8-d.mail.gandi.net [217.70.183.201]) by mails.dpdk.org (Postfix) with ESMTP id 5292E40DF4 for ; Fri, 10 Sep 2021 19:58:10 +0200 (CEST) Received: (Authenticated sender: blp@ovn.org) by relay8-d.mail.gandi.net (Postfix) with ESMTPSA id 580D91BF204; Fri, 10 Sep 2021 17:58:08 +0000 (UTC) From: Ben Pfaff To: dev@dpdk.org Cc: Ben Pfaff Date: Fri, 10 Sep 2021 10:57:34 -0700 Message-Id: <20210910175733.1248739-1-blp@ovn.org> X-Mailer: git-send-email 2.31.1 MIME-Version: 1.0 Subject: [dpdk-dev] [PATCH] app/testpmd: Document what the application does. X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 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 --- doc/guides/testpmd_app_ug/run_app.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/guides/testpmd_app_ug/run_app.rst b/doc/guides/testpmd_app_ug/run_app.rst index 6061674239..7c3406f72b 100644 --- a/doc/guides/testpmd_app_ug/run_app.rst +++ b/doc/guides/testpmd_app_ug/run_app.rst @@ -15,6 +15,12 @@ a list of available EAL command-line options. Testpmd Command-line Options ---------------------------- +By default, testpmd receives packets on each configured port and +forwards the received packets to its paired port. Ports 0 and 1 are +paired, as are ports 2 and 3, and so on. With an odd number of ports, +the last port is paired with itself: packets received on the port are +sent back out on the same port. + The following are the command-line options for the testpmd applications. They must be separated from the EAL options, shown in the previous section, with a ``--`` separator: