From patchwork Thu Nov 23 11:44:02 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: David Marchand X-Patchwork-Id: 134558 X-Patchwork-Delegate: david.marchand@redhat.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 46B25433A8; Thu, 23 Nov 2023 12:44:39 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 45EDD42F2F; Thu, 23 Nov 2023 12:44:36 +0100 (CET) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by mails.dpdk.org (Postfix) with ESMTP id E335E42F29 for ; Thu, 23 Nov 2023 12:44:33 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1700739873; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=IC7YHQCWDMmsaMUObLkVFHlMi9tV9d2fqN7IW0eWEE0=; b=P6w5JzRW67QMj1HU8uqJQdd5lRbHXyG+mqetn4W0IA8pcbjYGw5sipS6ODzbT7lDKOvgHx 7xFk91z5kRmqLxVVSgCTiMWhRIBcAlY8qvtdc3hbP9tw4q8u3zy6wmsmDQ2J5XUh46POn1 6dEHWKwsK44m9NN0DGKGmWOTimjRYGo= Received: from mimecast-mx02.redhat.com (mx-ext.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-486-kmikkkDxPtC3Gu17RllrkA-1; Thu, 23 Nov 2023 06:44:29 -0500 X-MC-Unique: kmikkkDxPtC3Gu17RllrkA-1 Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.rdu2.redhat.com [10.11.54.8]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id D45893C1490D; Thu, 23 Nov 2023 11:44:28 +0000 (UTC) Received: from dmarchan.redhat.com (unknown [10.45.226.112]) by smtp.corp.redhat.com (Postfix) with ESMTP id 1481CC1596F; Thu, 23 Nov 2023 11:44:27 +0000 (UTC) From: David Marchand To: dev@dpdk.org Cc: thomas@monjalon.net, Jakub Grajciar Subject: [PATCH 2/5] doc: enhance readability in memif example commands Date: Thu, 23 Nov 2023 12:44:02 +0100 Message-ID: <20231123114405.2611371-3-david.marchand@redhat.com> In-Reply-To: <20231123114405.2611371-1-david.marchand@redhat.com> References: <20231123114405.2611371-1-david.marchand@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.4.1 on 10.11.54.8 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com 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 '#.' is a token for ordered lists in RST. Add a space in those example commands. Signed-off-by: David Marchand Acked-by: Bruce Richardson --- doc/guides/nics/memif.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/guides/nics/memif.rst b/doc/guides/nics/memif.rst index afc574fdaa..2867b2f66d 100644 --- a/doc/guides/nics/memif.rst +++ b/doc/guides/nics/memif.rst @@ -216,15 +216,15 @@ In this example we run two instances of testpmd application and transmit packets First create ``server`` interface:: - #.//app/dpdk-testpmd -l 0-1 --proc-type=primary --file-prefix=pmd1 --vdev=net_memif,role=server -- -i + # .//app/dpdk-testpmd -l 0-1 --proc-type=primary --file-prefix=pmd1 --vdev=net_memif,role=server -- -i Now create ``client`` interface (server must be already running so the client will connect):: - #.//app/dpdk-testpmd -l 2-3 --proc-type=primary --file-prefix=pmd2 --vdev=net_memif -- -i + # .//app/dpdk-testpmd -l 2-3 --proc-type=primary --file-prefix=pmd2 --vdev=net_memif -- -i You can also enable ``zero-copy`` on ``client`` interface:: - #.//app/dpdk-testpmd -l 2-3 --proc-type=primary --file-prefix=pmd2 --vdev=net_memif,zero-copy=yes --single-file-segments -- -i + # .//app/dpdk-testpmd -l 2-3 --proc-type=primary --file-prefix=pmd2 --vdev=net_memif,zero-copy=yes --single-file-segments -- -i Start forwarding packets:: @@ -260,7 +260,7 @@ To see socket filename use show memif command:: Now create memif interface by running testpmd with these command line options:: - #./dpdk-testpmd --vdev=net_memif,socket=/run/vpp/memif.sock -- -i + # ./dpdk-testpmd --vdev=net_memif,socket=/run/vpp/memif.sock -- -i Testpmd should now create memif client interface and try to connect to server. In testpmd set forward option to icmpecho and start forwarding:: @@ -283,7 +283,7 @@ The situation is analogous to cross connecting 2 ports of the NIC by cable. To set the loopback, just use the same socket and id with different roles:: - #./dpdk-testpmd --vdev=net_memif0,role=server,id=0 --vdev=net_memif1,role=client,id=0 -- -i + # ./dpdk-testpmd --vdev=net_memif0,role=server,id=0 --vdev=net_memif1,role=client,id=0 -- -i Then start the communication::