Message ID | 20240507201551.1455437-1-mmichels@redhat.com |
---|---|
Headers | show |
Series | Inclusive language changes for OVN code. | expand |
On Tue, May 7, 2024 at 10:16 PM Mark Michelson <mmichels@redhat.com> wrote: > There is a growing movement to be more inclusive in the language used in > code and its documentation. > > For this task, the following site was used to find a list of words that > should be avoided: https://inclusivenaming.org/word-lists/ . > > Each of their tier 1, tier 2, and tier 3 words were searched in the code > and replaced as necessary. > > Each commit is focused around the replacement of a single word from the > word lists. In each case, the commit message will explain if there are > any exceptions where the word was not replaced. > > There are some words you will find in the linked word list that are not > addressed at all in these commits: > > * "segregate": This words appears only in an old NEWS entry. Changing > this would be more odd than leaving it alone. Considering this is a > tier 3 word on the linked word list, I opted to leave it as-is. > * "man-in-the-middle": This appears in all ovn-*ctl utility manpages. > However, this is generated from an included file in the ovs submodule. > Therefore, changing this in OVN would require a change in OVS instead. > > The rest of the words in the list that are not addressed in this series > do not appear anywhere in the OVN repository, as far as I could find. > > Mark Michelson (4): > Inclusive language substitutions: "abort". > Inclusive language substitutions: "master". > Inclusive language substitutions: "blacklist/whitelist". > Inclusive language substitutions: "sanity-check". > > .ci/dpdk-prepare.sh | 2 +- > Documentation/topics/high-availability.rst | 2 +- > NEWS | 4 ++ > controller/chassis.c | 2 +- > controller/ha-chassis.c | 2 +- > controller/ovn-controller.8.xml | 4 +- > controller/ovn-controller.c | 6 +-- > ic/ovn-ic.c | 23 +++++---- > lib/inc-proc-eng.c | 38 +++++++------- > lib/inc-proc-eng.h | 12 ++--- > northd/inc-proc-northd.c | 4 +- > ovn-architecture.7.xml | 2 +- > ovn-nb.xml | 12 ++--- > ovn-sb.xml | 8 +-- > tests/ofproto-macros.at | 4 +- > tests/ovn-controller-vtep.at | 2 +- > tests/ovn-ic.at | 32 ++++++------ > tests/ovn-northd.at | 60 +++++++++++----------- > tests/ovn-performance.at | 4 +- > tests/ovn.at | 14 ++--- > tests/ovs-macros.at | 4 +- > tests/system-kmod-macros.at | 4 +- > tests/system-userspace-macros.at | 4 +- > utilities/ovn-appctl.8.xml | 4 +- > utilities/ovn-nbctl.c | 2 +- > 25 files changed, 131 insertions(+), 124 deletions(-) > > -- > 2.44.0 > > _______________________________________________ > dev mailing list > dev@openvswitch.org > https://mail.openvswitch.org/mailman/listinfo/ovs-dev > > The whole series looks good to me, thanks! Acked-by: Ales Musil <amusil@redhat.com>
On 5/22/24 09:46, Ales Musil wrote: > On Tue, May 7, 2024 at 10:16 PM Mark Michelson <mmichels@redhat.com> wrote: > >> There is a growing movement to be more inclusive in the language used in >> code and its documentation. >> >> For this task, the following site was used to find a list of words that >> should be avoided: https://inclusivenaming.org/word-lists/ . >> >> Each of their tier 1, tier 2, and tier 3 words were searched in the code >> and replaced as necessary. >> >> Each commit is focused around the replacement of a single word from the >> word lists. In each case, the commit message will explain if there are >> any exceptions where the word was not replaced. >> >> There are some words you will find in the linked word list that are not >> addressed at all in these commits: >> >> * "segregate": This words appears only in an old NEWS entry. Changing >> this would be more odd than leaving it alone. Considering this is a >> tier 3 word on the linked word list, I opted to leave it as-is. >> * "man-in-the-middle": This appears in all ovn-*ctl utility manpages. >> However, this is generated from an included file in the ovs submodule. >> Therefore, changing this in OVN would require a change in OVS instead. >> >> The rest of the words in the list that are not addressed in this series >> do not appear anywhere in the OVN repository, as far as I could find. >> [...] >> > The whole series looks good to me, thanks! > > Acked-by: Ales Musil <amusil@redhat.com> Thanks, Mark and Ales, I applied this to main! However, should we follow up with guidelines, similar to what OvS did? https://github.com/openvswitch/ovs/commit/df5e5cf4318a64019d0f9bdf4fbfb398d1757269 I admit I was surprised by some of the words in the list (not a native speaker here so that probably explains why). I'm definitely OK with changing them but I think it's good to have a reference we can go back to. What do you think? Thanks, Dumitru