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 DAB0F428C4; Thu, 6 Apr 2023 01:29:36 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 2F69440F18; Thu, 6 Apr 2023 01:29:36 +0200 (CEST) Received: from mail-pj1-f47.google.com (mail-pj1-f47.google.com [209.85.216.47]) by mails.dpdk.org (Postfix) with ESMTP id D0E0040DF6 for ; Thu, 6 Apr 2023 01:29:34 +0200 (CEST) Received: by mail-pj1-f47.google.com with SMTP id q102so35593105pjq.3 for ; Wed, 05 Apr 2023 16:29:34 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=networkplumber-org.20210112.gappssmtp.com; s=20210112; t=1680737373; x=1683329373; 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=JN32LOUFyk33zKoUU5PXLvEltY7CpRWW6XUu2oeeAWw=; b=mvXaLnOCYabREHDNV3GeED2XLqUeXel1ZTaP+ghDEHFzF8jG7dOOvW7/wPan4V5BCZ tI3Pmj2/0WhXdeL1gLcaGalVdMKMOhGPzXGYEMoiK4qCT7sZqf+Xs+MXGAp7yzaAliFV uxSvSWcsKbGpWfmOQXxutVnKVS83+HBlQJf2AcxAmDGBu8JEjTlgO4bukZAMn9yrASOr tawBayjNhADMSY3l2a2G97Zm20sV3LRmfl1aY59HfucpEbXcfBlZAtX4A46gNNaG+afZ dr2uvi8kbFYfC+b2h8q4fMl9on1fisUh+a90C9d/uavdWSvgpujalwLr/eykbGJEyKTn gHpA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; t=1680737373; x=1683329373; 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=JN32LOUFyk33zKoUU5PXLvEltY7CpRWW6XUu2oeeAWw=; b=z+rcatyd/5h+MvRdzTdUk29IlSjlhoe7MAZDiNusCBP5CKtIo7DVeFPvh9lLE9Vt/t Scjo9r6lNvrxOtvjoReSzOA0M+F1YAhfh9VIVD3eVkZv9dNGXx8swnEZNrz16D8y/QXu IXD/QJZaM4bZ+UebHLusw/XvDomPF+2wsswZ3KqGdXUoeweykuop3nhum6ngu4oC5UUD YPs6eLM1fFL9ulFkhj+gJ1FlHCla6IWofXHFoEOJ4NuGeoskTxnVMf6SUFZGOP0e929L Ya/xXSKG6gsP7gZOWfoWZVbXyoFVhdTI8NDF/nRbT8C0Y9O/M1iCpN52QxvI1n3zG8iy spwQ== X-Gm-Message-State: AAQBX9dbob77Nsx1Jfc5bzlhaJsJhImax6A3HQJpENghWI010VkFS8yh w8r9l4yjRffbySen74FEXhp/RAIxeYLgT0MHc1sEMA== X-Google-Smtp-Source: AKy350ZJrEb7zhLRuIGuzLyDpUihPAH9uGNub7rhP2GNGrEuHHTq8fjapCcoMx5adLqNeCilwpZEPQ== X-Received: by 2002:a17:902:c951:b0:1a2:22df:8597 with SMTP id i17-20020a170902c95100b001a222df8597mr10084676pla.57.1680737373080; Wed, 05 Apr 2023 16:29:33 -0700 (PDT) Received: from hermes.local (204-195-120-218.wavecable.com. [204.195.120.218]) by smtp.gmail.com with ESMTPSA id c9-20020a170902848900b0019aa8149cb9sm72991plo.79.2023.04.05.16.29.32 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 05 Apr 2023 16:29:32 -0700 (PDT) From: Stephen Hemminger To: dev@dpdk.org Cc: Stephen Hemminger Subject: [PATCH v3] devtools: add script to check for non inclusive naming Date: Wed, 5 Apr 2023 16:29:30 -0700 Message-Id: <20230405232930.15202-1-stephen@networkplumber.org> X-Mailer: git-send-email 2.39.2 In-Reply-To: <0230331200824.195294-1-stephen@networkplumber.org> References: <0230331200824.195294-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 Script to find words that should not be used. Really just a wrapper around git grep command. By default it prints matches. Uses the word lists from Inclusive Naming Initiative see https://inclusivenaming.org/word-lists/ Examples: $ ./devtools/check-naming-policy.sh -c app/test-compress-perf/comp_perf_test_cyclecount.c:1 uapp/test-compress-perf/comp_perf_test_throughput.c:1 app/test-compress-perf/comp_perf_test_verify.c:1 app/test/test_common.c:1 ... $ ./devtools/check-naming-policy.py lib/pcapng lib/pcapng/rte_pcapng.c: /* sanity check that is really a pcapng mbuf */ $ ./devtools/check-naming-policy.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/include/generic/rte_power_intrinsics.h lib/eal/include/generic/rte_rwlock.h lib/eal/include/generic/rte_spinlock.h lib/eal/include/rte_debug.h lib/eal/include/rte_seqlock.h lib/eal/linux/eal.c lib/eal/windows/eal.c lib/eal/x86/include/rte_rtm.h lib/eal/x86/include/rte_spinlock.h lib/eal/x86/rte_power_intrinsics.c $ ./devtools/check-inclusive-naming -h usage: check-inclusive-naming.py [-h] [-c] [-d] [-l] [-t {0,1,2,3}] [-x EXCLUDE] [--url URL] [paths ...] Identify word usage not aligned with inclusive naming positional arguments: paths files and directory to scan options: -h, --help show this help message and exit -c, --count Show the nuber of lines that match -d, --debug Debug this script -l, --files-with-matches Show only names of files with hits -t {0,1,2,3}, --tier {0,1,2,3} Show non-conforming words of particular tier -x EXCLUDE, --exclude EXCLUDE Exclude path from scan --url URL URL for the non-inclusive naming word list Signed-off-by: Stephen Hemminger --- v3 - use python instead of shell and rework UI fetch list of words rather than recording them here MAINTAINERS | 1 + devtools/check-inclusive-naming.py | 125 +++++++++++++++++++++++++++++ 2 files changed, 126 insertions(+) create mode 100755 devtools/check-inclusive-naming.py diff --git a/MAINTAINERS b/MAINTAINERS index 8df23e50999f..141d70596020 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 000000000000..522bae683d60 --- /dev/null +++ b/devtools/check-inclusive-naming.py @@ -0,0 +1,125 @@ +#!/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 bavoide by the +# Inclusive Naming Initiative. +# See: https://inclusivenaming.org/word-lists/ + +import argparse +import subprocess +from urllib.request import urlopen +import json + +naming_url = 'https://inclusivenaming.org/word-lists/index.json' + +# These give false positives +dont_scan = [ + 'doc/guides/rel_notes/', + 'doc/guides/contributing/coding_style.rst' + 'doc/guides/prog_guide/glossary.rst' +] + + +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 nuber 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=dont_scan, + action='append', + help="Exclude path from scan") + parser.add_argument('--url', + default=naming_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" + + response = urlopen(url) + # The wordlist is returned as JSON like: + # { + # "data" : + # [ + # { + # "term": "abort", + # "tier" : "1", + # "recommendation": "Replace when possible.", + # ... + entries = json.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('-', '[- ]') + 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("Matching on {} words".format(len(wordlist))) + + 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('--') + # convert the dont_scan paths to regexp + for path in dont_scan: + cmd.append(':^{}'.format(path)) + cmd += args.paths + if args.debug: + print(cmd) + subprocess.run(cmd) + + +def main(): + process(args_parse()) + + +if __name__ == "__main__": + main() -- 2.39.2