On 27 Feb 2024, at 16:36, Simon Horman wrote:
> Correct spelling errors in .rst files flagged by codespell. Some small nits below. //Eelco > Signed-off-by: Simon Horman <ho...@ovn.org> > --- > Documentation/howto/sflow.rst | 2 +- > Documentation/howto/tc-offload.rst | 4 ++-- > Documentation/intro/install/afxdp.rst | 2 +- > Documentation/intro/install/documentation.rst | 6 +++--- > Documentation/intro/install/dpdk.rst | 12 ++++++------ > Documentation/intro/install/fedora.rst | 4 ++-- > Documentation/intro/install/general.rst | 2 +- > Documentation/intro/why-ovs.rst | 2 +- > Documentation/topics/dpdk/bridge.rst | 6 +++--- > Documentation/topics/dpdk/phy.rst | 2 +- > Documentation/topics/dpdk/vhost-user.rst | 2 +- > Documentation/topics/integration.rst | 2 +- > Documentation/topics/porting.rst | 2 +- > Documentation/topics/record-replay.rst | 2 +- > Documentation/topics/testing.rst | 4 ++-- > 15 files changed, 27 insertions(+), 27 deletions(-) > > diff --git a/Documentation/howto/sflow.rst b/Documentation/howto/sflow.rst > index 74d8b8e175fe..0b378c93d44a 100644 > --- a/Documentation/howto/sflow.rst > +++ b/Documentation/howto/sflow.rst > @@ -68,7 +68,7 @@ cookbook entry, we use `sFlowTrend > <http://www.inmon.com/products/sFlowTrend.php> `__, a free sFlow collector > that > is a simple cross-platform Java download. Other sFlow collectors should work > equally well. `hostMon` has a single NIC, `eth0`, that is connected to the > -Management Network. `eth0` has an IP adress that can reach `eth1` on `host1`. > +Management Network. `eth0` has an IP address that can reach `eth1` on > `host1`. > > Two Virtual Machines > ~~~~~~~~~~~~~~~~~~~~ > diff --git a/Documentation/howto/tc-offload.rst > b/Documentation/howto/tc-offload.rst > index 681dff13e08c..d53c278d9f7d 100644 > --- a/Documentation/howto/tc-offload.rst > +++ b/Documentation/howto/tc-offload.rst > @@ -49,7 +49,7 @@ tc-police action, see ``man tc-police``. > Configuration > ~~~~~~~~~~~~~ > > -There is no parameter change in ovs-ofctl command, to configue a meter and > use > +There is no parameter change in ovs-ofctl command, to configure a meter and > use > it for a flow in the offload way. Usually the commands are like:: > > $ ovs-ofctl -O OpenFlow13 add-meter br0 "meter=1 pktps bands=type=drop > rate=1" > @@ -59,7 +59,7 @@ For more details, see ``man ovs-ofctl``. > > .. note:: > Each meter is mapped to one TC police action. To avovid the conflicton, the This line also has an error; avovid, and maybe also change to ‘To avoid conflicts, …” > - police action index of 0x10000000-0x1fffffff are resevered for the mapping. > + police action index of 0x10000000-0x1fffffff are reserved for the mapping. > You can check the police actions by the command ``tc action ls action > police`` > in Linux system. > > diff --git a/Documentation/intro/install/afxdp.rst > b/Documentation/intro/install/afxdp.rst > index 5776614c8e53..964d9ef5b1d0 100644 > --- a/Documentation/intro/install/afxdp.rst > +++ b/Documentation/intro/install/afxdp.rst > @@ -150,7 +150,7 @@ To kick start end-to-end autotesting:: > make check-afxdp TESTSUITEFLAGS='1' > > .. note:: > - Not all test cases pass at this time. Currenly all cvlan tests are skipped > + Not all test cases pass at this time. Currently all cvlan tests are > skipped > due to kernel issues. > > If a test case fails, check the log at:: > diff --git a/Documentation/intro/install/documentation.rst > b/Documentation/intro/install/documentation.rst > index acf5b3a3ff33..049ca3d33be7 100644 > --- a/Documentation/intro/install/documentation.rst > +++ b/Documentation/intro/install/documentation.rst > @@ -79,9 +79,9 @@ Makefile targets:: > .. important:: > > The ``docs-check`` target will fail if there are any syntax errors. > - However, it won't catch more succint issues such as style or grammar > issues. > - As a result, you should always inspect changes visually to ensure the > result > - is as intended. > + However, it won't catch more succinct issues such as style or grammar > + issues. As a result, you should always inspect changes visually to ensure > + the result is as intended. > > Once built, documentation is available in the ``/Documentation/_build`` > folder. > Open the root ``index.html`` to browse the documentation. > diff --git a/Documentation/intro/install/dpdk.rst > b/Documentation/intro/install/dpdk.rst > index ad9bdf22c06a..68b304338641 100644 > --- a/Documentation/intro/install/dpdk.rst > +++ b/Documentation/intro/install/dpdk.rst > @@ -232,7 +232,7 @@ Mount the hugepages, if not already mounted by default:: > Setup DPDK devices using VFIO > ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ > > -VFIO is prefered to the UIO driver when using recent versions of DPDK. VFIO > +VFIO is preferred to the UIO driver when using recent versions of DPDK. VFIO > support required support from both the kernel and BIOS. For the former, > kernel > version > 3.6 must be used. For the latter, you must enable VT-d in the BIOS > and ensure this is configured via grub. To ensure VT-d is enabled via the > BIOS, > @@ -506,17 +506,17 @@ options. > Affinity > ~~~~~~~~ > > -For superior performance, DPDK pmd threads and Qemu vCPU threads needs to be > -affinitized accordingly. > +For superior performance, DPDK pmd threads and Qemu vCPU threads needs to Not a native speaker, but does needs, here need to be need? > +have affinity set accordingly. > > - PMD thread Affinity > > A poll mode driver (pmd) thread handles the I/O of all DPDK interfaces > assigned to it. A pmd thread shall poll the ports for incoming packets, > switch the packets and send to tx port. A pmd thread is CPU bound, and > needs > - to be affinitized to isolated cores for optimum performance. Even though a > - PMD thread may exist, the thread only starts consuming CPU cycles if there > is > - at least one receive queue assigned to the pmd. > + to be have affinity set to isolated cores for optimum performance. Even > + though a PMD thread may exist, the thread only starts consuming CPU cycles > if > + there is at least one receive queue assigned to the pmd. > > .. note:: > On NUMA systems, PCI devices are also local to a NUMA node. Unbound rx > diff --git a/Documentation/intro/install/fedora.rst > b/Documentation/intro/install/fedora.rst > index 02481597ffe7..49fad844c7f7 100644 > --- a/Documentation/intro/install/fedora.rst > +++ b/Documentation/intro/install/fedora.rst > @@ -84,8 +84,8 @@ YUM:: > > Once that is completed, remove the file ``/tmp/ovs.spec``. > > -Bootstraping > ------------- > +Bootstrapping > +------------- > > Refer to :ref:`general-bootstrapping`. > > diff --git a/Documentation/intro/install/general.rst > b/Documentation/intro/install/general.rst > index 86e85f75dbff..17c154268054 100644 > --- a/Documentation/intro/install/general.rst > +++ b/Documentation/intro/install/general.rst > @@ -495,7 +495,7 @@ Start ovsdb-server using below command:: > $ docker run -itd --net=host --name=ovsdb-server \ > <docker_repo>:<tag> ovsdb-server > > -Start ovs-vswitchd with priviledged mode as it needs to load kernel module in > +Start ovs-vswitchd with privileged mode as it needs to load kernel module in > host using below command:: > > $ docker run -itd --net=host --name=ovs-vswitchd \ > diff --git a/Documentation/intro/why-ovs.rst b/Documentation/intro/why-ovs.rst > index e73066a76658..80a3f2f22f20 100644 > --- a/Documentation/intro/why-ovs.rst > +++ b/Documentation/intro/why-ovs.rst > @@ -125,7 +125,7 @@ previous hypervisor networking stacks, focusing on the > need for automated and > dynamic network control in large-scale Linux-based virtualization > environments. > > The goal with Open vSwitch is to keep the in-kernel code as small as possible > -(as is necessary for performance) and to re-use existing subsystems when > +(as is necessary for performance) and to reuse existing subsystems when > applicable (for example Open vSwitch uses the existing QoS stack). As of > Linux > 3.3, Open vSwitch is included as a part of the kernel and packaging for the > userspace utilities are available on most popular distributions. > diff --git a/Documentation/topics/dpdk/bridge.rst > b/Documentation/topics/dpdk/bridge.rst > index 00be06e37fea..583105c64250 100644 > --- a/Documentation/topics/dpdk/bridge.rst > +++ b/Documentation/topics/dpdk/bridge.rst > @@ -98,7 +98,7 @@ datapath flows with very simple match criteria. > In theory, for very simple forwarding, OVS doesn't need to parse packets at > all > in order to follow these rules. In practice, due to various implementation > constraints, userspace datapath has to match at least on a small set of > packet > -fileds. Some matching criteria (for example, ingress port) are not related > to > +fields. Some matching criteria (for example, ingress port) are not related > to > the packet itself and others (for example, VLAN tag or Ethernet type) can be > extracted without fully parsing the packet. This allows OVS to significantly > speed up packet forwarding for these flows with simple match criteria. > @@ -202,7 +202,7 @@ get command, note the updated priority of the > ``avx512_gather`` function:: > avx512_gather (Use count: 0, Priority: 3) > > If two lookup functions have the same priority, the first one in the list is > -chosen, and the 2nd occurance of that priority is not used. Put in logical > +chosen, and the 2nd occurrence of that priority is not used. Put in logical > terms, a subtable is chosen if its priority is greater than the previous > best candidate. > > @@ -280,7 +280,7 @@ composed of bits and blocks where the bits signify which > blocks are set or have > values where as the blocks hold the metadata, ip, udp, vlan, etc. These > values > are used by the datapath for switching decisions later. > > -Most modern CPUs have some SIMD (single instruction, mutiple data) > +Most modern CPUs have some SIMD (single instruction, multiple data) > capabilities. These SIMD instructions are able to process a vector rather > than > act on one variable. OVS provides multiple implementations of packet parsing > functions. This allows the user to take advantage of SIMD instructions like > diff --git a/Documentation/topics/dpdk/phy.rst > b/Documentation/topics/dpdk/phy.rst > index d94eafc9a9bd..efd168cba806 100644 > --- a/Documentation/topics/dpdk/phy.rst > +++ b/Documentation/topics/dpdk/phy.rst > @@ -153,7 +153,7 @@ __ > https://doc.dpdk.org/guides-23.11/prog_guide/rte_flow.html > .. warning:: > > This feature is not compatible with all NICs. Refer to the DPDK > - `compatibilty matrix`__ and vendor documentation for more details. > + `compatibility matrix`__ and vendor documentation for more details. > > __ https://doc.dpdk.org/guides-23.11/nics/overview.html > > diff --git a/Documentation/topics/dpdk/vhost-user.rst > b/Documentation/topics/dpdk/vhost-user.rst > index e952a686b55d..7866543d89a2 100644 > --- a/Documentation/topics/dpdk/vhost-user.rst > +++ b/Documentation/topics/dpdk/vhost-user.rst > @@ -269,7 +269,7 @@ similar to the following:: > > QEMU waiting for connection on: disconnected:unix:/path/to/socket,server > > -QEMU will wait until the port is created sucessfully in OVS to boot the VM. > +QEMU will wait until the port is created successfully in OVS to boot the VM. > One benefit of using this mode is the ability for vHost ports to 'reconnect' > in > event of the switch crashing or being brought down. Once it is brought back > up, > the vHost ports will reconnect automatically and normal service will resume. > diff --git a/Documentation/topics/integration.rst > b/Documentation/topics/integration.rst > index 58c4389abef2..79bfece82113 100644 > --- a/Documentation/topics/integration.rst > +++ b/Documentation/topics/integration.rst > @@ -250,7 +250,7 @@ with the active server:: > 2. Using load balancer vip ip as a master_ip. In order to use this feature, > one needs to use listen_on_master_ip_only to no. Current code for load > balancer have been tested to work with tcp protocol and needs to be > -tested/enchanced for ssl. Using load balancer, standby nodes will not listen > on > +tested/enhanced for ssl. Using load balancer, standby nodes will not listen > on > nb and sb db ports so that load balancer will always communicate to the > active > node and all the traffic will be sent to active node only. Standby will > continue to sync using LB VIP IP in this case. > diff --git a/Documentation/topics/porting.rst > b/Documentation/topics/porting.rst > index 839b04d52eea..b627fde12607 100644 > --- a/Documentation/topics/porting.rst > +++ b/Documentation/topics/porting.rst > @@ -210,7 +210,7 @@ vSwitch architecture: > :: > > > - Architecure > + Architecture > > _ > | +-------------------+ > diff --git a/Documentation/topics/record-replay.rst > b/Documentation/topics/record-replay.rst > index 14a568c21202..f723e05dd7ac 100644 > --- a/Documentation/topics/record-replay.rst > +++ b/Documentation/topics/record-replay.rst > @@ -44,7 +44,7 @@ measure performance with ``perf``, and so on. > .. note:: > > The current version of record/replay engine does not work correctly with > - internal time-based events that leats to communications with other > + internal time-based events that lead to communications with other > processes. For this reason it can not be used with clustered databases > (RAFT implementation is heavily time dependent). > In addition, recording automatically disables inactivity probes on > diff --git a/Documentation/topics/testing.rst > b/Documentation/topics/testing.rst > index c6093463d316..9b5fc7448fea 100644 > --- a/Documentation/topics/testing.rst > +++ b/Documentation/topics/testing.rst > @@ -409,7 +409,7 @@ options are used:: > checking whether actions Autovalidator is default implementation... yes > > Compile OVS in debug mode to have `ovs_assert` statements error out if > -there is a mis-match in the datapath classifier lookup or packet parser > +there is a mismatch in the datapath classifier lookup or packet parser > implementations. > > Since the AVX512 implementation of the datapath interface is disabled by > @@ -492,7 +492,7 @@ Proof of Concepts > ~~~~~~~~~~~~~~~~~ > > Proof of Concepts are documentation materialized into Ansible recipes > -executed in VirtualBox or Libvirt environments orchastrated by Vagrant. > +executed in VirtualBox or Libvirt environments orchestrated by Vagrant. > Proof of Concepts allow developers to create small virtualized setups that > demonstrate how certain Open vSwitch features are intended to work avoiding > user introduced errors by overlooking instructions. Proof of Concepts > > -- > 2.43.0 > > _______________________________________________ > dev mailing list > d...@openvswitch.org > https://mail.openvswitch.org/mailman/listinfo/ovs-dev _______________________________________________ dev mailing list d...@openvswitch.org https://mail.openvswitch.org/mailman/listinfo/ovs-dev
