From patchwork Mon Sep 13 18:33:44 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ben Pfaff X-Patchwork-Id: 98811 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 7D730A0C45; Mon, 13 Sep 2021 20:33:57 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 0CE6A40151; Mon, 13 Sep 2021 20:33:57 +0200 (CEST) Received: from relay12.mail.gandi.net (relay12.mail.gandi.net [217.70.178.232]) by mails.dpdk.org (Postfix) with ESMTP id 4AFEC4014F for ; Mon, 13 Sep 2021 20:33:55 +0200 (CEST) Received: (Authenticated sender: blp@ovn.org) by relay12.mail.gandi.net (Postfix) with ESMTPSA id F2A68200006; Mon, 13 Sep 2021 18:33:53 +0000 (UTC) From: Ben Pfaff To: dev@dpdk.org Cc: Thomas Monjalon , Ben Pfaff Date: Mon, 13 Sep 2021 11:33:44 -0700 Message-Id: <20210913183344.1513132-1-blp@ovn.org> X-Mailer: git-send-email 2.31.1 MIME-Version: 1.0 Subject: [dpdk-dev] [PATCH v2] 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 --- 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.