From patchwork Fri Oct 18 15:06:57 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Thierry Herbelot X-Patchwork-Id: 61473 X-Patchwork-Delegate: ferruh.yigit@amd.com Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 5DEAA1C11B; Fri, 18 Oct 2019 17:07:15 +0200 (CEST) Received: from mail-wr1-f48.google.com (mail-wr1-f48.google.com [209.85.221.48]) by dpdk.org (Postfix) with ESMTP id 3777D1C0D0 for ; Fri, 18 Oct 2019 17:07:13 +0200 (CEST) Received: by mail-wr1-f48.google.com with SMTP id p4so6638689wrm.8 for ; Fri, 18 Oct 2019 08:07:13 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=6wind.com; s=google; h=from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=b9boFgs7JUo35R5f7Ojd7Hv3ZbFvnwhGJttO404d0zU=; b=bknk+Ty6a01hQEOGsveq3i6OogTzL7SDc5jagnHaKOopW4th/F6qJVr0ojmO01QPZM ahDSZHLDQb1yNhHBEoIZUzR8tR7FQnDdts0HsW87GUZVcR/Wklgdi5+sXvCD5O828O2P 2m6fc3h5VFvzKNB9G4a/97yAsicAT222ZnRfzKfzFK95BXpBkeeqZNM9B7Xsnau5HN6i Cts5td8+MVXykcAKDmRG6zSUb32/04oIoT5RA+5gRCstofmeQD9+fMyItq1wam5BKJxJ 7CxrbKXNaTkj/ZWio1CLigSbHbspk+dhB8EI5s29NEXYdDWn44ACifVVfoYXSzjNv+DT 1D9Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=b9boFgs7JUo35R5f7Ojd7Hv3ZbFvnwhGJttO404d0zU=; b=S4pUpzWGhMokzlLfeOhhBMnPOjup42Uq/UE3Z19DxYCquMKTMJRcbgaVbVBnmemiY2 IwdNV3+gE31u27jb5r++VPXWnNfBvqI8xqLQOxuSNVvXlNkx8Q+p8P9rWMTCSub/Kelk 42RagLPR4l9Pm3VAw2B+OYTECMAzIs3TwWklmvMktU9du+PY5LNEjcHHOlQyVLqAghOP 9EI84P64bCau5yqJyOmORGUc1Y1CCFHJZ28vfD7JY2hHiXhmrvDSOoNwED0bbvpdksBU h9SAFTUPWep5Hd4kD473ttPpxt/a0R/2u+xDvReTomgRiRDK+qjyhUqZU0Ul3TkAjOLR GCKw== X-Gm-Message-State: APjAAAVwBc7xIA1pFXtWMswir4I6wZ2CsgTsY4pCsvaaQI7bXawRE8Vo M5qdsX01nh92buiAx8IUQlp9f6NIZQ== X-Google-Smtp-Source: APXvYqyvWT2qyr+Sz3h8gcY+virAH6qEgrh6ySdDrl4e2+9PsSFUu/Ui1xgofN+oWZvzx1CDvDmtrg== X-Received: by 2002:a05:6000:11cd:: with SMTP id i13mr7966417wrx.197.1571411232699; Fri, 18 Oct 2019 08:07:12 -0700 (PDT) Received: from ascain.dev.6wind.com. (host.78.145.23.62.rev.coltfrance.com. [62.23.145.78]) by smtp.gmail.com with ESMTPSA id u11sm5517077wmd.32.2019.10.18.08.07.12 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 18 Oct 2019 08:07:12 -0700 (PDT) From: Thierry Herbelot To: dev@dpdk.org Cc: Thomas Monjalon , stable@dpdk.org Date: Fri, 18 Oct 2019 17:06:57 +0200 Message-Id: <20191018150657.17600-1-thierry.herbelot@6wind.com> X-Mailer: git-send-email 2.20.1 MIME-Version: 1.0 Subject: [dpdk-dev] [PATCH] doc/guides/nics: fix typos X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 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" 'CRC striping' should be spelled 'CRC stripping'. Fixes: 3eee1f067e7c ('fm10k: add guide') Fixes: 7a4d9f6676d7 ('doc: add liquidio') Fixes: f820b5896631 ('doc: add octeontx ethdev driver documentation') Fixes: 920717e4d8ba ('net/octeontx2: add device start operation') Fixes: f994cecafdcf ('doc: add ThunderX nicvf') Cc: stable@dpdk.org Signed-off-by: Thierry Herbelot Reviewed-by: Ferruh Yigit --- doc/guides/nics/fm10k.rst | 4 ++-- doc/guides/nics/liquidio.rst | 4 ++-- doc/guides/nics/octeontx.rst | 4 ++-- doc/guides/nics/octeontx2.rst | 4 ++-- doc/guides/nics/thunderx.rst | 4 ++-- 5 files changed, 10 insertions(+), 10 deletions(-) diff --git a/doc/guides/nics/fm10k.rst b/doc/guides/nics/fm10k.rst index 764e089c8616..20a1cde53590 100644 --- a/doc/guides/nics/fm10k.rst +++ b/doc/guides/nics/fm10k.rst @@ -135,8 +135,8 @@ the Rx/Tx queues. When switch comes up, a LSC event indicating ``LINK_UP`` is sent to the app, which can then restart the FM10000 port to resume network processing. -CRC striping -~~~~~~~~~~~~ +CRC stripping +~~~~~~~~~~~~~ The FM10000 family of NICs strip the CRC for every packets coming into the host interface. So, keeping CRC is not supported. diff --git a/doc/guides/nics/liquidio.rst b/doc/guides/nics/liquidio.rst index e2a38004d0d6..0534146720f1 100644 --- a/doc/guides/nics/liquidio.rst +++ b/doc/guides/nics/liquidio.rst @@ -190,7 +190,7 @@ Ring size Number of descriptors for Rx/Tx ring should be in the range 128 to 512. -CRC striping -~~~~~~~~~~~~ +CRC stripping +~~~~~~~~~~~~~ LiquidIO adapters strip ethernet FCS of every packet coming to the host interface. diff --git a/doc/guides/nics/octeontx.rst b/doc/guides/nics/octeontx.rst index 012a3ec21f2a..3c19c912db08 100644 --- a/doc/guides/nics/octeontx.rst +++ b/doc/guides/nics/octeontx.rst @@ -161,8 +161,8 @@ This driver will only work with ``octeontx_fpavf`` external mempool handler as it is the most performance effective way for packet allocation and Tx buffer recycling on OCTEON TX SoC platform. -CRC striping -~~~~~~~~~~~~ +CRC stripping +~~~~~~~~~~~~~ The OCTEON TX SoC family NICs strip the CRC for every packets coming into the host interface irrespective of the offload configuration. diff --git a/doc/guides/nics/octeontx2.rst b/doc/guides/nics/octeontx2.rst index 9a76567a8128..2693c3553f7a 100644 --- a/doc/guides/nics/octeontx2.rst +++ b/doc/guides/nics/octeontx2.rst @@ -187,8 +187,8 @@ The OCTEON TX2 SoC family NIC has inbuilt HW assisted external mempool manager. as it is performance wise most effective way for packet allocation and Tx buffer recycling on OCTEON TX2 SoC platform. -CRC striping -~~~~~~~~~~~~ +CRC stripping +~~~~~~~~~~~~~ The OCTEON TX2 SoC family NICs strip the CRC for every packet being received by the host interface irrespective of the offload configuration. diff --git a/doc/guides/nics/thunderx.rst b/doc/guides/nics/thunderx.rst index 53eaec72a796..3b75a9a9afb5 100644 --- a/doc/guides/nics/thunderx.rst +++ b/doc/guides/nics/thunderx.rst @@ -331,8 +331,8 @@ Example: Limitations ----------- -CRC striping -~~~~~~~~~~~~ +CRC stripping +~~~~~~~~~~~~~ The ThunderX SoC family NICs strip the CRC for every packets coming into the host interface irrespective of the offload configuration.