From patchwork Tue Jun 13 16:15:01 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stephen Hemminger X-Patchwork-Id: 128633 X-Patchwork-Delegate: thomas@monjalon.net 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 8887A42CA7; Tue, 13 Jun 2023 18:15:06 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 32DAC41611; Tue, 13 Jun 2023 18:15:06 +0200 (CEST) Received: from mail-pl1-f176.google.com (mail-pl1-f176.google.com [209.85.214.176]) by mails.dpdk.org (Postfix) with ESMTP id 5B4DE40A8A for ; Tue, 13 Jun 2023 18:15:05 +0200 (CEST) Received: by mail-pl1-f176.google.com with SMTP id d9443c01a7336-1b3c1730fc9so16600455ad.0 for ; Tue, 13 Jun 2023 09:15:05 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=networkplumber-org.20221208.gappssmtp.com; s=20221208; t=1686672904; x=1689264904; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=gCMO5wgEPNfJzqHWj/0dbOs2kInC8aHnkuXUr0Ka3JI=; b=lRGKheCvMrib30a4TR3btEREPaKMup9/p9HqrayXb7Ly9+7N8k6vVi5SqZh8TYwE9I UB2htFHnUmFbVIyU3ifclypTqjRtm581SYnprK7QVJhcFYTyGW9maOtuiqpFjNZ+MnlK 8KgNzYLB2D1ziFOzd0sCOiwLkJkPySCX7cDHmenbDYmFbvo2SxPcq018yxQzIGV2M9x7 h7HGwEGP+Orgbfv/Gz+JtJokid4NKxz8Ms2cIUtjxZmTkKecP4TV77Gb8zzcRbjf1obj jS070fYLpG/BBDp4E+IlaNV/jaHGIFUuNLdZuUMmkptf0zNJJ2LIM1BkJXadi1Jn+DD1 44SQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1686672904; x=1689264904; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=gCMO5wgEPNfJzqHWj/0dbOs2kInC8aHnkuXUr0Ka3JI=; b=Sk0M7z584x7wtLO43kbZ+xT7iSXzqxkvkAmXazTlAHvlrot7mfJAd+MSk8+8nWgtTK qltK9pZG/GXNE4J8NUyf9QqhVKNWNY6kJuSQ6saNeeCh8kMKeTuXkLgmDazdFIRW7cau lxe6AwAv2IKbdNGDfXZ79Q2W/xh1SkMw+Mv1+bkEjQ60B71MxpsHncc7//0JlR6Hl7+4 9H+Vl7IWVEdEms1rr/GoVH99seoCqYjZgBAByC8vk/8/9LtrT7ROo0owKz2E0kALEZ/A ZHoCNJB0lnAYuYkM8IAcYmTUjYCGcBzBDAO4C/DYdtnVPHxomzRjtan4ExhMiGBtKnKa BoIw== X-Gm-Message-State: AC+VfDxIaWAnwZ7gtUAW3Vy2pFqSKe2fSv6/sUYQxRl6jei2OAeNQaYs sFFDFGZyMst+twyCoEcTvda6406jrmqc1BPy+ler/w== X-Google-Smtp-Source: ACHHUZ4f0krhODTewjfuIV7zic1hd27rVmXsK3+aVDuLlkvoI28THRnt33gAosy6Zc9hD162EjGbIA== X-Received: by 2002:a17:903:1c4:b0:1b3:e003:be8e with SMTP id e4-20020a17090301c400b001b3e003be8emr3893646plh.7.1686672904202; Tue, 13 Jun 2023 09:15:04 -0700 (PDT) Received: from hermes.local (204-195-120-218.wavecable.com. [204.195.120.218]) by smtp.gmail.com with ESMTPSA id jf13-20020a170903268d00b001b3d7f5320dsm3602997plb.189.2023.06.13.09.15.03 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 13 Jun 2023 09:15:03 -0700 (PDT) From: Stephen Hemminger To: dev@dpdk.org Cc: Stephen Hemminger , Vipin Varghese , Konstantin Ananyev , Sunil Kumar Kori , Pavan Nikhilesh , Bruce Richardson Subject: [PATCH] doc: fix description of maximum rx queues per lcore option Date: Tue, 13 Jun 2023 09:15:01 -0700 Message-Id: <20230613161501.66990-1-stephen@networkplumber.org> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20190507064948.34567-1-vipin.varghese@intel.com> References: <20190507064948.34567-1-vipin.varghese@intel.com> MIME-Version: 1.0 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 Several commands have a -q option but the description in the documentation was unclear. It is the upper limit on the number of queues per lcore. Suggested-by: Vipin Varghese Signed-off-by: Stephen Hemminger --- doc/guides/sample_app_ug/ip_frag.rst | 2 +- doc/guides/sample_app_ug/keep_alive.rst | 2 +- doc/guides/sample_app_ug/l2_forward_crypto.rst | 2 +- doc/guides/sample_app_ug/l2_forward_event.rst | 2 +- doc/guides/sample_app_ug/l2_forward_job_stats.rst | 2 +- doc/guides/sample_app_ug/l2_forward_real_virtual.rst | 2 +- doc/guides/sample_app_ug/link_status_intr.rst | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/guides/sample_app_ug/ip_frag.rst b/doc/guides/sample_app_ug/ip_frag.rst index 5fdeb2a84e0c..dd15033a4a08 100644 --- a/doc/guides/sample_app_ug/ip_frag.rst +++ b/doc/guides/sample_app_ug/ip_frag.rst @@ -59,7 +59,7 @@ where: * -p PORTMASK is a hexadecimal bitmask of ports to configure -* -q NQ is the number of queue (=ports) per lcore (the default is 1) +* -q NQ: Maximum number of queues per lcore (default is 1) To run the example in linux environment with 2 lcores (2,4) over 2 ports(0,2) with 1 RX queue per lcore: diff --git a/doc/guides/sample_app_ug/keep_alive.rst b/doc/guides/sample_app_ug/keep_alive.rst index a907ff36a192..a7da795907a3 100644 --- a/doc/guides/sample_app_ug/keep_alive.rst +++ b/doc/guides/sample_app_ug/keep_alive.rst @@ -56,7 +56,7 @@ where, * ``p PORTMASK``: A hexadecimal bitmask of the ports to configure -* ``q NQ``: A number of queues (=ports) per lcore (default is 1) +* ``q NQ``: Maximum number of queues per lcore (default is 1) * ``K PERIOD``: Heartbeat check period in ms(5ms default; 86400 max) diff --git a/doc/guides/sample_app_ug/l2_forward_crypto.rst b/doc/guides/sample_app_ug/l2_forward_crypto.rst index ce49eab96fe2..ed3c38f3ed6f 100644 --- a/doc/guides/sample_app_ug/l2_forward_crypto.rst +++ b/doc/guides/sample_app_ug/l2_forward_crypto.rst @@ -56,7 +56,7 @@ where, * p PORTMASK: A hexadecimal bitmask of the ports to configure. (Default is all the ports.) -* q NQ: A number of queues (=ports) per lcore. (Default is 1.) +* q NQ: Maximum number of queues per lcore (default is 1) * s: manage all ports from a single core. diff --git a/doc/guides/sample_app_ug/l2_forward_event.rst b/doc/guides/sample_app_ug/l2_forward_event.rst index 904f6f1a4a26..f914fdc14d97 100644 --- a/doc/guides/sample_app_ug/l2_forward_event.rst +++ b/doc/guides/sample_app_ug/l2_forward_event.rst @@ -63,7 +63,7 @@ where, * p PORTMASK: A hexadecimal bitmask of the ports to configure -* q NQ: A number of queues (=ports) per lcore (default is 1) +* q NQ: Maximum number of queues per lcore (default is 1) * --[no-]mac-updating: Enable or disable MAC addresses updating (enabled by default). diff --git a/doc/guides/sample_app_ug/l2_forward_job_stats.rst b/doc/guides/sample_app_ug/l2_forward_job_stats.rst index 349ad56ec6b6..53a12351d67a 100644 --- a/doc/guides/sample_app_ug/l2_forward_job_stats.rst +++ b/doc/guides/sample_app_ug/l2_forward_job_stats.rst @@ -87,7 +87,7 @@ where, * p PORTMASK: A hexadecimal bitmask of the ports to configure -* q NQ: A number of queues (=ports) per lcore (default is 1) +* q NQ: Maximum number of queues per lcore (default is 1) * l: Use locale thousands separator when formatting big numbers. diff --git a/doc/guides/sample_app_ug/l2_forward_real_virtual.rst b/doc/guides/sample_app_ug/l2_forward_real_virtual.rst index aeeda7059cb6..8d1958aa7001 100644 --- a/doc/guides/sample_app_ug/l2_forward_real_virtual.rst +++ b/doc/guides/sample_app_ug/l2_forward_real_virtual.rst @@ -106,7 +106,7 @@ where, Without this option, only packets with the MAC destination address set to the Ethernet address of the port are accepted. -* q NQ: A number of queues (=ports) per lcore (default is 1) +* q NQ: Maximum number of queues per lcore (default is 1) * --[no-]mac-updating: Enable or disable MAC addresses updating (enabled by default) diff --git a/doc/guides/sample_app_ug/link_status_intr.rst b/doc/guides/sample_app_ug/link_status_intr.rst index a4c0712bd92f..34b8b2e13186 100644 --- a/doc/guides/sample_app_ug/link_status_intr.rst +++ b/doc/guides/sample_app_ug/link_status_intr.rst @@ -45,7 +45,7 @@ where, * -p PORTMASK: A hexadecimal bitmask of the ports to configure -* -q NQ: A number of queues (=ports) per lcore (default is 1) +* -q NQ: Maximum number of queues per lcore (default is 1) * -T PERIOD: statistics will be refreshed each PERIOD seconds (0 to disable, 10 default)