From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 3F82743272; Thu, 2 Nov 2023 21:58:57 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id C106140262; Thu, 2 Nov 2023 21:58:56 +0100 (CET) Received: from mail-pf1-f173.google.com (mail-pf1-f173.google.com [209.85.210.173]) by mails.dpdk.org (Postfix) with ESMTP id B542640144 for ; Thu, 2 Nov 2023 21:58:55 +0100 (CET) Received: by mail-pf1-f173.google.com with SMTP id d2e1a72fcca58-6c3077984e8so1363822b3a.0 for ; Thu, 02 Nov 2023 13:58:55 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=networkplumber-org.20230601.gappssmtp.com; s=20230601; t=1698958734; x=1699563534; darn=dpdk.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=kTLJiBO+FIchf6Mc9T58v40qV0SNXTdbizwt0ctta2g=; b=ig0rfjIe4sw5Rr7lcakzRD1YvNsBMn6msYww4Udq20SiglyBjzU1weu4OpDwCqW4SL Al6SUKzHZjIvUU9q0vTuf9a9KUiDX5r050mIUA57JfO0UQL1amT+GvsBxisnHleFLY4W CSQR0O2HogXPiFHki7+xDi+4HJXxECNXWmjdnCQjVvWWVEdKNb6ocnug0cGnX/HA6nJP zQ3iCWZeilXMMReNqFHIOAxYbCIe2+KhF5Fei8ccooMCeyGSHfRhBfgFgVa2bUqr2oqU sIWOQpOz3DYaEXbfqpTrEYl4p3nBBTc3S1J7m7Dn667rRIlWBJaktDP5WX13rSWlLrZn EgXg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1698958734; x=1699563534; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=kTLJiBO+FIchf6Mc9T58v40qV0SNXTdbizwt0ctta2g=; b=eRqn6fRjo0o27Yasf/XfCeG4suhnhSK12VCnx0XxsjnIhkhHsIaXHhNFDdFJFf1YRA QdLmitMlW5PLHxOybJKREe4dCVg9FLtkvJinwL/YBj/WVQnFkKsy9M3BdseAZR5O6eQB mQkkwv/BL5y7VwCAi3FbG7qZC7Jq9sTW6RScTdHE0PYmXhjEebQfG6I7OTnZp3lW0UMu 5/K0T+7pRj9JvOtm3vf5IhjaRV+5zdaMh6I3Fr3k5fd6t1N7jOVCTP3VlwcJ9wG4yxXs L0H0PTYsjirLj3rz9HxZaC/g73SgcS4/TmWmZpg/M4vvjdSKLXrsXwtljLdaG+/RTiZy Hd2Q== X-Gm-Message-State: AOJu0YycdKR6iNBGTrKWEuy06FOe5Eewy38TWOGv8DISHVazi9mMdOhP vfpdWc6Q1ZqtehusR8U/mKwSettoyyjBbU+WgRuXhPv0 X-Google-Smtp-Source: AGHT+IFvyQ7JezxCucjm0X/RMw+jxjjzh7FGwAh2CGZs/LF4R7aJOV4ZJMytFuQ+sB25KFYAyv4IgQ== X-Received: by 2002:a05:6a21:3e02:b0:180:e3f1:4f60 with SMTP id bk2-20020a056a213e0200b00180e3f14f60mr9429344pzc.45.1698958734276; Thu, 02 Nov 2023 13:58:54 -0700 (PDT) Received: from fedora.. ([38.142.2.14]) by smtp.gmail.com with ESMTPSA id y63-20020a636442000000b005b9083b81f0sm164088pgb.36.2023.11.02.13.58.53 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 02 Nov 2023 13:58:53 -0700 (PDT) From: Stephen Hemminger To: dev@dpdk.org Cc: Stephen Hemminger Subject: [PATCH v8] devtools: add script to check for non inclusive naming Date: Thu, 2 Nov 2023 13:57:44 -0700 Message-ID: <20231102205850.27300-1-stephen@networkplumber.org> X-Mailer: git-send-email 2.41.0 In-Reply-To: <20231030223238.65044-1-stephen@networkplumber.org> References: <20231030223238.65044-1-stephen@networkplumber.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org New script to find words that should not be used. Really just a wrapper around git grep command. By default it prints matches but can also display counts. Uses the word lists from Inclusive Naming Initiative see https://inclusivenaming.org/word-lists/ Note: the list has extra comma at end of list of elements which is not valid in basic JSON but allowed in user-friendly JSON5 (https://json5.org/) and therefore needs the PyPi package for parsing json5 format. Examples: $ ./devtools/check-inclusive-naming.py -c | head -5 app/test/test_common.c:1 app/test/test_eal_flags.c:8 app/test/test_hash.c:1 app/test/test_hash_readwrite_lf_perf.c:1 app/test/test_link_bonding_mode4.c:1 $ ./devtools/check-inclusive-naming.py lib/pcapng lib/pcapng/rte_pcapng.c: /* sanity check that is really a pcapng mbuf */ $ ./devtools/check-inclusive-naming.py -l lib/eal lib/eal/common/eal_common_memory.c lib/eal/common/eal_common_proc.c lib/eal/common/eal_common_trace.c lib/eal/common/eal_memcfg.h lib/eal/common/rte_malloc.c lib/eal/freebsd/eal.c lib/eal/linux/eal.c lib/eal/windows/eal.c Signed-off-by: Stephen Hemminger --- v8 - more python cleanups and update commit message add list of allowed words (such as abort). MAINTAINERS | 1 + devtools/check-inclusive-naming.py | 135 +++++++++++++++++++++++++++++ 2 files changed, 136 insertions(+) create mode 100755 devtools/check-inclusive-naming.py diff --git a/MAINTAINERS b/MAINTAINERS index 4083658697..b53600ff51 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -89,6 +89,7 @@ F: devtools/check-doc-vs-code.sh F: devtools/check-dup-includes.sh F: devtools/check-maintainers.sh F: devtools/check-forbidden-tokens.awk +F: devtools/check-inclusive-naming.py F: devtools/check-git-log.sh F: devtools/check-spdx-tag.sh F: devtools/check-symbol-change.sh diff --git a/devtools/check-inclusive-naming.py b/devtools/check-inclusive-naming.py new file mode 100755 index 0000000000..e8989c3c9b --- /dev/null +++ b/devtools/check-inclusive-naming.py @@ -0,0 +1,135 @@ +#!/usr/bin/env python3 +# SPDX-License-Identifier: BSD-3-Clause +# Copyright 2023 Stephen Hemminger +# +# This script scans the source tree and creates list of files +# containing words that are recommended to be avoided by the +# Inclusive Naming Initiative. +# See: https://inclusivenaming.org/word-lists/ + +import argparse +import subprocess +from urllib.request import urlopen + +# Need JSON5 to be able to handle extra comma +import json5 + +DEFAULT_URL = 'https://inclusivenaming.org/word-lists/index.json' + +# These give false positives +skip_files = [ + 'doc/guides/rel_notes/', 'doc/guides/contributing/coding_style.rst', + 'doc/guides/prog_guide/glossary.rst' +] + +# These are allowed for now +allow_words = ['abort'] + + +def args_parse(): + "parse arguments and return the argument object back to main" + + parser = argparse.ArgumentParser( + description="Identify word usage not aligned with inclusive naming") + parser.add_argument('-c', + '--count', + help="Show the number of lines that match", + action='store_true') + parser.add_argument('-d', + '--debug', + default=False, + help="Debug this script", + action='store_true') + parser.add_argument('-l', + '--files-with-matches', + help="Show only names of files with hits", + action='store_true') + # note: tier 0 is "ok to use" + parser.add_argument('-t', + '--tier', + type=int, + choices=range(0, 4), + action='append', + help="Show non-conforming words of particular tier") + parser.add_argument('-x', + '--exclude', + default=skip_files, + action='append', + help="Exclude path from scan") + parser.add_argument('-a', + '--allow', + default=allow_words, + action='append', + help="Ignore these words") + parser.add_argument('--url', + default=DEFAULT_URL, + help="URL for the non-inclusive naming word list") + parser.add_argument('paths', nargs='*', help='files and directory to scan') + + return parser.parse_args() + + +def fetch_wordlist(url, tiers): + "Read list of words from inclusivenaming.org" + + # The wordlist is returned as JSON like: + # { + # "data" : + # [ + # { + # "term": "abort", + # "tier" : "1", + # "recommendation": "Replace when possible.", + # ... + with urlopen(url) as response: + entries = json5.loads(response.read())['data'] + + wordlist = [] + for item in entries: + tier = int(item['tier']) + if tiers.count(tier) > 0: + # convert minus sign to minus or space regex + pattern = item['term'].replace('-', '[- ]') + if not pattern in allow_words: + wordlist.append(pattern.lower()) + + return wordlist + + +def process(args): + "Find matching words" + + # Default to Tier 1, 2 and 3. + if args.tier: + tiers = args.tier + else: + tiers = list(range(1, 4)) + + wordlist = fetch_wordlist(args.url, tiers) + if args.debug: + print(f'Matching on {len(wordlist)} words') + + cmd = ['git', 'grep', '-i'] + if args.files_with_matches: + cmd.append('-l') + if args.count: + cmd.append('-c') + for word in wordlist: + cmd.append('-e') + cmd.append(word) + cmd.append('--') + for path in skip_files: + cmd.append(f':^{path}') + cmd += args.paths + if args.debug: + print(cmd) + subprocess.run(cmd, check=False) + + +def main(): + '''program main function''' + process(args_parse()) + + +if __name__ == "__main__": + main() -- 2.41.0