mbox series

[ovs-dev,0/1] Proposal to fix spelling

Message ID 20211213063319.27480-1-jsoref@gmail.com
Headers show
Series Proposal to fix spelling | expand

Message

Josh Soref Dec. 13, 2021, 6:33 a.m. UTC
I normally use GitHub to create pull request that points to the general
description of what I'm doing and then annotate the individual changes.

As this contribution is by email, that's not practical.

As authored, this is a series of 290 fairly distinct commits [1].
It covers <250 files and <500 lines. By my standards this is a
medium submission. I've managed PRs that are ~1k commits and
similar numbers of files / lines.

They are designed to address the apparent misspellings [2] that
a tool I maintain [3] has identified.

I generally maintain distinct commits based on word family because I
fully expect changes to some word families to be rejected, and thus,
it's trivial for me to drop them while they're distinct commits.
It also makes it easier for me to rebase, for a given commit, if it
has conflicts, I can just regenerate the commit to achieve the goal
described by its commit message.

Larger projects tend to respond to my PRs w/ a couple of approaches:
1. Outright rejection - this isn't a problem, just let me know,
the cost for me to produce the changes here is a couple of hours.
2. Request to split by directory - this is fairly trivial, however
any word change that spans multiple directories becomes dangerous.
For spanning commits, I tend to hold off on them and provide a later
series covering just them.
3. Request to split by content (documentation, comments, local
variables, local functions, exported functions, database migrations,
...). This is considerably more expensive but managable. 

Note: for either 2 or 3, it's trivial for me to drop individual files,
paths, or file types. Just let me know.

