From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by dpdk.space (Postfix) with ESMTP id 85EE6A0679 for ; Wed, 3 Apr 2019 15:23:04 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id A4E161B44A; Wed, 3 Apr 2019 15:22:34 +0200 (CEST) Received: from mga09.intel.com (mga09.intel.com [134.134.136.24]) by dpdk.org (Postfix) with ESMTP id 3EDE71B441 for ; Wed, 3 Apr 2019 15:22:32 +0200 (CEST) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga006.fm.intel.com ([10.253.24.20]) by orsmga102.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 03 Apr 2019 06:22:31 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.60,304,1549958400"; d="scan'208";a="333410406" Received: from silpixa00372895.ir.intel.com (HELO silpixa00372895.ger.corp.intel.com) ([10.237.222.166]) by fmsmga006.fm.intel.com with ESMTP; 03 Apr 2019 06:22:28 -0700 From: John McNamara To: dev@dpdk.org Cc: John McNamara Date: Wed, 3 Apr 2019 14:26:36 +0100 Message-Id: <1554297996-16090-1-git-send-email-john.mcnamara@intel.com> X-Mailer: git-send-email 2.7.5 MIME-Version: 1.0 Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: 8bit Subject: [dpdk-dev] [PATCH v1] doc: fix spelling errors reported by aspell 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" Message-ID: <20190403132636.3p3EnYaku-7EG-kZm8CpdB1kAaFx1LlMQLjhxTaDg1k@z> Signed-off-by: John McNamara --- Some notes on this. It is probably best not to apply this patch until just before the release since it could potentially create a lot of conflicts. I'll resubmit a v2 prior to the 19.05 release. The fixes list is below. I didn't include them in the commit message since I don't think the effort of backporting is worth it. Fixes: a6531d58b415 ("compressdev: replace mbuf scatter gather flag") Fixes: 58abf6e77c6b ("doc: add contributors guide") Fixes: 3728e9ba7739 ("crypto/aesni_mb: support IPSec Multi-buffer lib v0.46") Fixes: 2717246ecd7d ("cryptodev: replace mbuf scatter gather flag") Fixes: 02545b6ca29a ("doc: update build instructions for qat PMDs") Fixes: 4c07e0552f0a ("crypto/scheduler: add multicore scheduling mode") Fixes: c7aa67f5a9e4 ("doc: add eventdev OPDL PMD guide") Fixes: 0857b9421138 ("doc: add event device and software eventdev") Fixes: 206b6ba882cf ("doc: add VF live migration howto with bonded virtio") Fixes: 6993fe1375c1 ("doc: add VM live migration howto with vhost-user") Fixes: 3e0ceb9f17ff ("doc: add basic howto for flow API") Fixes: 6e9270eab112 ("doc: add telemetry how-to") Fixes: 0ba3870e7559 ("doc: add guide to use virtio-user as exceptional path") Fixes: 6ef75e405d5a ("doc: add af_packet PMD guide") Fixes: 3d38e3dcf197 ("net/atlantic: implement Rx path") Fixes: 6c2809628cd5 ("net/cxgbe: improve latency for slow traffic") Fixes: cda260a4ac1a ("net/cxgbe: add option to keep outer VLAN tag in QinQ") Fixes: 0c504f6950b6 ("net/dpaa: support push mode") Fixes: 846a8305f277 ("doc: add DPAA2 NIC details") Fixes: 61e093398fbc ("doc: add instructions for WC in ENAv2") Fixes: 65313f1a822a ("doc: add guide for ENETC PMD") Fixes: 0543f9d24ae1 ("net/enic: flow API documentation") Fixes: 13e855a3b996 ("doc: add inline crypto feature") Fixes: 04c8542f96f7 ("net/i40e: set TC strict priority mode") Fixes: 621c5c1db2b1 ("doc: add ixgbe known issue with legacy interrrupt") Fixes: 75e2bc54c018 ("net/kni: add KNI PMD") Fixes: 2c0dd7b69fb0 ("config: add static linkage of mlx dependency") Fixes: 0280f2812284 ("doc: add mlx5 E-Switch VXLAN tunnels limitations") Fixes: 2c0dd7b69fb0 ("config: add static linkage of mlx dependency") Fixes: 7d6bf6b866b8 ("net/mlx5: add Multi-Packet Rx support") Fixes: 0ba610ca1d17 ("net/mvpp2: document MTR and TM usage") Fixes: 4b048f352c01 ("doc: clarify usage of netvsc PMD") Fixes: ef28aa96e53b ("net/nfp: support multiprocess") Fixes: c7cb2d7a5f2a ("net/sfc: add device configuration checks") Fixes: 8cb45c97d396 ("net/sfc: add unknown unicast/multicast match in flow API") Fixes: c22d3c508e0c ("net/sfc: support parameter to choose performance profile") Fixes: a5e1231f099b ("net/szedata2: do not affect Ethernet interfaces") Fixes: bcab6c1d27fa ("net/tap: allow user MAC to be passed as args") Fixes: ceccf8dc7c3d ("doc: create NXP DPAA platform guide") Fixes: b84c108742a9 ("doc: create NXP DPAA2 platform guide") Fixes: 4935e1e9f76e ("bbdev: introduce wireless base band device lib") Fixes: a584d3bea902 ("doc: add compressdev library guide") Fixes: 0318c02b57cf ("doc: add cryptodev chapter in prog guide") Fixes: c149818b0e51 ("doc: add note on multiple crypto vdevs") Fixes: 0318c02b57cf ("doc: add cryptodev chapter in prog guide") Fixes: 31850d26850e ("doc: add cryptodev sample code") Fixes: b9209dc21999 ("doc: add asymmetric crypto in programmer guide") Fixes: a5d7a3f77ddc ("unify tools naming") Fixes: 0dd62a01874a ("doc: add EFD library section in programmers guide") Fixes: b31739328354 ("doc: update guides for memory subsystem") Fixes: 3810ae435783 ("eventdev: add interrupt driven queues to Rx adapter") Fixes: c1eaab510dba ("eventdev: add callback for Rx adapter SW transfers") Fixes: 7358c91ffa85 ("doc: add eventdev library to programmers guide") Fixes: 50bdac5916d9 ("flow_classify: remove table id parameter from API") Fixes: fdec9301f52d ("doc: add flow classify guides") Fixes: 9ef6cb1a1583 ("doc: add IPsec library guide") Fixes: 89397a01ce4a ("kni: set default carrier state of interface") Fixes: 349950ddb9c5 ("metrics: add information metrics library") Fixes: 2ad7ba9a6567 ("bitrate: add bitrate statistics library") Fixes: 5cd3cac9ed22 ("latency: added new library for latency stats") Fixes: e22266669e86 ("doc: add IPC guide") Fixes: 9d5ba88c2d41 ("doc: add ARM profiling methods") Fixes: 7307cf6333ca ("ethdev: add raw encapsulation action") Fixes: 6f1c2168bccb ("ethdev: add generic TTL rewrite actions") Fixes: 40ff8c99ea99 ("doc: add details of security library") Fixes: e660897d8a0a ("doc: describe traffic management API") Fixes: 9ba1e744ab65 ("vhost: add a flag to enable dequeue zero copy") Fixes: ef1e8ede3da5 ("raw/ifpga: add Intel FPGA bus rawdev driver") Fixes: 86fa6c57a175 ("doc: add known igb_uio issue for i40e") Fixes: b667029e9096 ("doc: add Linux 4.10.0 known issue in release notes") Fixes: a32ca9a4ebc1 ("mk: fix scope of disabling AVX512F support") Fixes: c9b13d944088 ("doc: update release notes for 17.11") Fixes: 1ffee690eaa1 ("examples/bbdev: add sample app") Fixes: 1094ca96689c ("doc: add SW eventdev pipeline to sample app guide") Fixes: fdec9301f52d ("doc: add flow classify guides") Fixes: bef33b0a9d58 ("doc: add new introduction to sample app guides") Fixes: 71f2e9ba7d8c ("doc: update IP pipeline application guide") Fixes: ec17993a145a ("examples/ipsec-secgw: support security offload") Fixes: 02dc5b7d58c7 ("doc: update ipsec-secgw guide and release notes") Fixes: 4d1a771bd88d ("doc: add guide for performance-thread example") Fixes: 331ce43dc564 ("doc: add policer table details for metering application") Fixes: 474572d2ae5a ("app/pipeline: move from test directory") Fixes: a971c509a523 ("doc: update vhost sample guide") Fixes: e3075e969eff ("doc: add driver limitation for vhost dequeue zero copy") Fixes: db75c7af19bb ("examples/vhost_scsi: introduce a new sample app") Fixes: 50ac590ff826 ("doc: update VM power manager sample guide") Fixes: a63504a90f6a ("examples/power: add JSON string handling") Fixes: 50ac590ff826 ("doc: update VM power manager sample guide") Fixes: fb73e096110a ("app/testpmd: enable device hotplug monitoring") Fixes: 3c156061b938 ("app/testpmd: add noisy neighbour forwarding mode") Fixes: a67857e97ba8 ("doc: clarify usage of testpmd MAC forward mode") Fixes: 8d9d4c2428be ("app/testpmd: update softnic mode documentation") Fixes: c4e04283abee ("doc: fix literal block in testpmd guide") Fixes: 0aeb7077d171 ("doc: add 802.3ad modes in testpmd guide") Fixes: 5b590fbe09b6 ("app/testpmd: add traffic management forwarding mode") Fixes: 708d0bcb72c2 ("app/testpmd: add commands to modify TTL") Fixes: e977e4199a8d ("app/testpmd: add commands to load/unload BPF filters") Fixes: c6baca7adc94 ("doc: describe new performance test application") Fixes: 98a7ea332ba3 ("fix typos using codespell utility") Fixes: c6baca7adc94 ("doc: describe new performance test application") Fixes: 8a37f37fc243 ("app/procinfo: add --show-port") Fixes: c13e8984404a ("app/procinfo: add --show-ring") Fixes: bacf34762ac5 ("doc: update limitations in procinfo guide") Fixes: 8723590ec603 ("doc: update bbdev test app guide") doc/guides/compressdevs/overview.rst | 2 +- doc/guides/contributing/patches.rst | 2 +- doc/guides/cryptodevs/aesni_mb.rst | 2 +- doc/guides/cryptodevs/overview.rst | 2 +- doc/guides/cryptodevs/qat.rst | 2 +- doc/guides/cryptodevs/scheduler.rst | 2 +- doc/guides/eventdevs/opdl.rst | 4 +-- doc/guides/eventdevs/sw.rst | 4 +-- doc/guides/howto/lm_bond_virtio_sriov.rst | 2 +- doc/guides/howto/lm_virtio_vhost_user.rst | 4 +-- doc/guides/howto/rte_flow.rst | 6 ++--- doc/guides/howto/telemetry.rst | 2 +- .../howto/virtio_user_as_exceptional_path.rst | 8 +++--- doc/guides/nics/af_packet.rst | 4 +-- doc/guides/nics/atlantic.rst | 2 +- doc/guides/nics/cxgbe.rst | 4 +-- doc/guides/nics/dpaa.rst | 2 +- doc/guides/nics/dpaa2.rst | 2 +- doc/guides/nics/ena.rst | 2 +- doc/guides/nics/enetc.rst | 2 +- doc/guides/nics/enic.rst | 2 +- doc/guides/nics/features.rst | 2 +- doc/guides/nics/i40e.rst | 2 +- doc/guides/nics/ixgbe.rst | 4 +-- doc/guides/nics/kni.rst | 2 +- doc/guides/nics/mlx4.rst | 2 +- doc/guides/nics/mlx5.rst | 10 ++++---- doc/guides/nics/mvpp2.rst | 2 +- doc/guides/nics/netvsc.rst | 2 +- doc/guides/nics/nfp.rst | 4 +-- doc/guides/nics/sfc_efx.rst | 14 +++++----- doc/guides/nics/szedata2.rst | 2 +- doc/guides/nics/tap.rst | 2 +- doc/guides/platform/dpaa.rst | 4 +-- doc/guides/platform/dpaa2.rst | 4 +-- doc/guides/prog_guide/bbdev.rst | 4 +-- doc/guides/prog_guide/compressdev.rst | 6 ++--- doc/guides/prog_guide/cryptodev_lib.rst | 14 +++++----- doc/guides/prog_guide/dev_kit_build_system.rst | 2 +- doc/guides/prog_guide/efd_lib.rst | 2 +- doc/guides/prog_guide/env_abstraction_layer.rst | 2 +- .../prog_guide/event_ethernet_rx_adapter.rst | 6 ++--- doc/guides/prog_guide/eventdev.rst | 6 ++--- doc/guides/prog_guide/flow_classify_lib.rst | 12 ++++----- doc/guides/prog_guide/ipsec_lib.rst | 16 ++++++------ doc/guides/prog_guide/kernel_nic_interface.rst | 2 +- doc/guides/prog_guide/metrics_lib.rst | 12 ++++----- doc/guides/prog_guide/multi_proc_support.rst | 2 +- doc/guides/prog_guide/profile_app.rst | 4 +-- doc/guides/prog_guide/rte_flow.rst | 6 ++--- doc/guides/prog_guide/rte_security.rst | 20 +++++++-------- doc/guides/prog_guide/traffic_management.rst | 2 +- doc/guides/prog_guide/vhost_lib.rst | 2 +- doc/guides/rawdevs/ifpga_rawdev.rst | 2 +- doc/guides/rel_notes/known_issues.rst | 8 +++--- doc/guides/rel_notes/release_17_11.rst | 10 ++++---- doc/guides/sample_app_ug/bbdev_app.rst | 4 +-- doc/guides/sample_app_ug/eventdev_pipeline.rst | 2 +- doc/guides/sample_app_ug/flow_classify.rst | 8 +++--- doc/guides/sample_app_ug/intro.rst | 2 +- doc/guides/sample_app_ug/ip_pipeline.rst | 4 +-- doc/guides/sample_app_ug/ipsec_secgw.rst | 8 +++--- doc/guides/sample_app_ug/performance_thread.rst | 4 +-- doc/guides/sample_app_ug/qos_metering.rst | 2 +- doc/guides/sample_app_ug/test_pipeline.rst | 2 +- doc/guides/sample_app_ug/vhost.rst | 4 +-- doc/guides/sample_app_ug/vhost_scsi.rst | 2 +- doc/guides/sample_app_ug/vm_power_management.rst | 14 +++++----- doc/guides/testpmd_app_ug/run_app.rst | 10 ++++---- doc/guides/testpmd_app_ug/testpmd_funcs.rst | 30 +++++++++++----------- doc/guides/tools/cryptoperf.rst | 22 ++++++++-------- doc/guides/tools/proc_info.rst | 6 ++--- doc/guides/tools/testbbdev.rst | 2 +- 73 files changed, 192 insertions(+), 192 deletions(-) diff --git a/doc/guides/compressdevs/overview.rst b/doc/guides/compressdevs/overview.rst index 70bbe82..809e4e6 100644 --- a/doc/guides/compressdevs/overview.rst +++ b/doc/guides/compressdevs/overview.rst @@ -18,7 +18,7 @@ Supported Feature Flags without making any modifications to it (no compression done). - "OOP SGL In SGL Out" feature flag stands for - "Out-of-place Scatter-gather list Input, Scatter-gater list Output", + "Out-of-place Scatter-gather list Input, Scatter-gather list Output", which means PMD supports different scatter-gather styled input and output buffers (i.e. both can consists of multiple segments). diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst index d8404e6..3b2b174 100644 --- a/doc/guides/contributing/patches.rst +++ b/doc/guides/contributing/patches.rst @@ -8,7 +8,7 @@ Contributing Code to DPDK This document outlines the guidelines for submitting code to DPDK. -The DPDK development process is modelled (loosely) on the Linux Kernel development model so it is worth reading the +The DPDK development process is modeled (loosely) on the Linux Kernel development model so it is worth reading the Linux kernel guide on submitting patches: `How to Get Your Change Into the Linux Kernel `_. The rationale for many of the DPDK guidelines is explained in greater detail in the kernel guidelines. diff --git a/doc/guides/cryptodevs/aesni_mb.rst b/doc/guides/cryptodevs/aesni_mb.rst index 47f2ecc..b61802d 100644 --- a/doc/guides/cryptodevs/aesni_mb.rst +++ b/doc/guides/cryptodevs/aesni_mb.rst @@ -133,7 +133,7 @@ Extra notes For AES Counter mode (AES-CTR), the library supports two different sizes for Initialization Vector (IV): -* 12 bytes: used mainly for IPSec, as it requires 12 bytes from the user, which internally +* 12 bytes: used mainly for IPsec, as it requires 12 bytes from the user, which internally are appended the counter block (4 bytes), which is set to 1 for the first block (no padding required from the user) diff --git a/doc/guides/cryptodevs/overview.rst b/doc/guides/cryptodevs/overview.rst index 607e758..dd25b22 100644 --- a/doc/guides/cryptodevs/overview.rst +++ b/doc/guides/cryptodevs/overview.rst @@ -18,7 +18,7 @@ Supported Feature Flags being the operation in-place (input address = output address). - "OOP SGL In SGL Out" feature flag stands for - "Out-of-place Scatter-gather list Input, Scatter-gater list Output", + "Out-of-place Scatter-gather list Input, Scatter-gather list Output", which means pmd supports different scatter-gather styled input and output buffers (i.e. both can consists of multiple segments). diff --git a/doc/guides/cryptodevs/qat.rst b/doc/guides/cryptodevs/qat.rst index da9655c..651bf38 100644 --- a/doc/guides/cryptodevs/qat.rst +++ b/doc/guides/cryptodevs/qat.rst @@ -225,7 +225,7 @@ Dependency on the QAT kernel driver ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ To use QAT an SRIOV-enabled QAT kernel driver is required. The VF -devices created and initialised by this driver will be used by the QAT PMDs. +devices created and initialized by this driver will be used by the QAT PMDs. Instructions for installation are below, but first an explanation of the relationships between the PF/VF devices and the PMDs visible to diff --git a/doc/guides/cryptodevs/scheduler.rst b/doc/guides/cryptodevs/scheduler.rst index a754a27..7004ca4 100644 --- a/doc/guides/cryptodevs/scheduler.rst +++ b/doc/guides/cryptodevs/scheduler.rst @@ -165,7 +165,7 @@ operation: For pure small packet size (64 bytes) traffic however the multi-core mode is not an optimal solution, as it doesn't give significant per-core performance improvement. For mixed traffic (IMIX) the optimal number of worker cores is around 2-3. - For large packets (1.5 Kbytes) scheduler shows linear scaling in performance + For large packets (1.5 kbytes) scheduler shows linear scaling in performance up to eight cores. Each worker uses its own slave cryptodev. Only software cryptodevs are supported. Only the same type of cryptodevs should be used concurrently. diff --git a/doc/guides/eventdevs/opdl.rst b/doc/guides/eventdevs/opdl.rst index 0262a33..8334ba5 100644 --- a/doc/guides/eventdevs/opdl.rst +++ b/doc/guides/eventdevs/opdl.rst @@ -8,7 +8,7 @@ The OPDL (Ordered Packet Distribution Library) eventdev is a specific\ implementation of the eventdev API. It is particularly suited to packet\ processing workloads that have high throughput and low latency requirements.\ All packets follow the same path through the device. The order in which\ -packets follow is determinted by the order in which queues are set up.\ +packets follow is determined by the order in which queues are set up.\ Events are left on the ring until they are transmitted. As a result packets\ do not go out of order @@ -61,7 +61,7 @@ Queue Dependencies As stated the order in which packets travel through queues is static in nature. They go through the queues in the order the queues are setup at -initialisation ``rte_event_queue_setup()``. For example if an application +initialization ``rte_event_queue_setup()``. For example if an application sets up 3 queues, Q0, Q1, Q2 and has 3 associated ports P0, P1, P2 and P3 then packets must be diff --git a/doc/guides/eventdevs/sw.rst b/doc/guides/eventdevs/sw.rst index afdcad7..04c8b03 100644 --- a/doc/guides/eventdevs/sw.rst +++ b/doc/guides/eventdevs/sw.rst @@ -70,7 +70,7 @@ Credit Quanta The credit quanta is the number of credits that a port will fetch at a time from the instance's credit pool. Higher numbers will cause less overhead in the atomic credit fetch code, however it also reduces the overall number of credits -in the system faster. A balanced number (eg 32) ensures that only small numbers +in the system faster. A balanced number (e.g. 32) ensures that only small numbers of credits are pre-allocated at a time, while also mitigating performance impact of the atomics. @@ -100,7 +100,7 @@ feature would be significant. ~~~~~~~~~~~~~~~~~~ The software eventdev does not support creating queues that handle all types of -traffic. An eventdev with this capability allows enqueueing Atomic, Ordered and +traffic. An eventdev with this capability allows enqueuing Atomic, Ordered and Parallel traffic to the same queue, but scheduling each of them appropriately. The reason to not allow Atomic, Ordered and Parallel event types in the diff --git a/doc/guides/howto/lm_bond_virtio_sriov.rst b/doc/guides/howto/lm_bond_virtio_sriov.rst index ee8ccda..07563b3 100644 --- a/doc/guides/howto/lm_bond_virtio_sriov.rst +++ b/doc/guides/howto/lm_bond_virtio_sriov.rst @@ -328,7 +328,7 @@ On host_server_2: Terminal 1 .. code-block:: console - testomd> show port info all + testpmd> show port info all testpmd> show port stats all testpmd> show bonding config 2 testpmd> port attach 0000:00:04.0 diff --git a/doc/guides/howto/lm_virtio_vhost_user.rst b/doc/guides/howto/lm_virtio_vhost_user.rst index 6ebc10f..ecb7832 100644 --- a/doc/guides/howto/lm_virtio_vhost_user.rst +++ b/doc/guides/howto/lm_virtio_vhost_user.rst @@ -243,7 +243,7 @@ On host_server_2: Terminal 1 .. code-block:: console - testomd> show port info all + testpmd> show port info all testpmd> show port stats all Virtio traffic is seen at P0 and P1. @@ -338,7 +338,7 @@ reset_vf_on_212_131.sh #!/bin/sh # This script is run on the host 10.237.212.131 to reset SRIOV - # BDF for Ninatic NIC is 0000:06:00.0 + # BDF for Niantic NIC is 0000:06:00.0 cat /sys/bus/pci/devices/0000\:06\:00.0/max_vfs echo 0 > /sys/bus/pci/devices/0000\:06\:00.0/max_vfs cat /sys/bus/pci/devices/0000\:06\:00.0/max_vfs diff --git a/doc/guides/howto/rte_flow.rst b/doc/guides/howto/rte_flow.rst index 3dcda6c..e197376 100644 --- a/doc/guides/howto/rte_flow.rst +++ b/doc/guides/howto/rte_flow.rst @@ -23,7 +23,7 @@ In this example we will create a simple rule that drops packets whose IPv4 destination equals 192.168.3.2. This code is equivalent to the following testpmd command (wrapped for clarity):: - tpmd> flow create 0 ingress pattern eth / vlan / + testpmd> flow create 0 ingress pattern eth / vlan / ipv4 dst is 192.168.3.2 / end actions drop / end Code @@ -118,7 +118,7 @@ a mask. This code is equivalent to the following testpmd command (wrapped for clarity):: - tpmd> flow create 0 ingress pattern eth / vlan / + testpmd> flow create 0 ingress pattern eth / vlan / ipv4 dst spec 192.168.3.0 dst mask 255.255.255.0 / end actions drop / end @@ -219,7 +219,7 @@ In this example we will create a rule that routes all vlan id 123 to queue 3. This code is equivalent to the following testpmd command (wrapped for clarity):: - tpmd> flow create 0 ingress pattern eth / vlan vid spec 123 / + testpmd> flow create 0 ingress pattern eth / vlan vid spec 123 / end actions queue index 3 / end Code diff --git a/doc/guides/howto/telemetry.rst b/doc/guides/howto/telemetry.rst index 00f8f7a..e10804d 100644 --- a/doc/guides/howto/telemetry.rst +++ b/doc/guides/howto/telemetry.rst @@ -18,7 +18,7 @@ which acts as the client. In DPDK, applications are used to initialize the ``telemetry``. To view incoming traffic on featured ports, the application should be run first (ie. after ports are configured). Once the application is running, the service assurance agent -(for example the collectd plugin) should be run to begin querying the API. +(for example the CollectD plugin) should be run to begin querying the API. A client connects their Service Assurance application to the DPDK application via a UNIX socket. Once a connection is established, a client can send JSON diff --git a/doc/guides/howto/virtio_user_as_exceptional_path.rst b/doc/guides/howto/virtio_user_as_exceptional_path.rst index 4910c12..ec021af 100644 --- a/doc/guides/howto/virtio_user_as_exceptional_path.rst +++ b/doc/guides/howto/virtio_user_as_exceptional_path.rst @@ -1,7 +1,7 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright(c) 2016 Intel Corporation. -.. _virtio_user_as_excpetional_path: +.. _virtio_user_as_exceptional_path: Virtio_user as Exceptional Path =============================== @@ -22,7 +22,7 @@ solution is very promising in: * Features vhost-net is born to be a networking solution, which has lots of networking - related featuers, like multi queue, tso, multi-seg mbuf, etc. + related features, like multi queue, tso, multi-seg mbuf, etc. * Performance @@ -38,7 +38,7 @@ in :numref:`figure_virtio_user_as_exceptional_path`. .. figure:: img/virtio_user_as_exceptional_path.* - Overview of a DPDK app using virtio-user as excpetional path + Overview of a DPDK app using virtio-user as exceptional path Sample Usage @@ -75,7 +75,7 @@ compiling the kernel and those kernel modules should be inserted. * ``queues`` - Number of multi-queues. Each qeueue will be served by a kthread. For example: + Number of multi-queues. Each queue will be served by a kthread. For example: .. code-block:: console diff --git a/doc/guides/nics/af_packet.rst b/doc/guides/nics/af_packet.rst index 1260bb2..efd6f1c 100644 --- a/doc/guides/nics/af_packet.rst +++ b/doc/guides/nics/af_packet.rst @@ -13,13 +13,13 @@ PACKET_MMAP, which provides a mmap'ed ring buffer, shared between user space and kernel, that's used to send and receive packets. This helps reducing system calls and the copies needed between user space and Kernel. -The PACKET_FANOUT_HASH behaviour of AF_PACKET is used for frame reception. +The PACKET_FANOUT_HASH behavior of AF_PACKET is used for frame reception. Options and inherent limitations -------------------------------- The following options can be provided to set up an af_packet port in DPDK. -Some of these, in turn, will be used to configure the PAKET_MMAP settings. +Some of these, in turn, will be used to configure the PACKET_MMAP settings. * ``iface`` - name of the Kernel interface to attach to (required); * ``qpairs`` - number of Rx and Tx queues (optional, default 1); diff --git a/doc/guides/nics/atlantic.rst b/doc/guides/nics/atlantic.rst index 80591b1..f6f2c66 100644 --- a/doc/guides/nics/atlantic.rst +++ b/doc/guides/nics/atlantic.rst @@ -18,7 +18,7 @@ Supported features - Port statistics - RSS (Receive Side Scaling) - Checksum offload -- Jumbo Frame upto 16K +- Jumbo Frame up to 16K Configuration Information ^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/guides/nics/cxgbe.rst b/doc/guides/nics/cxgbe.rst index f3e6115..7a893cc 100644 --- a/doc/guides/nics/cxgbe.rst +++ b/doc/guides/nics/cxgbe.rst @@ -126,7 +126,7 @@ enabling debugging options may affect system performance. - ``CONFIG_RTE_LIBRTE_CXGBE_TPUT`` (default **y**) - Toggle behaviour to prefer Throughput or Latency. + Toggle behavior to prefer Throughput or Latency. Runtime Options ~~~~~~~~~~~~~~~ @@ -140,7 +140,7 @@ be passed as part of EAL arguments. For example, - ``keep_ovlan`` (default **0**) - Toggle behaviour to keep/strip outer VLAN in Q-in-Q packets. If + Toggle behavior to keep/strip outer VLAN in Q-in-Q packets. If enabled, the outer VLAN tag is preserved in Q-in-Q packets. Otherwise, the outer VLAN tag is stripped in Q-in-Q packets. diff --git a/doc/guides/nics/dpaa.rst b/doc/guides/nics/dpaa.rst index fb7bc7d..2243a4a 100644 --- a/doc/guides/nics/dpaa.rst +++ b/doc/guides/nics/dpaa.rst @@ -251,7 +251,7 @@ state during application initialization: automatically be assigned from the these high perf PUSH queues. Any queue configuration beyond that will be standard Rx queues. The application can choose to change their number if HW portals are limited. - The valid values are from '0' to '4'. The valuse shall be set to '0' if the + The valid values are from '0' to '4'. The values shall be set to '0' if the application want to use eventdev with DPAA device. diff --git a/doc/guides/nics/dpaa2.rst b/doc/guides/nics/dpaa2.rst index 392ab05..a532d08 100644 --- a/doc/guides/nics/dpaa2.rst +++ b/doc/guides/nics/dpaa2.rst @@ -379,7 +379,7 @@ active -- Ethernet, crypto, compression, etc. DPBP based Mempool driver ~~~~~~~~~~~~~~~~~~~~~~~~~ -The DPBP driver is bound to a DPBP objects and provides sevices to +The DPBP driver is bound to a DPBP objects and provides services to create a hardware offloaded packet buffer mempool. DPAA2 NIC Driver diff --git a/doc/guides/nics/ena.rst b/doc/guides/nics/ena.rst index 80da4b6..d44f3cd 100644 --- a/doc/guides/nics/ena.rst +++ b/doc/guides/nics/ena.rst @@ -189,7 +189,7 @@ Prerequisites reduces the latency of the packets by pushing the header directly through the PCI to the device, before the DMA is even triggered. For proper work kernel PCI driver must support write combining (WC). In mainline version of - ``igb_uio`` (in DPDK repo) it must be enabled by loding module with + ``igb_uio`` (in DPDK repo) it must be enabled by loading module with ``wc_activate=1`` flag (example below). However, mainline's vfio-pci driver in kernel doesn't have WC support yet (planed to be added). If vfio-pci used user should be either turn off ENAv2 (to avoid performance diff --git a/doc/guides/nics/enetc.rst b/doc/guides/nics/enetc.rst index 8038bf2..376768d 100644 --- a/doc/guides/nics/enetc.rst +++ b/doc/guides/nics/enetc.rst @@ -69,7 +69,7 @@ Supported ENETC SoCs Prerequisites ~~~~~~~~~~~~~ -There are three main pre-requisities for executing ENETC PMD on a ENETC +There are three main pre-requisites for executing ENETC PMD on a ENETC compatible board: 1. **ARM 64 Tool Chain** diff --git a/doc/guides/nics/enic.rst b/doc/guides/nics/enic.rst index 726a69e..cdb55e0 100644 --- a/doc/guides/nics/enic.rst +++ b/doc/guides/nics/enic.rst @@ -224,7 +224,7 @@ the use of SR-IOV. passthrough devices do not require libvirt, port profiles, and VM-FEX. -.. _enic-genic-flow-api: +.. _enic-generic-flow-api: Generic Flow API support ------------------------ diff --git a/doc/guides/nics/features.rst b/doc/guides/nics/features.rst index c5bf322..d57ddc2 100644 --- a/doc/guides/nics/features.rst +++ b/doc/guides/nics/features.rst @@ -495,7 +495,7 @@ Supports adding traffic mirroring rules. Inline crypto ------------- -Supports inline crypto processing (eg. inline IPsec). See Security library and PMD documentation for more details. +Supports inline crypto processing (e.g. inline IPsec). See Security library and PMD documentation for more details. * **[uses] rte_eth_rxconf,rte_eth_rxmode**: ``offloads:DEV_RX_OFFLOAD_SECURITY``, * **[uses] rte_eth_txconf,rte_eth_txmode**: ``offloads:DEV_TX_OFFLOAD_SECURITY``. diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst index 9680a92..2e9ec79 100644 --- a/doc/guides/nics/i40e.rst +++ b/doc/guides/nics/i40e.rst @@ -580,7 +580,7 @@ bandwidth setting. TC TX scheduling mode setting ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -There're 2 TX scheduling modes for TCs, round robin and strict priority mode. +There are 2 TX scheduling modes for TCs, round robin and strict priority mode. If a TC is set to strict priority mode, it can consume unlimited bandwidth. It means if APP has set the max bandwidth for that TC, it comes to no effect. diff --git a/doc/guides/nics/ixgbe.rst b/doc/guides/nics/ixgbe.rst index 1c294b0..975143f 100644 --- a/doc/guides/nics/ixgbe.rst +++ b/doc/guides/nics/ixgbe.rst @@ -203,8 +203,8 @@ as a workaround. X550 does not support legacy interrupt mode ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Desccription -^^^^^^^^^^^^ +Description +^^^^^^^^^^^ X550 cannot get interrupts if using ``uio_pci_generic`` module or using legacy interrupt mode of ``igb_uio`` or ``vfio``. Because the errata of X550 states that the Interrupt Status bit is not implemented. The errata is the item #22 diff --git a/doc/guides/nics/kni.rst b/doc/guides/nics/kni.rst index a66c595..602a06b 100644 --- a/doc/guides/nics/kni.rst +++ b/doc/guides/nics/kni.rst @@ -65,7 +65,7 @@ backend device by default. PMD arguments ------------- -``no_request_thread``, by default PMD creates a phtread for each KNI interface +``no_request_thread``, by default PMD creates a pthread for each KNI interface to handle Linux network interface control commands, like ``ifconfig kni0 up`` With ``no_request_thread`` option, pthread is not created and control commands diff --git a/doc/guides/nics/mlx4.rst b/doc/guides/nics/mlx4.rst index 4ad361a..28e3666 100644 --- a/doc/guides/nics/mlx4.rst +++ b/doc/guides/nics/mlx4.rst @@ -83,7 +83,7 @@ These options can be modified in the ``.config`` file. - ``CONFIG_RTE_IBVERBS_LINK_STATIC`` (default **n**) - Embed static flavour of the dependencies **libibverbs** and **libmlx4** + Embed static flavor of the dependencies **libibverbs** and **libmlx4** in the PMD shared library or the executable static binary. - ``CONFIG_RTE_LIBRTE_MLX4_DEBUG`` (default **n**) diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst index 0200373..3f3226a 100644 --- a/doc/guides/nics/mlx5.rst +++ b/doc/guides/nics/mlx5.rst @@ -149,7 +149,7 @@ Limitations - E-Switch VXLAN decapsulation Flow: - - can be appiled to PF port only. + - can be applied to PF port only. - must specify VF port action (packet redirection from PF to VF). - must specify tunnel outer UDP local (destination) port, wildcards not allowed. - must specify tunnel outer VNI, wildcards not allowed. @@ -164,7 +164,7 @@ Limitations - must specify the VXLAN item with tunnel outer parameters. - must specify the tunnel outer VNI in the VXLAN item. - must specify the tunnel outer remote (destination) UDP port in the VXLAN item. - - must specify the tunnel outer local (source) IPv4 or IPv6 in the , this address will locally (with scope link) assigned to the outer network interace, wildcards not allowed. + - must specify the tunnel outer local (source) IPv4 or IPv6 in the , this address will locally (with scope link) assigned to the outer network interface, wildcards not allowed. - must specify the tunnel outer remote (destination) IPv4 or IPv6 in the VXLAN item, group IPs allowed. - must specify the tunnel outer destination MAC address in the VXLAN item, this address will be used to create neigh rule. @@ -212,7 +212,7 @@ These options can be modified in the ``.config`` file. - ``CONFIG_RTE_IBVERBS_LINK_STATIC`` (default **n**) - Embed static flavour of the dependencies **libibverbs** and **libmlx5** + Embed static flavor of the dependencies **libibverbs** and **libmlx5** in the PMD shared library or the executable static binary. - ``CONFIG_RTE_LIBRTE_MLX5_DEBUG`` (default **n**) @@ -319,7 +319,7 @@ Run-time configuration buffers per a packet, one large buffer is posted in order to receive multiple packets on the buffer. A MPRQ buffer consists of multiple fixed-size strides and each stride receives one packet. MPRQ can improve throughput for - small-packet tarffic. + small-packet traffic. When MPRQ is enabled, max_rx_pkt_len can be larger than the size of user-provided mbuf even if DEV_RX_OFFLOAD_SCATTER isn't enabled. PMD will @@ -330,7 +330,7 @@ Run-time configuration - ``mprq_log_stride_num`` parameter [int] Log 2 of the number of strides for Multi-Packet Rx queue. Configuring more - strides can reduce PCIe tarffic further. If configured value is not in the + strides can reduce PCIe traffic further. If configured value is not in the range of device capability, the default value will be set with a warning message. The default value is 4 which is 16 strides per a buffer, valid only if ``mprq_en`` is set. diff --git a/doc/guides/nics/mvpp2.rst b/doc/guides/nics/mvpp2.rst index 09e2f2a..bacc013 100644 --- a/doc/guides/nics/mvpp2.rst +++ b/doc/guides/nics/mvpp2.rst @@ -91,7 +91,7 @@ Limitations chance to start in a sane state. - MUSDK architecture does not support changing configuration in run time. - All nessesary configurations should be done before first dev_start(). + All necessary configurations should be done before first dev_start(). - RX queue start/stop is not supported. diff --git a/doc/guides/nics/netvsc.rst b/doc/guides/nics/netvsc.rst index 87fabf5..6dbb9a5 100644 --- a/doc/guides/nics/netvsc.rst +++ b/doc/guides/nics/netvsc.rst @@ -89,7 +89,7 @@ operations: .. Note:: - The dpkd-devbind.py script can not be used since it only handles PCI devices. + The dpdk-devbind.py script can not be used since it only handles PCI devices. Prerequisites diff --git a/doc/guides/nics/nfp.rst b/doc/guides/nics/nfp.rst index 09a8529..309fa5d 100644 --- a/doc/guides/nics/nfp.rst +++ b/doc/guides/nics/nfp.rst @@ -149,8 +149,8 @@ PF multiprocess support ----------------------- Due to how the driver needs to access the NFP through a CPP interface, which implies -to use specific registers inside the chip, the number of secondary proceses with PF -ports is limitted to only one. +to use specific registers inside the chip, the number of secondary processes with PF +ports is limited to only one. This limitation will be solved in future versions but having basic multiprocess support is important for allowing development and debugging through the PF using a secondary diff --git a/doc/guides/nics/sfc_efx.rst b/doc/guides/nics/sfc_efx.rst index 028c92c..d8512fa 100644 --- a/doc/guides/nics/sfc_efx.rst +++ b/doc/guides/nics/sfc_efx.rst @@ -96,7 +96,7 @@ Non-supported Features The features not yet supported include: -- Receive queue interupts +- Receive queue interrupts - Priority-based flow control @@ -209,12 +209,12 @@ Validating flow rules depends on the firmware variant. The :ref:`flow_isolated_mode` is supported. -Ethernet destinaton individual/group match -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Ethernet destination individual/group match +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Ethernet item supports I/G matching, if only the corresponding bit is set -in the mask of destination address. If destinaton address in the spec is -multicast, it matches all multicast (and broadcast) packets, oherwise it +in the mask of destination address. If destination address in the spec is +multicast, it matches all multicast (and broadcast) packets, otherwise it matches unicast packets that are not filtered by other flow rules. Exceptions to flow rules @@ -348,10 +348,10 @@ boolean parameters value. - ``perf_profile`` [auto|throughput|low-latency] (default **throughput**) - Choose hardware tunning to be optimized for either throughput or + Choose hardware tuning to be optimized for either throughput or low-latency. **auto** allows NIC firmware to make a choice based on - installed licences and firmware variant configured using **sfboot**. + installed licenses and firmware variant configured using **sfboot**. - ``stats_update_period_ms`` [long] (default **1000**) diff --git a/doc/guides/nics/szedata2.rst b/doc/guides/nics/szedata2.rst index a2092f9..94dba82 100644 --- a/doc/guides/nics/szedata2.rst +++ b/doc/guides/nics/szedata2.rst @@ -89,7 +89,7 @@ The NFB cards are multi-port multi-queue cards, where (generally) data from any Ethernet port may be sent to any queue. They were historically represented in DPDK as a single port. -However, the new NFB-200G2QL card employs an addon cable which allows to connect +However, the new NFB-200G2QL card employs an add-on cable which allows to connect it to two physical PCI-E slots at the same time (see the diagram below). This is done to allow 200 Gbps of traffic to be transferred through the PCI-E bus (note that a single PCI-E 3.0 x16 slot provides only 125 Gbps theoretical diff --git a/doc/guides/nics/tap.rst b/doc/guides/nics/tap.rst index 063bd0b..4b6d77d 100644 --- a/doc/guides/nics/tap.rst +++ b/doc/guides/nics/tap.rst @@ -40,7 +40,7 @@ actual MAC address: ``00:64:74:61:70:[00-FF]``. --vdev=net_tap0,mac="00:64:74:61:70:11" The MAC address will have a user value passed as string. The MAC address is in -format with delimeter ``:``. The string is byte converted to hex and you get +format with delimiter ``:``. The string is byte converted to hex and you get the actual MAC address: ``00:64:74:61:70:11``. It is possible to specify a remote netdevice to capture packets from by adding diff --git a/doc/guides/platform/dpaa.rst b/doc/guides/platform/dpaa.rst index 3904871..6005f22 100644 --- a/doc/guides/platform/dpaa.rst +++ b/doc/guides/platform/dpaa.rst @@ -4,7 +4,7 @@ NXP QorIQ DPAA Board Support Package ==================================== -This doc has information about steps to setup QorIq dpaa +This doc has information about steps to setup QorIQ dpaa based layerscape platform and information about common offload hw block drivers of **NXP QorIQ DPAA** SoC family. @@ -38,7 +38,7 @@ Common Offload HW Block Drivers Steps To Setup Platform ----------------------- -There are four main pre-requisities for executing DPAA PMD on a DPAA +There are four main pre-requisites for executing DPAA PMD on a DPAA compatible board: 1. **ARM 64 Tool Chain** diff --git a/doc/guides/platform/dpaa2.rst b/doc/guides/platform/dpaa2.rst index 5a64406..2586af0 100644 --- a/doc/guides/platform/dpaa2.rst +++ b/doc/guides/platform/dpaa2.rst @@ -4,7 +4,7 @@ NXP QorIQ DPAA2 Board Support Package ===================================== -This doc has information about steps to setup NXP QoriQ DPAA2 platform +This doc has information about steps to setup NXP QorIQ DPAA2 platform and information about common offload hw block drivers of **NXP QorIQ DPAA2** SoC family. @@ -48,7 +48,7 @@ Common Offload HW Block Drivers Steps To Setup Platform ----------------------- -There are four main pre-requisities for executing DPAA2 PMD on a DPAA2 +There are four main pre-requisites for executing DPAA2 PMD on a DPAA2 compatible board: 1. **ARM 64 Tool Chain** diff --git a/doc/guides/prog_guide/bbdev.rst b/doc/guides/prog_guide/bbdev.rst index 9de1444..658ffd4 100644 --- a/doc/guides/prog_guide/bbdev.rst +++ b/doc/guides/prog_guide/bbdev.rst @@ -78,7 +78,7 @@ From the application point of view, each instance of a bbdev device consists of one or more queues identified by queue IDs. While different devices may have different capabilities (e.g. support different operation types), all queues on a device support identical configuration possibilities. A queue is configured -for only one type of operation and is configured at initializations time. +for only one type of operation and is configured at initialization time. When an operation is enqueued to a specific queue ID, the result is dequeued from the same queue ID. @@ -678,7 +678,7 @@ bbdev framework, by giving a sample code performing a loop-back operation with a baseband processor capable of transceiving data packets. The following sample C-like pseudo-code shows the basic steps to encode several -buffers using (**sw_trubo**) bbdev PMD. +buffers using (**sw_turbo**) bbdev PMD. .. code-block:: c diff --git a/doc/guides/prog_guide/compressdev.rst b/doc/guides/prog_guide/compressdev.rst index ad97037..a06c835 100644 --- a/doc/guides/prog_guide/compressdev.rst +++ b/doc/guides/prog_guide/compressdev.rst @@ -17,7 +17,7 @@ Device Creation Physical compression devices are discovered during the bus probe of the EAL function which is executed at DPDK initialization, based on their unique device identifier. -For eg. PCI devices can be identified using PCI BDF (bus/bridge, device, function). +For e.g. PCI devices can be identified using PCI BDF (bus/bridge, device, function). Specific physical compression devices, like other physical devices in DPDK can be white-listed or black-listed using the EAL command line options. @@ -379,7 +379,7 @@ using priv_xform would look like: setup op->m_src and op->m_dst; } num_enqd = rte_compressdev_enqueue_burst(cdev_id, 0, comp_ops, NUM_OPS); - /* wait for this to complete before enqueing next*/ + /* wait for this to complete before enqueuing next*/ do { num_deque = rte_compressdev_dequeue_burst(cdev_id, 0 , &processed_ops, NUM_OPS); } while (num_dqud < num_enqd); @@ -526,7 +526,7 @@ An example pseudocode to set up and process a stream having NUM_CHUNKS with each op->src.length = CHUNK_LEN; op->input_chksum = 0; num_enqd = rte_compressdev_enqueue_burst(cdev_id, 0, &op[i], 1); - /* wait for this to complete before enqueing next*/ + /* wait for this to complete before enqueuing next*/ do { num_deqd = rte_compressdev_dequeue_burst(cdev_id, 0 , &processed_ops, 1); } while (num_deqd < num_enqd); diff --git a/doc/guides/prog_guide/cryptodev_lib.rst b/doc/guides/prog_guide/cryptodev_lib.rst index 74a930b..dae40fb 100644 --- a/doc/guides/prog_guide/cryptodev_lib.rst +++ b/doc/guides/prog_guide/cryptodev_lib.rst @@ -14,7 +14,7 @@ and AEAD symmetric and asymmetric Crypto operations. Design Principles ----------------- -The cryptodev library follows the same basic principles as those used in DPDKs +The cryptodev library follows the same basic principles as those used in DPDK's Ethernet Device framework. The Crypto framework provides a generic Crypto device framework which supports both physical (hardware) and virtual (software) Crypto devices as well as a generic Crypto API which allows Crypto devices to be @@ -48,7 +48,7 @@ From the command line using the --vdev EAL option * If DPDK application requires multiple software crypto PMD devices then required number of ``--vdev`` with appropriate libraries are to be added. - * An Application with crypto PMD instaces sharing the same library requires unique ID. + * An Application with crypto PMD instances sharing the same library requires unique ID. Example: ``--vdev 'crypto_aesni_mb0' --vdev 'crypto_aesni_mb1'`` @@ -396,7 +396,7 @@ Operation Management and Allocation The cryptodev library provides an API set for managing Crypto operations which utilize the Mempool Library to allocate operation buffers. Therefore, it ensures -that the crytpo operation is interleaved optimally across the channels and +that the crypto operation is interleaved optimally across the channels and ranks for optimal processing. A ``rte_crypto_op`` contains a field indicating the pool that it originated from. When calling ``rte_crypto_op_free(op)``, the operation returns to its original pool. @@ -549,7 +549,7 @@ chain. union { struct rte_cryptodev_sym_session *session; - /**< Handle for the initialised session context */ + /**< Handle for the initialized session context */ struct rte_crypto_sym_xform *xform; /**< Session-less API Crypto operation parameters */ }; @@ -602,7 +602,7 @@ Sample code There are various sample applications that show how to use the cryptodev library, such as the L2fwd with Crypto sample application (L2fwd-crypto) and -the IPSec Security Gateway application (ipsec-secgw). +the IPsec Security Gateway application (ipsec-secgw). While these applications demonstrate how an application can be created to perform generic crypto operation, the required complexity hides the basic steps of @@ -807,7 +807,7 @@ using one of the crypto PMDs available in DPDK. /* * Dequeue the crypto operations until all the operations - * are proccessed in the crypto device. + * are processed in the crypto device. */ uint16_t num_dequeued_ops, total_num_dequeued_ops = 0; do { @@ -886,7 +886,7 @@ the order in which the transforms are passed indicates the order of the chaining Not all asymmetric crypto xforms are supported for chaining. Currently supported asymmetric crypto chaining is Diffie-Hellman private key generation followed by public generation. Also, currently API does not support chaining of symmetric and -asymmetric crypto xfroms. +asymmetric crypto xforms. Each xform defines specific asymmetric crypto algo. Currently supported are: * RSA diff --git a/doc/guides/prog_guide/dev_kit_build_system.rst b/doc/guides/prog_guide/dev_kit_build_system.rst index 96dbf30..74dba4d 100644 --- a/doc/guides/prog_guide/dev_kit_build_system.rst +++ b/doc/guides/prog_guide/dev_kit_build_system.rst @@ -204,7 +204,7 @@ Creates the following symbol: Which ``dpdk-pmdinfogen`` scans for. Using this information other relevant bits of data can be exported from the object file and used to produce a hardware support description, that ``dpdk-pmdinfogen`` then encodes into a -json formatted string in the following format: +JSON formatted string in the following format: .. code-block:: c diff --git a/doc/guides/prog_guide/efd_lib.rst b/doc/guides/prog_guide/efd_lib.rst index cb1a1df..2b355ff 100644 --- a/doc/guides/prog_guide/efd_lib.rst +++ b/doc/guides/prog_guide/efd_lib.rst @@ -423,6 +423,6 @@ References 1- EFD is based on collaborative research work between Intel and Carnegie Mellon University (CMU), interested readers can refer to the paper -“Scaling Up Clustered Network Appliances with ScaleBricks;” Dong Zhou et al. +"Scaling Up Clustered Network Appliances with ScaleBricks" Dong Zhou et al. at SIGCOMM 2015 (`http://conferences.sigcomm.org/sigcomm/2015/pdf/papers/p241.pdf`) for more information. diff --git a/doc/guides/prog_guide/env_abstraction_layer.rst b/doc/guides/prog_guide/env_abstraction_layer.rst index c134636..a8ae214 100644 --- a/doc/guides/prog_guide/env_abstraction_layer.rst +++ b/doc/guides/prog_guide/env_abstraction_layer.rst @@ -705,7 +705,7 @@ The most important fields in the structure and how they are used are described b Malloc heap is a doubly-linked list, where each element keeps track of its previous and next elements. Due to the fact that hugepage memory can come and -go, neighbouring malloc elements may not necessarily be adjacent in memory. +go, neighboring malloc elements may not necessarily be adjacent in memory. Also, since a malloc element may span multiple pages, its contents may not necessarily be IOVA-contiguous either - each malloc element is only guaranteed to be virtually contiguous. diff --git a/doc/guides/prog_guide/event_ethernet_rx_adapter.rst b/doc/guides/prog_guide/event_ethernet_rx_adapter.rst index e955299..c7dda92 100644 --- a/doc/guides/prog_guide/event_ethernet_rx_adapter.rst +++ b/doc/guides/prog_guide/event_ethernet_rx_adapter.rst @@ -162,7 +162,7 @@ The servicing_weight member of struct rte_event_eth_rx_adapter_queue_conf is applicable when the adapter uses a service core function. The application has to enable Rx queue interrupts when configuring the ethernet device using the ``rte_eth_dev_configure()`` function and then use a servicing_weight -of zero when addding the Rx queue to the adapter. +of zero when adding the Rx queue to the adapter. The adapter creates a thread blocked on the interrupt, on an interrupt this thread enqueues the port id and the queue id to a ring buffer. The adapter @@ -180,9 +180,9 @@ Rx Callback for SW Rx Adapter For SW based packet transfers, i.e., when the ``RTE_EVENT_ETH_RX_ADAPTER_CAP_INTERNAL_PORT`` is not set in the adapter's capabilities flags for a particular ethernet device, the service function -temporarily enqueues mbufs to an event buffer before batch enqueueing these +temporarily enqueues mbufs to an event buffer before batch enqueuing these to the event device. If the buffer fills up, the service function stops -dequeueing packets from the ethernet device. The application may want to +dequeuing packets from the ethernet device. The application may want to monitor the buffer fill level and instruct the service function to selectively enqueue packets to the event device. The application may also use some other criteria to decide which packets should enter the event device even when diff --git a/doc/guides/prog_guide/eventdev.rst b/doc/guides/prog_guide/eventdev.rst index dcdfeb7..7ea14ba 100644 --- a/doc/guides/prog_guide/eventdev.rst +++ b/doc/guides/prog_guide/eventdev.rst @@ -42,7 +42,7 @@ The rte_event structure contains the following metadata fields, which the application fills in to have the event scheduled as required: * ``flow_id`` - The targeted flow identifier for the enq/deq operation. -* ``event_type`` - The source of this event, eg RTE_EVENT_TYPE_ETHDEV or CPU. +* ``event_type`` - The source of this event, e.g. RTE_EVENT_TYPE_ETHDEV or CPU. * ``sub_event_type`` - Distinguishes events inside the application, that have the same event_type (see above) * ``op`` - This field takes one of the RTE_EVENT_OP_* values, and tells the @@ -265,7 +265,7 @@ Linking Queues and Ports The final step is to "wire up" the ports to the queues. After this, the eventdev is capable of scheduling events, and when cores request work to do, the correct events are provided to that core. Note that the RX core takes input -from eg: a NIC so it is not linked to any eventdev queues. +from e.g.: a NIC so it is not linked to any eventdev queues. Linking all workers to atomic queues, and the TX core to the single-link queue can be achieved like this: @@ -276,7 +276,7 @@ can be achieved like this: uint8_t tx_port_id = 5; uint8_t atomic_qs[] = {0, 1}; uint8_t single_link_q = 2; - uin8t_t priority = RTE_EVENT_DEV_PRIORITY_NORMAL; + uint8t_t priority = RTE_EVENT_DEV_PRIORITY_NORMAL; for(int worker_port_id = 1; worker_port_id <= 4; worker_port_id++) { int links_made = rte_event_port_link(dev_id, worker_port_id, atomic_qs, NULL, 2); diff --git a/doc/guides/prog_guide/flow_classify_lib.rst b/doc/guides/prog_guide/flow_classify_lib.rst index f0ed5a1..fbb71f5 100644 --- a/doc/guides/prog_guide/flow_classify_lib.rst +++ b/doc/guides/prog_guide/flow_classify_lib.rst @@ -94,7 +94,7 @@ The library has the following API's * Associated actions (list terminated by the END pattern item). * @param[out] error * Perform verbose error reporting if not NULL. Structure - * initialised in case of error only. + * initialized in case of error only. * @return * 0 on success, error code otherwise */ @@ -120,7 +120,7 @@ The library has the following API's * returns 1 if rule present already, 0 otherwise. * @param[out] error * Perform verbose error reporting if not NULL. Structure - * initialised in case of error only. + * initialized in case of error only. * @return * A valid handle in case of success, NULL otherwise. */ @@ -175,7 +175,7 @@ Classifier creation The application creates the ``Classifier`` using the ``rte_flow_classifier_create`` API. -The ``rte_flow_classify_params`` structure must be initialised by the +The ``rte_flow_classify_params`` structure must be initialized by the application before calling the API. .. code-block:: c @@ -229,7 +229,7 @@ Adding a table to the Classifier The application adds a table to the ``Classifier`` using the ``rte_flow_classify_table_create`` API. -The ``rte_flow_classify_table_params`` structure must be initialised by the +The ``rte_flow_classify_table_params`` structure must be initialized by the application before calling the API. .. code-block:: c @@ -246,7 +246,7 @@ application before calling the API. }; To create an ACL table the ``rte_table_acl_params`` structure must be -initialised and assigned to ``arg_create`` in the +initialized and assigned to ``arg_create`` in the ``rte_flow_classify_table_params`` structure. .. code-block:: c @@ -265,7 +265,7 @@ initialised and assigned to ``arg_create`` in the struct rte_acl_field_def field_format[RTE_ACL_MAX_FIELDS]; }; -The fields for the ACL rule must also be initialised by the application. +The fields for the ACL rule must also be initialized by the application. An ACL table can be added to the ``Classifier`` for each ACL rule, for example another table could be added for the IPv6 5-tuple rule. diff --git a/doc/guides/prog_guide/ipsec_lib.rst b/doc/guides/prog_guide/ipsec_lib.rst index 992fdf4..1beb8e7 100644 --- a/doc/guides/prog_guide/ipsec_lib.rst +++ b/doc/guides/prog_guide/ipsec_lib.rst @@ -65,7 +65,7 @@ In that mode the library functions perform - check SQN - prepare *rte_crypto_op* structure for each input packet - - verify that integity check and decryption performed by crypto device + - verify that integrity check and decryption performed by crypto device completed successfully - check padding data - remove outer IP header (tunnel mode) / update IP header (transport mode) @@ -88,7 +88,7 @@ In that mode the library functions perform * for inbound packets: - - verify that integity check and decryption performed by *rte_security* + - verify that integrity check and decryption performed by *rte_security* device completed successfully - check SQN - check padding data @@ -101,10 +101,10 @@ In that mode the library functions perform - generate SQN and IV - add outer IP header (tunnel mode) / update IP header (transport mode) - add ESP header and trailer, padding and IV data - - update *ol_flags* inside *struct rte_mbuf* to inidicate that + - update *ol_flags* inside *struct rte_mbuf* to indicate that inline-crypto processing has to be performed by HW on this packet - invoke *rte_security* device specific *set_pkt_metadata()* to associate - secuirty device specific data with the packet + security device specific data with the packet RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -113,15 +113,15 @@ In that mode the library functions perform * for inbound packets: - - verify that integity check and decryption performed by *rte_security* + - verify that integrity check and decryption performed by *rte_security* device completed successfully * for outbound packets: - - update *ol_flags* inside *struct rte_mbuf* to inidicate that + - update *ol_flags* inside *struct rte_mbuf* to indicate that inline-crypto processing has to be performed by HW on this packet - invoke *rte_security* device specific *set_pkt_metadata()* to associate - secuirty device specific data with the packet + security device specific data with the packet RTE_SECURITY_ACTION_TYPE_LOOKASIDE_PROTOCOL ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -131,7 +131,7 @@ In that mode the library functions perform * for inbound packets: - prepare *rte_crypto_op* structure for each input packet - - verify that integity check and decryption performed by crypto device + - verify that integrity check and decryption performed by crypto device completed successfully * for outbound packets: diff --git a/doc/guides/prog_guide/kernel_nic_interface.rst b/doc/guides/prog_guide/kernel_nic_interface.rst index 7fcbd93..daf87f4 100644 --- a/doc/guides/prog_guide/kernel_nic_interface.rst +++ b/doc/guides/prog_guide/kernel_nic_interface.rst @@ -227,7 +227,7 @@ application functions: ``config_promiscusity``: - Called when the user changes the promiscusity state of the KNI + Called when the user changes the promiscuity state of the KNI interface. For example, when the user runs ``ip link set promisc [on|off] dev ``. If the user sets this callback function to NULL, but sets the ``port_id`` field to a value other than -1, a default diff --git a/doc/guides/prog_guide/metrics_lib.rst b/doc/guides/prog_guide/metrics_lib.rst index e68e4e7..f2071f2 100644 --- a/doc/guides/prog_guide/metrics_lib.rst +++ b/doc/guides/prog_guide/metrics_lib.rst @@ -25,7 +25,7 @@ individual device. Since the metrics library is self-contained, the only restriction on port numbers is that they are less than ``RTE_MAX_ETHPORTS`` - there is no requirement for the ports to actually exist. -Initialising the library +Initializing the library ------------------------ Before the library can be used, it has to be initialized by calling @@ -169,13 +169,13 @@ following names: - ``peak_bits_in``: Peak inbound bit-rate - ``peak_bits_out``: Peak outbound bit-rate -Once initialised and clocked at the appropriate frequency, these +Once initialized and clocked at the appropriate frequency, these statistics can be obtained by querying the metrics library. Initialization ~~~~~~~~~~~~~~ -Before the library can be used, it has to be initialised by calling +Before the library can be used, it has to be initialized by calling ``rte_stats_bitrate_create()``, which will return a bit-rate calculation object. Since the bit-rate library uses the metrics library to report the calculated statistics, the bit-rate library then needs to @@ -233,13 +233,13 @@ via the metrics library using the following names: - ``mac_latency_ns``: Maximum processing latency (nano-seconds) - ``jitter_ns``: Variance in processing latency (nano-seconds) -Once initialised and clocked at the appropriate frequency, these +Once initialized and clocked at the appropriate frequency, these statistics can be obtained by querying the metrics library. Initialization ~~~~~~~~~~~~~~ -Before the library can be used, it has to be initialised by calling +Before the library can be used, it has to be initialized by calling ``rte_latencystats_init()``. .. code-block:: c @@ -266,7 +266,7 @@ Library shutdown ~~~~~~~~~~~~~~~~ When finished, ``rte_latencystats_uninit()`` needs to be called to -de-initialise the latency library. +de-initialize the latency library. .. code-block:: c diff --git a/doc/guides/prog_guide/multi_proc_support.rst b/doc/guides/prog_guide/multi_proc_support.rst index 1384fe3..6196d3f 100644 --- a/doc/guides/prog_guide/multi_proc_support.rst +++ b/doc/guides/prog_guide/multi_proc_support.rst @@ -273,7 +273,7 @@ will be populated by IPC are as follows: those peer processes that were active at the time of request, how many have replied) * ``msgs`` - pointer to where all of the responses are stored. The order in - which responses appear is undefined. Whendoing sycnrhonous requests, this + which responses appear is undefined. When doing synchronous requests, this memory must be freed by the requestor after request completes! For asynchronous requests, a function pointer to the callback function must be diff --git a/doc/guides/prog_guide/profile_app.rst b/doc/guides/prog_guide/profile_app.rst index 5af795c..a36ebef 100644 --- a/doc/guides/prog_guide/profile_app.rst +++ b/doc/guides/prog_guide/profile_app.rst @@ -64,7 +64,7 @@ The default ``cntvct_el0`` based ``rte_rdtsc()`` provides a portable means to get a wall clock counter in user space. Typically it runs at <= 100MHz. The alternative method to enable ``rte_rdtsc()`` for a high resolution wall -clock counter is through the armv8 PMU subsystem. The PMU cycle counter runs +clock counter is through the ARMv8 PMU subsystem. The PMU cycle counter runs at CPU frequency. However, access to the PMU cycle counter from user space is not enabled by default in the arm64 linux kernel. It is possible to enable cycle counter for user space access by configuring the PMU from the privileged @@ -75,7 +75,7 @@ scheme. Application can choose the PMU based implementation with ``CONFIG_RTE_ARM_EAL_RDTSC_USE_PMU``. The example below shows the steps to configure the PMU based cycle counter on -an armv8 machine. +an ARMv8 machine. .. code-block:: console diff --git a/doc/guides/prog_guide/rte_flow.rst b/doc/guides/prog_guide/rte_flow.rst index 0203f4f..1aec578 100644 --- a/doc/guides/prog_guide/rte_flow.rst +++ b/doc/guides/prog_guide/rte_flow.rst @@ -2129,7 +2129,7 @@ as defined in the ``rte_flow_action_raw_decap`` This action modifies the payload of matched flows. The data supplied must be a valid header, either holding layer 2 data in case of removing layer 2 -before eincapsulation of layer 3 tunnel (for example MPLSoGRE) or complete +before encapsulation of layer 3 tunnel (for example MPLSoGRE) or complete tunnel definition starting from layer 2 and moving to the tunnel item itself. When applied to the original packet the resulting packet must be a valid packet. @@ -2279,7 +2279,7 @@ Action: ``DEC_TTL`` Decrease TTL value. If there is no valid RTE_FLOW_ITEM_TYPE_IPV4 or RTE_FLOW_ITEM_TYPE_IPV6 -in pattern, Some PMDs will reject rule because behaviour will be undefined. +in pattern, Some PMDs will reject rule because behavior will be undefined. .. _table_rte_flow_action_dec_ttl: @@ -2297,7 +2297,7 @@ Action: ``SET_TTL`` Assigns a new TTL value. If there is no valid RTE_FLOW_ITEM_TYPE_IPV4 or RTE_FLOW_ITEM_TYPE_IPV6 -in pattern, Some PMDs will reject rule because behaviour will be undefined. +in pattern, Some PMDs will reject rule because behavior will be undefined. .. _table_rte_flow_action_set_ttl: diff --git a/doc/guides/prog_guide/rte_security.rst b/doc/guides/prog_guide/rte_security.rst index cb70caa..7d0734a 100644 --- a/doc/guides/prog_guide/rte_security.rst +++ b/doc/guides/prog_guide/rte_security.rst @@ -40,7 +40,7 @@ Inline Crypto ~~~~~~~~~~~~~ RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO: -The crypto processing for security protocol (e.g. IPSec) is processed +The crypto processing for security protocol (e.g. IPsec) is processed inline during receive and transmission on NIC port. The flow based security action should be configured on the port. @@ -48,7 +48,7 @@ Ingress Data path - The packet is decrypted in RX path and relevant crypto status is set in Rx descriptors. After the successful inline crypto processing the packet is presented to host as a regular Rx packet however all security protocol related headers are still attached to the -packet. e.g. In case of IPSec, the IPSec tunnel headers (if any), +packet. e.g. In case of IPsec, the IPsec tunnel headers (if any), ESP/AH headers will remain in the packet but the received packet contains the decrypted data where the encrypted data was when the packet arrived. The driver Rx path check the descriptors and and based on the @@ -111,7 +111,7 @@ Inline protocol offload ~~~~~~~~~~~~~~~~~~~~~~~ RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL: -The crypto and protocol processing for security protocol (e.g. IPSec) +The crypto and protocol processing for security protocol (e.g. IPsec) is processed inline during receive and transmission. The flow based security action should be configured on the port. @@ -119,7 +119,7 @@ Ingress Data path - The packet is decrypted in the RX path and relevant crypto status is set in the Rx descriptors. After the successful inline crypto processing the packet is presented to the host as a regular Rx packet but all security protocol related headers are optionally removed from the -packet. e.g. in the case of IPSec, the IPSec tunnel headers (if any), +packet. e.g. in the case of IPsec, the IPsec tunnel headers (if any), ESP/AH headers will be removed from the packet and the received packet will contains the decrypted packet only. The driver Rx path checks the descriptors and based on the crypto status sets additional flags in @@ -132,7 +132,7 @@ to identify the security processing done on the packet. The underlying device in this case is stateful. It is expected that the device shall support crypto processing for all kind of packets matching to a given flow, this includes fragmented packets (post reassembly). - E.g. in case of IPSec the device may internally manage anti-replay etc. + E.g. in case of IPsec the device may internally manage anti-replay etc. It will provide a configuration option for anti-replay behavior i.e. to drop the packets or pass them to driver with error flags set in the descriptor. @@ -150,7 +150,7 @@ to cross the MTU size. .. note:: The underlying device will manage state information required for egress - processing. E.g. in case of IPSec, the seq number will be added to the + processing. E.g. in case of IPsec, the seq number will be added to the packet, however the device shall provide indication when the sequence number is about to overflow. The underlying device may support post encryption TSO. @@ -199,13 +199,13 @@ crypto device. Decryption: The packet is sent to the crypto device for security protocol processing. The device will decrypt the packet and it will also optionally remove additional security headers from the packet. -E.g. in case of IPSec, IPSec tunnel headers (if any), ESP/AH headers +E.g. in case of IPsec, IPsec tunnel headers (if any), ESP/AH headers will be removed from the packet and the decrypted packet may contain plain data only. .. note:: - In case of IPSec the device may internally manage anti-replay etc. + In case of IPsec the device may internally manage anti-replay etc. It will provide a configuration option for anti-replay behavior i.e. to drop the packets or pass them to driver with error flags set in descriptor. @@ -217,7 +217,7 @@ for any protocol header addition. .. note:: - In the case of IPSec, the seq number will be added to the packet, + In the case of IPsec, the seq number will be added to the packet, It shall provide an indication when the sequence number is about to overflow. @@ -549,7 +549,7 @@ IPsec related configuration parameters are defined in ``rte_security_ipsec_xform struct rte_security_ipsec_sa_options options; /**< various SA options */ enum rte_security_ipsec_sa_direction direction; - /**< IPSec SA Direction - Egress/Ingress */ + /**< IPsec SA Direction - Egress/Ingress */ enum rte_security_ipsec_sa_protocol proto; /**< IPsec SA Protocol - AH/ESP */ enum rte_security_ipsec_sa_mode mode; diff --git a/doc/guides/prog_guide/traffic_management.rst b/doc/guides/prog_guide/traffic_management.rst index 98ac431..05b34d9 100644 --- a/doc/guides/prog_guide/traffic_management.rst +++ b/doc/guides/prog_guide/traffic_management.rst @@ -39,7 +39,7 @@ whether a specific implementation does meet the needs to the user application. At the TM level, users can get high level idea with the help of various parameters such as maximum number of nodes, maximum number of hierarchical levels, maximum number of shapers, maximum number of private shapers, type of -scheduling algorithm (Strict Priority, Weighted Fair Queueing , etc.), etc., +scheduling algorithm (Strict Priority, Weighted Fair Queuing , etc.), etc., supported by the implementation. Likewise, users can query the capability of the TM at the hierarchical level to diff --git a/doc/guides/prog_guide/vhost_lib.rst b/doc/guides/prog_guide/vhost_lib.rst index a86c07a..fc3ee43 100644 --- a/doc/guides/prog_guide/vhost_lib.rst +++ b/doc/guides/prog_guide/vhost_lib.rst @@ -63,7 +63,7 @@ The following is an overview of some key Vhost API functions: 512). * zero copy is really good for VM2VM case. For iperf between two VMs, the - boost could be above 70% (when TSO is enableld). + boost could be above 70% (when TSO is enabled). * For zero copy in VM2NIC case, guest Tx used vring may be starved if the PMD driver consume the mbuf but not release them timely. diff --git a/doc/guides/rawdevs/ifpga_rawdev.rst b/doc/guides/rawdevs/ifpga_rawdev.rst index d400db6..a3d92a6 100644 --- a/doc/guides/rawdevs/ifpga_rawdev.rst +++ b/doc/guides/rawdevs/ifpga_rawdev.rst @@ -91,7 +91,7 @@ Run-time parameters ------------------- This driver is invoked automatically in systems added with Intel FPGA, -but PR and IFPGA Bus scan is trigged by command line using +but PR and IFPGA Bus scan is triggered by command line using ``--vdev 'ifpga_rawdev_cfg`` EAL option. The following device parameters are supported: diff --git a/doc/guides/rel_notes/known_issues.rst b/doc/guides/rel_notes/known_issues.rst index 358dfa3..276327c 100644 --- a/doc/guides/rel_notes/known_issues.rst +++ b/doc/guides/rel_notes/known_issues.rst @@ -676,7 +676,7 @@ igb uio legacy mode can not be used in X710/XL710/XXV710 **Description**: X710/XL710/XXV710 NICs lack support for indicating INTx is asserted via the interrupt - bit in the PCI status register. Linux delected them from INTx support table. The related + bit in the PCI status register. Linux deleted them from INTx support table. The related `commit `_. **Implication**: @@ -722,9 +722,9 @@ Linux kernel 4.10.0 iommu attribute read error **Description**: When VT-d is enabled (``iommu=pt intel_iommu=on``), reading IOMMU attributes from /sys/devices/virtual/iommu/dmarXXX/intel-iommu/cap on Linux kernel 4.10.0 error. - This bug is fixed in `Linux commmit a7fdb6e648fb + This bug is fixed in `Linux commit a7fdb6e648fb `_, - This bug is introduced in `Linux commmit 39ab9555c241 + This bug is introduced in `Linux commit 39ab9555c241 `_, **Implication**: @@ -842,7 +842,7 @@ AVX-512 support disabled drop. On DPDK v19.02 ``AVX-512`` disable scope is reduced to ``GCC`` and ``binutils version 2.30`` based - on information accured from the GCC community defect. + on information accrued from the GCC community defect. **Reason**: Generated ``AVX-512`` code cause crash: diff --git a/doc/guides/rel_notes/release_17_11.rst b/doc/guides/rel_notes/release_17_11.rst index 2a93af3..6448b6c 100644 --- a/doc/guides/rel_notes/release_17_11.rst +++ b/doc/guides/rel_notes/release_17_11.rst @@ -168,7 +168,7 @@ New Features * The DES CBC algorithm. * The DES DOCSIS BPI algorithm. - This change requires version 0.47 of the IPSec Multi-buffer library. For + This change requires version 0.47 of the IPsec Multi-buffer library. For more details see the :doc:`../cryptodevs/aesni_mb` documentation. * **Updated the OpenSSL PMD.** @@ -198,7 +198,7 @@ New Features * **Added the Security Offload Library.** Added an experimental library - ``rte_security``. This provide security APIs - for protocols like IPSec using inline ipsec offload to ethernet devices or + for protocols like IPsec using inline ipsec offload to ethernet devices or full protocol offload with lookaside crypto devices. See the :doc:`../prog_guide/rte_security` section of the DPDK Programmers @@ -207,11 +207,11 @@ New Features * **Updated the DPAA2_SEC crypto driver to support rte_security.** Updated the ``dpaa2_sec`` crypto PMD to support ``rte_security`` lookaside - protocol offload for IPSec. + protocol offload for IPsec. * **Updated the IXGBE ethernet driver to support rte_security.** - Updated ixgbe ethernet PMD to support ``rte_security`` inline IPSec offload. + Updated ixgbe ethernet PMD to support ``rte_security`` inline IPsec offload. * **Updated i40e driver to support GTP-C/GTP-U.** @@ -509,7 +509,7 @@ ABI Changes * **New parameter added to rte_eth_dev.** A new parameter ``security_ctx`` has been added to ``rte_eth_dev`` to - support security operations like IPSec inline. + support security operations like IPsec inline. * **New parameter added to rte_cryptodev.** diff --git a/doc/guides/sample_app_ug/bbdev_app.rst b/doc/guides/sample_app_ug/bbdev_app.rst index 40a3264..405e706 100644 --- a/doc/guides/sample_app_ug/bbdev_app.rst +++ b/doc/guides/sample_app_ug/bbdev_app.rst @@ -68,7 +68,7 @@ The application accepts a number of command line options: where: -* ``e ENCODING_CORES``: hexmask for encoding lcored (default = 0x2) +* ``e ENCODING_CORES``: hexmask for encoding lcores (default = 0x2) * ``d DECODING_CORES``: hexmask for decoding lcores (default = 0x4) * ``p ETH_PORT_ID``: ethernet port ID (default = 0) * ``b BBDEV_ID``: BBDev ID (default = 0) @@ -87,7 +87,7 @@ issue the command: $ ./build/bbdev --vdev='baseband_turbo_sw' -w -c 0x38 --socket-mem=2,2 \ --file-prefix=bbdev -- -e 0x10 -d 0x20 -where, NIC0PCIADDR is the PCI addresse of the Rx port +where, NIC0PCIADDR is the PCI address of the Rx port This command creates one virtual bbdev devices ``baseband_turbo_sw`` where the device gets linked to a corresponding ethernet port as whitelisted by diff --git a/doc/guides/sample_app_ug/eventdev_pipeline.rst b/doc/guides/sample_app_ug/eventdev_pipeline.rst index 0ec0290..dc7972a 100644 --- a/doc/guides/sample_app_ug/eventdev_pipeline.rst +++ b/doc/guides/sample_app_ug/eventdev_pipeline.rst @@ -49,7 +49,7 @@ these settings is shown below: ./build/eventdev_pipeline --vdev event_sw0 -- -r1 -t1 -e4 -w FF00 -s4 -n0 -c32 -W1000 -D The application has some sanity checking built-in, so if there is a function -(eg; the RX core) which doesn't have a cpu core mask assigned, the application +(e.g.; the RX core) which doesn't have a cpu core mask assigned, the application will print an error message: .. code-block:: console diff --git a/doc/guides/sample_app_ug/flow_classify.rst b/doc/guides/sample_app_ug/flow_classify.rst index a6383b3..1c765a5 100644 --- a/doc/guides/sample_app_ug/flow_classify.rst +++ b/doc/guides/sample_app_ug/flow_classify.rst @@ -64,7 +64,7 @@ ACL field definitions for the IPv4 5 tuple rule ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The following field definitions are used when creating the ACL table during -initialisation of the ``Flow Classify`` application.. +initialization of the ``Flow Classify`` application.. .. code-block:: c @@ -222,13 +222,13 @@ table`` to the flow classifier. rte_exit(EXIT_FAILURE, "Cannot create classifier\n"); } - /* initialise ACL table params */ + /* initialize ACL table params */ table_acl_params.name = "table_acl_ipv4_5tuple"; table_acl_params.n_rule_fields = RTE_DIM(ipv4_defs); table_acl_params.n_rules = FLOW_CLASSIFY_MAX_RULE_NUM; memcpy(table_acl_params.field_format, ipv4_defs, sizeof(ipv4_defs)); - /* initialise table create params */ + /* initialize table create params */ cls_table_params.ops = &rte_table_acl_ops, cls_table_params.arg_create = &table_acl_params, cls_table_params.type = RTE_FLOW_CLASSIFY_TABLE_ACL_IP4_5TUPLE; @@ -240,7 +240,7 @@ table`` to the flow classifier. rte_exit(EXIT_FAILURE, "Failed to create classifier table\n"); } -It then reads the ipv4_rules_file.txt file and initialises the parameters for +It then reads the ipv4_rules_file.txt file and initializes the parameters for the ``rte_flow_classify_table_entry_add`` API. This API adds a rule to the ACL table. diff --git a/doc/guides/sample_app_ug/intro.rst b/doc/guides/sample_app_ug/intro.rst index 159bcf7..9070419 100644 --- a/doc/guides/sample_app_ug/intro.rst +++ b/doc/guides/sample_app_ug/intro.rst @@ -106,7 +106,7 @@ examples are highlighted below. (packet arrival) and TX (packet transmission) by adding callbacks to the RX and TX packet processing functions. -* :doc:`IPSec Security Gateway`: The IPSec Security +* :doc:`IPsec Security Gateway`: The IPsec Security Gateway application is minimal example of something closer to a real world example. This is also a good example of an application using the DPDK Cryptodev framework. diff --git a/doc/guides/sample_app_ug/ip_pipeline.rst b/doc/guides/sample_app_ug/ip_pipeline.rst index 447a544..d7a05b7 100644 --- a/doc/guides/sample_app_ug/ip_pipeline.rst +++ b/doc/guides/sample_app_ug/ip_pipeline.rst @@ -113,7 +113,7 @@ Application stages Initialization ~~~~~~~~~~~~~~ -During this stage, EAL layer is initialised and application specific arguments are parsed. Furthermore, the data strcutures +During this stage, EAL layer is initialized and application specific arguments are parsed. Furthermore, the data structures (i.e. linked lists) for application objects are initialized. In case of any initialization error, an error message is displayed and the application is terminated. @@ -185,7 +185,7 @@ Examples +-----------------------+----------------------+----------------+------------------------------------+ | IP routing | LPM (IPv4) | Forward | 1. Mempool Create | | | | | 2. Link create | - | | * Key = IP dest addr | | 3. Pipeline creat | + | | * Key = IP dest addr | | 3. Pipeline create | | | * Offset = 286 | | 4. Pipeline port in/out | | | * Table size = 4K | | 5. Pipeline table | | | | | 6. Pipeline port in table | diff --git a/doc/guides/sample_app_ug/ipsec_secgw.rst b/doc/guides/sample_app_ug/ipsec_secgw.rst index 3d784e7..ac118c1 100644 --- a/doc/guides/sample_app_ug/ipsec_secgw.rst +++ b/doc/guides/sample_app_ug/ipsec_secgw.rst @@ -25,8 +25,8 @@ The application classifies the ports as *Protected* and *Unprotected*. Thus, traffic received on an Unprotected or Protected port is consider Inbound or Outbound respectively. -The application also supports complete IPSec protocol offload to hardware -(Look aside crypto accelarator or using ethernet device). It also support +The application also supports complete IPsec protocol offload to hardware +(Look aside crypto accelerator or using ethernet device). It also support inline ipsec processing by the supported ethernet device during transmission. These modes can be selected during the SA creation configuration. @@ -124,7 +124,7 @@ Where: * ``-e``: enables Security Association extended sequence number processing (available only with librte_ipsec code path). -* ``-a``: enables Security Association sequence number atomic behaviour +* ``-a``: enables Security Association sequence number atomic behavior (available only with librte_ipsec code path). * ``--config (port,queue,lcore)[,(port,queue,lcore)]``: determines which queues @@ -752,7 +752,7 @@ DUT OS(NIC1)--(IPsec)-->(NIC1)ipsec-secgw(TAP)--(plain)-->(TAP)SUT OS SUT OS(TAP)--(plain)-->(TAP)psec-secgw(NIC1)--(IPsec)-->(NIC1)DUT OS -It then tries to perform some data transfer using the scheme decribed above. +It then tries to perform some data transfer using the scheme described above. usage ~~~~~ diff --git a/doc/guides/sample_app_ug/performance_thread.rst b/doc/guides/sample_app_ug/performance_thread.rst index e2c04ef..ac6ee8a 100644 --- a/doc/guides/sample_app_ug/performance_thread.rst +++ b/doc/guides/sample_app_ug/performance_thread.rst @@ -500,8 +500,8 @@ An application may save and retrieve a single pointer to application data in the L-thread struct. For legacy and backward compatibility reasons two alternative methods are also -offered, the first is modelled directly on the pthread get/set specific APIs, -the second approach is modelled on the ``RTE_PER_LCORE`` macros, whereby +offered, the first is modeled directly on the pthread get/set specific APIs, +the second approach is modeled on the ``RTE_PER_LCORE`` macros, whereby ``PER_LTHREAD`` macros are introduced, in both cases the storage is local to the L-thread. diff --git a/doc/guides/sample_app_ug/qos_metering.rst b/doc/guides/sample_app_ug/qos_metering.rst index 2e8e017..d75f7da 100644 --- a/doc/guides/sample_app_ug/qos_metering.rst +++ b/doc/guides/sample_app_ug/qos_metering.rst @@ -151,5 +151,5 @@ In this particular case: * For the rest of the cases, the color is changed to red. .. note:: - * In color blind mode, first row GREEN colour is only valid. + * In color blind mode, first row GREEN color is only valid. * To drop the packet, policer_table action has to be set to DROP. diff --git a/doc/guides/sample_app_ug/test_pipeline.rst b/doc/guides/sample_app_ug/test_pipeline.rst index 5f313c5..5aefd8d 100644 --- a/doc/guides/sample_app_ug/test_pipeline.rst +++ b/doc/guides/sample_app_ug/test_pipeline.rst @@ -32,7 +32,7 @@ Compiling the Application ------------------------- To compile the sample application see :doc:`compiling` -The application is located in the ``$RTE_SDK/app/test-pipline`` directory. +The application is located in the ``$RTE_SDK/app/test-pipeline`` directory. Running the Application diff --git a/doc/guides/sample_app_ug/vhost.rst b/doc/guides/sample_app_ug/vhost.rst index df4d6f9..a71ada6 100644 --- a/doc/guides/sample_app_ug/vhost.rst +++ b/doc/guides/sample_app_ug/vhost.rst @@ -116,7 +116,7 @@ will create it. Put simply, it's the server to create the socket file. The vm2vm parameter sets the mode of packet switching between guests in the host. -- 0 disables vm2vm, impling that VM's packets will always go to the NIC port. +- 0 disables vm2vm, implying that VM's packets will always go to the NIC port. - 1 means a normal mac lookup packet routing. - 2 means hardware mode packet forwarding between guests, it allows packets go to the NIC port, hardware L2 switch will determine which guest the @@ -148,7 +148,7 @@ default value is 15. **--dequeue-zero-copy** Dequeue zero copy will be enabled when this option is given. it is worth to -note that if NIC is binded to driver with iommu enabled, dequeue zero copy +note that if NIC is bound to driver with iommu enabled, dequeue zero copy cannot work at VM2NIC mode (vm2vm=0) due to currently we don't setup iommu dma mapping for guest memory. diff --git a/doc/guides/sample_app_ug/vhost_scsi.rst b/doc/guides/sample_app_ug/vhost_scsi.rst index 7ab7d0d..6b9bf62 100644 --- a/doc/guides/sample_app_ug/vhost_scsi.rst +++ b/doc/guides/sample_app_ug/vhost_scsi.rst @@ -63,7 +63,7 @@ Vhost_scsi Common Issues * vhost_scsi can not start with block size 512 Bytes: - Currently DPDK vhost library was designed for NET device(althrough the APIs + Currently DPDK vhost library was designed for NET device(although the APIs are generic now), for 512 Bytes block device, Qemu BIOS(x86 BIOS Enhanced Disk Device) will enumerate all block device and do some IOs to those block devices with 512 Bytes sector size. DPDK vhost library can not process such diff --git a/doc/guides/sample_app_ug/vm_power_management.rst b/doc/guides/sample_app_ug/vm_power_management.rst index 14d432e..7d73de3 100644 --- a/doc/guides/sample_app_ug/vm_power_management.rst +++ b/doc/guides/sample_app_ug/vm_power_management.rst @@ -53,8 +53,8 @@ The solution is comprised of two high-level components: application below for more information on setting the policy values. - Out-of-band monitoring of workloads via cores hardware event counters: - The host application can manage power for an application in a virtualised - OR non-virtualised environment by looking at the event counters of the + The host application can manage power for an application in a virtualized + OR non-virtualized environment by looking at the event counters of the cores and taking action based on the branch hit/miss ratio. See the host application '--core-list' command line parameter below. @@ -344,7 +344,7 @@ monitoring of branch ratio on cores doing busy polling via PMDs. When this parameter is used, the list of cores specified will monitor the ratio between branch hits and branch misses. A tightly polling PMD thread will have a - very low branch ratio, so the core frequency will be scaled down to the minimim + very low branch ratio, so the core frequency will be scaled down to the minimum allowed value. When packets are received, the code path will alter, causing the branch ratio to increase. When the ratio goes above the ratio threshold, the core frequency will be scaled up to the maximum allowed value. @@ -384,7 +384,7 @@ the file. The fifo is at /tmp/powermonitor/fifo -The jason string can be a policy or instruction, and takes the following +The JSON string can be a policy or instruction, and takes the following format: .. code-block:: javascript @@ -734,7 +734,7 @@ policy down to the host application. These parameters are as follows: A comma-separated list of cores in the VM that the user wants the host application to monitor. The list of cores in any vm starts at zero, and these are mapped to the physical cores by the host application once the policy is passed down. - Valid syntax includes individial cores '2,3,4', or a range of cores '2-4', or a + Valid syntax includes individual cores '2,3,4', or a range of cores '2-4', or a combination of both '1,3,5-7' .. code-block:: console @@ -742,7 +742,7 @@ policy down to the host application. These parameters are as follows: --busy-hours {list of busy hours} A comma-separated list of hours within which to set the core frequency to maximum. - Valid syntax includes individial hours '2,3,4', or a range of hours '2-4', or a + Valid syntax includes individual hours '2,3,4', or a range of hours '2-4', or a combination of both '1,3,5-7'. Valid hours are 0 to 23. .. code-block:: console @@ -750,7 +750,7 @@ policy down to the host application. These parameters are as follows: --quiet-hours {list of quiet hours} A comma-separated list of hours within which to set the core frequency to minimum. - Valid syntax includes individial hours '2,3,4', or a range of hours '2-4', or a + Valid syntax includes individual hours '2,3,4', or a range of hours '2-4', or a combination of both '1,3,5-7'. Valid hours are 0 to 23. .. code-block:: console diff --git a/doc/guides/testpmd_app_ug/run_app.rst b/doc/guides/testpmd_app_ug/run_app.rst index b717b8c..eb632e2 100644 --- a/doc/guides/testpmd_app_ug/run_app.rst +++ b/doc/guides/testpmd_app_ug/run_app.rst @@ -369,7 +369,7 @@ The commandline options are: * ``--hot-plug`` - Enable device event monitor machenism for hotplug. + Enable device event monitor mechanism for hotplug. * ``--vxlan-gpe-port=N`` @@ -409,21 +409,21 @@ The commandline options are: * ``--noisy-lkup-memory=N`` - Set the size of the noisy neighbour simulation memory buffer in MB to N. + Set the size of the noisy neighbor simulation memory buffer in MB to N. Only available with the noisy forwarding mode. The default value is 0. * ``--noisy-lkup-num-reads=N`` - Set the number of reads to be done in noisy neighbour simulation memory buffer to N. + Set the number of reads to be done in noisy neighbor simulation memory buffer to N. Only available with the noisy forwarding mode. The default value is 0. * ``--noisy-lkup-num-writes=N`` - Set the number of writes to be done in noisy neighbour simulation memory buffer to N. + Set the number of writes to be done in noisy neighbor simulation memory buffer to N. Only available with the noisy forwarding mode. The default value is 0. * ``--noisy-lkup-num-reads-writes=N`` - Set the number of r/w accesses to be done in noisy neighbour simulation memory buffer to N. + Set the number of r/w accesses to be done in noisy neighbor simulation memory buffer to N. Only available with the noisy forwarding mode. The default value is 0. diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst index 06c8b2a..8eb39cd 100644 --- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst +++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst @@ -302,7 +302,7 @@ The available information categories are: This is the default mode. * ``mac``: Changes the source and the destination Ethernet addresses of packets before forwarding them. - Default application behaviour is to set source Ethernet address to that of the transmitting interface, and destination + Default application behavior is to set source Ethernet address to that of the transmitting interface, and destination address to a dummy value (set during init). The user may specify a target destination Ethernet address via the 'eth-peer' or 'eth-peers-configfile' command-line options. It is not currently possible to specify a specific source Ethernet address. @@ -323,9 +323,9 @@ The available information categories are: * ``ieee1588``: Demonstrate L2 IEEE1588 V2 PTP timestamping for RX and TX. Requires ``CONFIG_RTE_LIBRTE_IEEE1588=y``. * ``softnic``: Demonstrates the softnic forwarding operation. In this mode, packet forwarding is - similar to I/O mode except for the fact that packets are loopback to the softnic ports only. Therefore, portmask parameter should be set to softnic port only. The various software based custom NIC pipelines specified through the softnic firmware (DPDK packet framework script) can be tested in this mode. Furthermore, it allows to build 5-level hierarchical QoS scheduler as a default option that can be enabled through CLI once testpmd application is initialised. The user can modify the default scheduler hierarchy or can specify the new QoS Scheduler hierarchy through CLI. Requires ``CONFIG_RTE_LIBRTE_PMD_SOFTNIC=y``. + similar to I/O mode except for the fact that packets are loopback to the softnic ports only. Therefore, portmask parameter should be set to softnic port only. The various software based custom NIC pipelines specified through the softnic firmware (DPDK packet framework script) can be tested in this mode. Furthermore, it allows to build 5-level hierarchical QoS scheduler as a default option that can be enabled through CLI once testpmd application is initialized. The user can modify the default scheduler hierarchy or can specify the new QoS Scheduler hierarchy through CLI. Requires ``CONFIG_RTE_LIBRTE_PMD_SOFTNIC=y``. -* ``noisy``: Noisy neighbour simulation. +* ``noisy``: Noisy neighbor simulation. Simulate more realistic behavior of a guest machine engaged in receiving and sending packets performing Virtual Network Function (VNF). @@ -2286,7 +2286,7 @@ set bonding lacp dedicated_queue ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Enable dedicated tx/rx queues on bonding devices slaves to handle LACP control plane traffic -when in mode 4 (link-aggregration-802.3ad):: +when in mode 4 (link-aggregation-802.3ad):: testpmd> set bonding lacp dedicated_queues (port_id) (enable|disable) @@ -2294,7 +2294,7 @@ when in mode 4 (link-aggregration-802.3ad):: set bonding agg_mode ~~~~~~~~~~~~~~~~~~~~ -Enable one of the specific aggregators mode when in mode 4 (link-aggregration-802.3ad):: +Enable one of the specific aggregators mode when in mode 4 (link-aggregation-802.3ad):: testpmd> set bonding agg_mode (port_id) (bandwidth|count|stable) @@ -2688,8 +2688,8 @@ where: * ``shared_shaper_id``: Shared shaper ID to be deleted. -Set port traffic management hiearchy node private shaper -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Set port traffic management hierarchy node private shaper +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ set the port traffic management hierarchy node private shaper:: @@ -2740,7 +2740,7 @@ Delete the WRED profile:: Add port traffic management hierarchy nonleaf node ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Add nonleaf node to port traffic management hiearchy:: +Add nonleaf node to port traffic management hierarchy:: testpmd> add port tm nonleaf node (port_id) (node_id) (parent_node_id) \ (priority) (weight) (level_id) (shaper_profile_id) \ @@ -2755,7 +2755,7 @@ where: * ``weight``: Node weight (lowest weight is one). The node weight is relative to the weight sum of all siblings that have the same priority. It is used by the WFQ algorithm running on the parent node for scheduling this node. -* ``level_id``: Hiearchy level of the node. +* ``level_id``: Hierarchy level of the node. * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by the node. * ``n_sp_priorities``: Number of strict priorities. @@ -2766,7 +2766,7 @@ where: Add port traffic management hierarchy leaf node ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Add leaf node to port traffic management hiearchy:: +Add leaf node to port traffic management hierarchy:: testpmd> add port tm leaf node (port_id) (node_id) (parent_node_id) \ (priority) (weight) (level_id) (shaper_profile_id) \ @@ -2781,7 +2781,7 @@ where: * ``weight``: Node weight (lowest weight is one). The node weight is relative to the weight sum of all siblings that have the same priority. It is used by the WFQ algorithm running on the parent node for scheduling this node. -* ``level_id``: Hiearchy level of the node. +* ``level_id``: Hierarchy level of the node. * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by the node. * ``cman_mode``: Congestion management mode to be enabled for this node. @@ -2793,7 +2793,7 @@ where: Delete port traffic management hierarchy node ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Delete node from port traffic management hiearchy:: +Delete node from port traffic management hierarchy:: testpmd> del port tm node (port_id) (node_id) @@ -3986,7 +3986,7 @@ This section lists supported actions and their attributes, if any. - ``dec_ttl``: Performs a decrease TTL value action -- ``set_ttl``: Set TTL value with specificed value +- ``set_ttl``: Set TTL value with specified value - ``ttl_value {unsigned}``: The new TTL value to be set - ``set_mac_src``: set source MAC address @@ -4519,7 +4519,7 @@ The following sections show functions to load/unload eBPF based filters. bpf-load ~~~~~~~~ -Load an eBPF program as a callback for partciular RX/TX queue:: +Load an eBPF program as a callback for particular RX/TX queue:: testpmd> bpf-load rx|tx (portid) (queueid) (load-flags) (bpf-prog-filename) @@ -4557,7 +4557,7 @@ To load (not JITed) t1.o at TX queue 0, port 0:: bpf-unload ~~~~~~~~~~ -Unload previously loaded eBPF program for partciular RX/TX queue:: +Unload previously loaded eBPF program for particular RX/TX queue:: testpmd> bpf-unload rx|tx (portid) (queueid) diff --git a/doc/guides/tools/cryptoperf.rst b/doc/guides/tools/cryptoperf.rst index c366af4..2fc6544 100644 --- a/doc/guides/tools/cryptoperf.rst +++ b/doc/guides/tools/cryptoperf.rst @@ -59,7 +59,7 @@ To set on the linearization options add below definition to the **Step 3: Build the application** Execute the ``dpdk-setup.sh`` script to build the DPDK library together with the -``dpdk-test-crypto-perf`` applcation. +``dpdk-test-crypto-perf`` application. Initially, the user must select a DPDK target to choose the correct target type and compiler options to use when building the libraries. @@ -80,7 +80,7 @@ EAL Options ~~~~~~~~~~~ The following are the EAL command-line options that can be used in conjunction -with the ``dpdk-test-crypto-perf`` applcation. +with the ``dpdk-test-crypto-perf`` application. See the DPDK Getting Started Guides for more information on these options. * ``-c `` or ``-l `` @@ -96,10 +96,10 @@ See the DPDK Getting Started Guides for more information on these options. Add a virtual device. -Appication Options -~~~~~~~~~~~~~~~~~~ +Application Options +~~~~~~~~~~~~~~~~~~~ -The following are the appication command-line options: +The following are the application command-line options: * ``--ptest type`` @@ -338,13 +338,13 @@ Test Vector File The test vector file is a text file contain information about test vectors. The file is made of the sections. The first section doesn't have header. It contain global information used in each test variant vectors - -typically information about plaintext, ciphertext, cipher key, aut key, +typically information about plaintext, ciphertext, cipher key, auth key, initial vector. All other sections begin header. The sections contain particular information typically digest. **Format of the file:** -Each line beginig with sign '#' contain comment and it is ignored by parser:: +Each line beginning with sign '#' contain comment and it is ignored by parser:: # @@ -352,16 +352,16 @@ Header line is just name in square bracket:: [
] -Data line contain information tocken then sign '=' and +Data line contain information token then sign '=' and a string of bytes in C byte array format:: - = + = -**Tockens list:** +**Tokens list:** * ``plaintext`` - Original plaintext to be crypted. + Original plaintext to be encrypted. * ``ciphertext`` diff --git a/doc/guides/tools/proc_info.rst b/doc/guides/tools/proc_info.rst index 6bdf5a8..2ea1b59 100644 --- a/doc/guides/tools/proc_info.rst +++ b/doc/guides/tools/proc_info.rst @@ -44,7 +44,7 @@ If no port mask is specified xstats are reset for all DPDK ports. **-m**: Print DPDK memory information. **--show-port** -The show-port parameter displays port level various configuration informationi +The show-port parameter displays port level various configuration information associated to RX port queue pair. **--show-tm** @@ -56,7 +56,7 @@ The show-crypto parameter displays available cryptodev configurations, settings and stats per node. **--show-ring[=name]** -The show-ring pararmeter display current allocation of all ring with +The show-ring parameter display current allocation of all ring with debug information. Specifying the name allows to display details for specific ring. For invalid or no ring name, whole list is dump. @@ -76,7 +76,7 @@ Limitations * When running ``dpdk-procinfo`` with shared library mode, it is required to pass the same NIC PMD libraries as used for the primary application. Any - mismatch in PMD library arguments can lead to undefined behaviour and results + mismatch in PMD library arguments can lead to undefined behavior and results affecting primary application too. * Stats retrieval using ``dpdk-procinfo`` is not supported for virtual devices like PCAP and TAP. diff --git a/doc/guides/tools/testbbdev.rst b/doc/guides/tools/testbbdev.rst index f338647..0001a0d 100644 --- a/doc/guides/tools/testbbdev.rst +++ b/doc/guides/tools/testbbdev.rst @@ -139,7 +139,7 @@ There are 6 main test cases that can be executed using testbbdev tool: * Latency measurement [-c latency] - Measures the time consumed from the first enqueue until the first appearance of a dequeued result - - This measurment represents the full latency of a bbdev operation + - This measurement represents the full latency of a bbdev operation (encode or decode) to execute * Poll-mode Throughput measurement [-c throughput] -- 2.7.5