For larger projects I tend to avoid enforcing en-GB/en-US (and I
certainly haven't in this series). If a project has a preference,
I'm willing to enforce it, however that tends to increase the
size/work by a bit. I mention this because this codebase has at least
`initialize*` and `initialise*` amongst others.

Most of the word replacements were selected automatically using Google
Sheets. 

I've generally tried to avoid messing up formatting. This means that
I've tried to extend `-`d lines in `.rst` files. I've also tried to
ensure that my changed text wraps at what appears to be the right
column boundaries. After I did this, I noticed that the codebase
doesn't appear to be as strict as I expected -- I decided to leave my
changes, but again, because they're locally in distinct commits, it
isn't a big deal for me to undo that.

Occasionally codebases have intentional misspellings (sometimes
whimsical and sometimes for tests). I try not to break either form.
For this codebase, I didn't trip on any of the former, but I did run
across one instance of the latter. Personally I'd encourage using
a `word_` instead of `werd` when trying to show how a non-matching
term is handled. In this case, I believe I just left it alone.

For tooling reasons, you can see all the words I left alone [4].

Other flags...
There's at least one license block changed:
build-aux/cccl [5]. Generally lawyers get really anxious about such
changes.

Some projects are very particular about whitespace (typically those
written in golang). This project didn't seem to be very sensitive,
however I did try to fix some macro lines which my changes naturally
disturbed.

[1] https://github.com/jsoref/ovs/commits/spelling
[2] https://github.com/jsoref/ovs/commit/c54e32b478eda002cfda4961f19e420835c4410b#commitcomment-61795206
[3] https://check-spelling.dev/
[4] https://github.com/jsoref/ovs/blob/c54e32b478eda002cfda4961f19e420835c4410b/.github/actions/spelling/expect.txt
[5] https://github.com/jsoref/ovs/blame/spelling/build-aux/cccl#L72

Josh Soref (1):
  Spelling

 .ci/linux-build.sh                            |  4 ++--
 Documentation/howto/ipsec.rst                 |  2 +-
 Documentation/howto/sflow.rst                 |  2 +-
 Documentation/intro/install/afxdp.rst         |  4 ++--
 Documentation/intro/install/fedora.rst        |  4 ++--
 Documentation/intro/install/general.rst       |  2 +-
 Documentation/intro/install/windows.rst       |  4 ++--
 Documentation/intro/install/xenserver.rst     |  2 +-
 Documentation/ref/ovs-actions.7.rst           |  2 +-
 Documentation/topics/design.rst               |  2 +-
 Documentation/topics/dpdk/bridge.rst          |  6 ++---
 Documentation/topics/dpdk/pmd.rst             |  6 ++---
 Documentation/topics/dpdk/vhost-user.rst      |  2 +-
 Documentation/topics/integration.rst          |  2 +-
 Documentation/topics/openflow.rst             |  2 +-
 Documentation/topics/ovsdb-relay.rst          |  2 +-
 Documentation/topics/porting.rst              |  2 +-
 Documentation/topics/testing.rst              |  4 ++--
 Documentation/tutorials/ovs-advanced.rst      |  2 +-
 Documentation/tutorials/ovs-conntrack.rst     |  2 +-
 NEWS                                          | 14 +++++------
 acinclude.m4                                  |  2 +-
 build-aux/cccl                                |  2 +-
 datapath-windows/include/OvsDpInterfaceExt.h  |  2 +-
 datapath-windows/ovsext/Actions.c             | 12 +++++-----
 datapath-windows/ovsext/BufferMgmt.c          |  6 ++---
 datapath-windows/ovsext/Conntrack-nat.c       |  6 ++---
 datapath-windows/ovsext/Conntrack.c           |  2 +-
 datapath-windows/ovsext/Conntrack.h           |  2 +-
 datapath-windows/ovsext/Datapath.c            | 14 +++++------
 datapath-windows/ovsext/Datapath.h            |  4 ++--
 datapath-windows/ovsext/Ethernet.h            |  2 +-
 datapath-windows/ovsext/Flow.c                |  8 +++----
 datapath-windows/ovsext/IpFragment.c          |  2 +-
 datapath-windows/ovsext/IpHelper.c            |  2 +-
 datapath-windows/ovsext/NetProto.h            |  4 ++--
 datapath-windows/ovsext/Netlink/Netlink.c     |  8 +++----
 datapath-windows/ovsext/Netlink/NetlinkBuf.c  |  6 ++---
 datapath-windows/ovsext/Offload.c             | 22 ++++++++---------
 datapath-windows/ovsext/Oid.c                 |  2 +-
 datapath-windows/ovsext/Stt.c                 |  2 +-
 datapath-windows/ovsext/Switch.c              |  2 +-
 datapath-windows/ovsext/Switch.h              |  2 +-
 datapath-windows/ovsext/Tunnel.c              |  4 ++--
 datapath-windows/ovsext/TunnelFilter.c        |  4 ++--
 datapath-windows/ovsext/User.c                | 12 +++++-----
 datapath-windows/ovsext/Vport.c               | 10 ++++----
 datapath-windows/ovsext/Vport.h               |  2 +-
 datapath/conntrack.c                          |  2 +-
 datapath/datapath.h                           |  2 +-
 datapath/flow.c                               |  2 +-
 datapath/flow_netlink.c                       |  2 +-
 datapath/flow_table.c                         |  4 ++--
 datapath/linux/compat/exthdrs_core.c          |  2 +-
 datapath/linux/compat/include/linux/if_vlan.h |  2 +-
 datapath/linux/compat/include/linux/kconfig.h |  2 +-
 .../linux/compat/include/linux/openvswitch.h  |  8 +++----
 datapath/linux/compat/include/linux/udp.h     |  2 +-
 datapath/linux/compat/include/net/erspan.h    |  4 ++--
 datapath/linux/compat/include/net/ipv6.h      |  2 +-
 datapath/linux/compat/include/net/udp.h       |  2 +-
 .../linux/compat/include/net/udp_tunnel.h     |  2 +-
 datapath/linux/compat/ip6_gre.c               |  4 ++--
 datapath/linux/compat/ip6_output.c            |  2 +-
 datapath/linux/compat/ip6_tunnel.c            |  2 +-
 datapath/linux/compat/ip_gre.c                |  4 ++--
 datapath/linux/compat/ip_output.c             |  2 +-
 datapath/linux/compat/nf_conntrack_proto.c    |  2 +-
 datapath/linux/compat/stt.c                   |  2 +-
 datapath/vport.h                              |  2 +-
 debian/changelog                              |  8 +++----
 debian/openvswitch-ipsec.init                 |  2 +-
 debian/openvswitch-testcontroller.init        |  2 +-
 include/linux/tc_act/tc_pedit.h               |  2 +-
 include/openflow/nicira-ext.h                 |  6 ++---
 include/openflow/openflow-1.0.h               |  2 +-
 include/openvswitch/meta-flow.h               |  2 +-
 include/openvswitch/ofp-actions.h             |  2 +-
 include/windows/netinet/icmp6.h               |  4 ++--
 ipsec/ovs-monitor-ipsec.in                    | 10 ++++----
 lib/bfd.c                                     |  6 ++---
 lib/ccmap.c                                   |  2 +-
 lib/classifier.c                              |  2 +-
 lib/conntrack.h                               |  2 +-
 lib/ct-dpif.c                                 |  4 ++--
 lib/daemon-unix.c                             | 14 +++++------
 lib/daemon-windows.c                          |  2 +-
 lib/db-ctl-base.c                             |  4 ++--
 lib/db-ctl-base.h                             |  2 +-
 lib/db-ctl-base.man                           |  2 +-
 lib/dns-resolve.c                             |  2 +-
 lib/dp-packet.h                               |  2 +-
 lib/dpctl.c                                   |  6 ++---
 lib/dpctl.man                                 |  4 ++--
 lib/dpdk.c                                    |  2 +-
 lib/dpif-netdev-avx512.c                      |  6 ++---
 lib/dpif-netdev-extract-avx512.c              |  6 ++---
 lib/dpif-netdev-extract-study.c               |  2 +-
 lib/dpif-netdev-private-extract.c             |  6 ++---
 lib/dpif-netdev-private-extract.h             |  2 +-
 lib/dpif-netdev-unixctl.man                   |  4 ++--
 lib/dpif-netdev.c                             | 14 +++++------
 lib/dpif-netlink.c                            |  8 +++----
 lib/dpif-provider.h                           |  2 +-
 lib/dpif.c                                    |  4 ++--
 lib/flow.c                                    |  2 +-
 lib/ipf.c                                     | 16 ++++++-------
 lib/lacp.h                                    |  2 +-
 lib/lldp/lldp.c                               |  4 ++--
 lib/mac-learning.c                            |  2 +-
 lib/match.c                                   |  2 +-
 lib/meta-flow.c                               |  6 ++---
 lib/netdev-bsd.c                              |  2 +-
 lib/netdev-dpdk.c                             | 24 +++++++++----------
 lib/netdev-dummy.c                            |  2 +-
 lib/netdev-linux.c                            |  2 +-
 lib/netdev-offload-dpdk.c                     |  2 +-
 lib/netdev-offload-provider.h                 |  2 +-
 lib/netdev-offload.h                          |  4 ++--
 lib/netdev-provider.h                         |  2 +-
 lib/netdev.h                                  |  6 ++---
 lib/netlink-conntrack.c                       |  2 +-
 lib/odp-util.c                                |  2 +-
 lib/ofp-actions.c                             |  2 +-
 lib/ofp-flow.c                                |  2 +-
 lib/ofp-match.c                               |  2 +-
 lib/ovs-atomic-i586.h                         |  4 ++--
 lib/ovs-atomic-x86_64.h                       |  2 +-
 lib/ovs-atomic.h                              |  2 +-
 lib/ovs-rcu.c                                 |  2 +-
 lib/ovs-rcu.h                                 |  4 ++--
 lib/ovs-replay.c                              |  2 +-
 lib/ovs-replay.h                              |  2 +-
 lib/ovsdb-cs.c                                |  2 +-
 lib/ovsdb-data.c                              |  2 +-
 lib/ovsdb-idl.c                               |  6 ++---
 lib/packets.c                                 |  4 ++--
 lib/perf-counter.c                            |  2 +-
 lib/perf-counter.h                            |  2 +-
 lib/pvector.c                                 |  2 +-
 lib/rconn.c                                   |  2 +-
 lib/seq.h                                     |  2 +-
 lib/sflow.h                                   |  6 ++---
 lib/sflow_agent.c                             | 10 ++++----
 lib/sflow_poller.c                            |  6 ++---
 lib/sflow_receiver.c                          |  6 ++---
 lib/stream.c                                  |  2 +-
 lib/tc.c                                      |  2 +-
 lib/tun-metadata.c                            |  2 +-
 lib/util.c                                    |  2 +-
 lib/wmi.c                                     |  6 ++---
 m4/openvswitch.m4                             |  6 ++---
 m4/pkg.m4                                     |  2 +-
 ofproto/bond.c                                |  4 ++--
 ofproto/connmgr.c                             |  2 +-
 ofproto/ipfix.xml                             |  2 +-
 ofproto/netflow.c                             |  2 +-
 ofproto/ofproto-dpif-ipfix.c                  |  4 ++--
 ofproto/ofproto-dpif-rid.c                    |  4 ++--
 ofproto/ofproto-dpif-sflow.c                  |  4 ++--
 ofproto/ofproto-dpif-xlate.c                  |  2 +-
 ofproto/ofproto-dpif.c                        | 14 +++++------
 ofproto/ofproto-provider.h                    |  2 +-
 ofproto/ofproto.c                             |  6 ++---
 ovsdb/jsonrpc-server.c                        |  6 ++---
 ovsdb/log.h                                   |  2 +-
 ovsdb/monitor.c                               |  4 ++--
 ovsdb/ovsdb-client.c                          |  2 +-
 ovsdb/ovsdb-server.c                          |  2 +-
 ovsdb/ovsdb-tool.1.in                         |  4 ++--
 ovsdb/ovsdb-tool.c                            |  2 +-
 ovsdb/ovsdb.c                                 |  4 ++--
 ovsdb/ovsdb.h                                 |  2 +-
 ovsdb/raft.c                                  |  4 ++--
 ovsdb/relay.c                                 |  2 +-
 ovsdb/replication.c                           |  4 ++--
 ovsdb/replication.h                           |  2 +-
 poc/playbook-centos-builder.yml               |  2 +-
 poc/playbook-fedora-builder.yml               |  2 +-
 poc/playbook-ubuntu-builder.yml               |  2 +-
 .../ovs/compat/sortedcontainers/sorteddict.py |  2 +-
 python/ovs/db/idl.py                          |  8 +++----
 python/ovs/stream.py                          |  2 +-
 python/ovs/vlog.py                            |  2 +-
 python/ovstest/rpcserver.py                   |  4 ++--
 rhel/kmod-openvswitch-rhel6.spec.in           |  2 +-
 rhel/openvswitch-fedora.spec.in               |  2 +-
 rhel/openvswitch-kmod-fedora.spec.in          |  6 ++---
 tests/atlocal.in                              |  2 +-
 tests/bfd.at                                  | 22 ++++++++---------
 tests/cfm.at                                  | 14 +++++------
 tests/dpif-netdev.at                          |  6 ++---
 tests/json.at                                 |  2 +-
 tests/mpls-xlate.at                           |  2 +-
 tests/ofproto-dpif.at                         | 16 ++++++-------
 tests/ofproto.at                              |  6 ++---
 tests/ovs-macros.at                           |  8 +++----
 tests/ovs-ofctl.at                            |  2 +-
 tests/ovs-vswitchd.at                         |  2 +-
 tests/ovsdb-idl.at                            | 10 ++++----
 tests/ovsdb-lock.at                           |  4 ++--
 tests/ovsdb-query.at                          |  2 +-
 tests/ovsdb-server.at                         |  8 +++----
 tests/ovstest.c                               |  2 +-
 tests/ovstest.h                               |  2 +-
 tests/packet-type-aware.at                    |  6 ++---
 tests/pmd.at                                  |  4 ++--
 tests/stp.at                                  |  4 ++--
 tests/system-interface.at                     |  2 +-
 tests/system-offloads-traffic.at              |  2 +-
 tests/system-traffic.at                       | 16 ++++++-------
 tests/test-classifier.c                       |  2 +-
 tests/test-json.c                             |  6 ++---
 tests/test-netlink-policy.c                   |  2 +-
 tests/test-ovsdb.c                            |  4 ++--
 tests/test-ovsdb.py                           |  6 ++---
 tests/test-util.c                             |  6 ++---
 tests/tunnel-push-pop-ipv6.at                 |  2 +-
 tests/tunnel.at                               |  2 +-
 .../ovs-bugtool-ovs-ofctl-loop-over-bridges   |  6 ++---
 utilities/ovs-appctl-bashcomp.bash            |  4 ++--
 utilities/ovs-appctl.c                        |  2 +-
 utilities/ovs-ctl.in                          |  2 +-
 utilities/ovs-ofctl.8.in                      | 12 +++++-----
 utilities/ovs-pipegen.py                      |  2 +-
 utilities/ovs-vsctl-bashcomp.bash             |  4 ++--
 utilities/ovs-vsctl.c                         |  4 ++--
 vswitchd/bridge.c                             |  6 ++---
 vswitchd/vswitch.xml                          | 14 +++++------
 vtep/ovs-vtep.in                              |  2 +-
 vtep/vtep.xml                                 |  8 +++----
 .../ovs-windows-installer.wixproj             |  8 +++----
 ..._xensource_libexec_InterfaceReconfigure.py |  2 +-
 ...pt_xensource_libexec_interface-reconfigure |  2 +-
 234 files changed, 490 insertions(+), 490 deletions(-)