From patchwork Sat Aug 26 08:07:42 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Guru Das Srinagesh X-Patchwork-Id: 718134 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 6B901C83F11 for ; Sat, 26 Aug 2023 08:09:21 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232048AbjHZIIy (ORCPT ); Sat, 26 Aug 2023 04:08:54 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:35392 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232081AbjHZIIW (ORCPT ); Sat, 26 Aug 2023 04:08:22 -0400 Received: from mx0b-0031df01.pphosted.com (mx0b-0031df01.pphosted.com [205.220.180.131]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 562E41FF0; Sat, 26 Aug 2023 01:08:19 -0700 (PDT) Received: from pps.filterd (m0279871.ppops.net [127.0.0.1]) by mx0a-0031df01.pphosted.com (8.17.1.19/8.17.1.19) with ESMTP id 37Q81E2g002453; Sat, 26 Aug 2023 08:07:53 GMT DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=quicinc.com; h=from : to : cc : subject : date : message-id : in-reply-to : references : mime-version : content-transfer-encoding : content-type; s=qcppdkim1; bh=toTSUxSzKHK82dJG3FdjsK0wlkEXyaoeC5l4iBCP/fY=; b=fizWYDkf09KXMVX5fgKhDjRJz+GZx5PqSGFin5xgbucjMstQun3n7XsUYtTrPliUSs5i H5bSlwFjVoLKXZGjkZ16tzOqPGmwE0LoRtdm0Z7vpYhbscwOU7Z5i3lAcibrX0Q+rsmb pXKcqri3/6AGCZY0s8iENO0moXpyiF1KXTDb1MaPDzAaQ2JQg00q5wgX8kVQJDYjhAIu kx+jnEQJN4AwScSABfoQZzTJqE4iiIVjsN5wiEMD6nqLspwiv4tEzU3Kb49ndwQ0gTay 06uvqVgWIQoO6jzReKb//6zt7S2VMUXkPTUYA+KxF47eO7Ex9A84Vov2Y8MHrNjIGoD3 wQ== Received: from nasanppmta04.qualcomm.com (i-global254.qualcomm.com [199.106.103.254]) by mx0a-0031df01.pphosted.com (PPS) with ESMTPS id 3sq907g91x-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Sat, 26 Aug 2023 08:07:53 +0000 Received: from nasanex01b.na.qualcomm.com (nasanex01b.na.qualcomm.com [10.46.141.250]) by NASANPPMTA04.qualcomm.com (8.17.1.5/8.17.1.5) with ESMTPS id 37Q87qI0023779 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Sat, 26 Aug 2023 08:07:52 GMT Received: from hu-gurus-sd.qualcomm.com (10.80.80.8) by nasanex01b.na.qualcomm.com (10.46.141.250) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.1118.36; Sat, 26 Aug 2023 01:07:49 -0700 From: Guru Das Srinagesh To: Masahiro Yamada , Nick Desaulniers , Andrew Morton , "Nicolas Schier" , Konstantin Ryabitsev , Kees Cook , "Bjorn Andersson" , , , Will Deacon , "Greg Kroah-Hartman" , CC: , , , , , , , , "Guru Das Srinagesh" Subject: [PATCH v3 1/1] scripts: Add add-maintainer.py Date: Sat, 26 Aug 2023 01:07:42 -0700 Message-ID: <141b9fcab2208ace3001df4fc10e3dfd42b9f5d9.1693037031.git.quic_gurus@quicinc.com> X-Mailer: git-send-email 2.41.0 In-Reply-To: References: MIME-Version: 1.0 X-Originating-IP: [10.80.80.8] X-ClientProxiedBy: nasanex01a.na.qualcomm.com (10.52.223.231) To nasanex01b.na.qualcomm.com (10.46.141.250) X-QCInternal: smtphost X-Proofpoint-Virus-Version: vendor=nai engine=6200 definitions=5800 signatures=585085 X-Proofpoint-GUID: FVDnSdgPZtRCDd6m7P3bOpnVoPIOH3MY X-Proofpoint-ORIG-GUID: FVDnSdgPZtRCDd6m7P3bOpnVoPIOH3MY X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.267,Aquarius:18.0.957,Hydra:6.0.601,FMLib:17.11.176.26 definitions=2023-08-26_05,2023-08-25_01,2023-05-22_02 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 clxscore=1015 suspectscore=0 mlxlogscore=999 bulkscore=0 phishscore=0 adultscore=0 spamscore=0 mlxscore=0 impostorscore=0 priorityscore=1501 malwarescore=0 lowpriorityscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2308100000 definitions=main-2308260074 Precedence: bulk List-ID: X-Mailing-List: linux-pm@vger.kernel.org This script runs get_maintainer.py on a given patch file (or multiple patch files) and adds its output to the patch file in place with the appropriate email headers "To: " or "Cc: " as the case may be. These new headers are added after the "From: " line in the patch. Currently, for a single patch, maintainers and reviewers are added as "To: ", mailing lists and all other roles are added as "Cc: ". For a series of patches, however, a set-union scheme is employed in order to solve the all-too-common problem of ending up sending only subsets of a patch series to some lists, which results in important pieces of context such as the cover letter (or other patches in the series) being dropped from those lists. This scheme is as follows: - Create set-union of all maintainers and reviewers from all patches and use this to do the following per patch: - add only that specific patch's maintainers and reviewers as "To: " - add the other maintainers and reviewers from the other patches as "Cc: " - Create set-union of all mailing lists corresponding to all patches and add this to all patches as "Cc: " - Create set-union of all other roles corresponding to all patches and add this to all patches as "Cc: " Please note that patch files that don't have any "Maintainer"s or "Reviewers" explicitly listed in their `get_maintainer.pl` output will not have any "To: " entries added to them; developers are expected to manually make edits to the added entries in such cases to convert some "Cc: " entries to "To: " as desired. The script is quiet by default (only prints errors) and its verbosity can be adjusted via an optional parameter. Signed-off-by: Guru Das Srinagesh --- MAINTAINERS | 5 ++ scripts/add-maintainer.py | 164 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 169 insertions(+) create mode 100755 scripts/add-maintainer.py diff --git a/MAINTAINERS b/MAINTAINERS index 0903d87b17cb..b670e9733f03 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -8721,6 +8721,11 @@ M: Joe Perches S: Maintained F: scripts/get_maintainer.pl +ADD MAINTAINER SCRIPT +M: Guru Das Srinagesh +S: Maintained +F: scripts/add-maintainer.py + GFS2 FILE SYSTEM M: Bob Peterson M: Andreas Gruenbacher diff --git a/scripts/add-maintainer.py b/scripts/add-maintainer.py new file mode 100755 index 000000000000..5a5cc9482b06 --- /dev/null +++ b/scripts/add-maintainer.py @@ -0,0 +1,164 @@ +#! /usr/bin/env python3 + +import argparse +import logging +import os +import sys +import subprocess +import re + +def gather_maintainers_of_file(patch_file): + all_entities_of_patch = dict() + + # Run get_maintainer.pl on patch file + logging.info("GET: Patch: {}".format(os.path.basename(patch_file))) + cmd = ['scripts/get_maintainer.pl'] + cmd.extend([patch_file]) + + try: + p = subprocess.run(cmd, stdout=subprocess.PIPE, check=True) + except: + sys.exit(1) + + logging.debug("\n{}".format(p.stdout.decode())) + + entries = p.stdout.decode().splitlines() + + maintainers = [] + lists = [] + others = [] + + for entry in entries: + entity = entry.split('(')[0].strip() + if any(role in entry for role in ["maintainer", "reviewer"]): + maintainers.append(entity) + elif "list" in entry: + lists.append(entity) + else: + others.append(entity) + + all_entities_of_patch["maintainers"] = set(maintainers) + all_entities_of_patch["lists"] = set(lists) + all_entities_of_patch["others"] = set(others) + + return all_entities_of_patch + +def find_pattern_in_lines(pattern, lines): + index = 0 + for line in lines: + if re.search(pattern, line): + break; + index = index + 1 + + if index == len(lines): + logging.error("Couldn't find pattern {} in patch".format(pattern)) + sys.exit(1) + + return index + +def add_maintainers_to_file(patch_file, entities_per_file, all_entities_union): + logging.info("ADD: Patch: {}".format(os.path.basename(patch_file))) + + # For each patch: + # - Add all lists from all patches in series as Cc: + # - Add all others from all patches in series as Cc: + # - Add only maintainers of that patch as To: + # - Add maintainers of other patches in series as Cc: + + lists = list(all_entities_union["all_lists"]) + others = list(all_entities_union["all_others"]) + file_maintainers = all_entities_union["all_maintainers"].intersection(entities_per_file[os.path.basename(patch_file)].get("maintainers")) + other_maintainers = all_entities_union["all_maintainers"].difference(entities_per_file[os.path.basename(patch_file)].get("maintainers")) + + # Specify email headers appropriately + cc_lists = ["Cc: " + l for l in lists] + cc_others = ["Cc: " + o for o in others] + to_maintainers = ["To: " + m for m in file_maintainers] + cc_maintainers = ["Cc: " + om for om in other_maintainers] + logging.debug("Cc Lists:\n{}".format('\n'.join(cc_lists))) + logging.debug("Cc Others:\n{}".format('\n'.join(cc_others))) + logging.debug("Cc Maintainers:\n{}".format('\n'.join(cc_maintainers) or None)) + logging.debug("To Maintainers:\n{}\n".format('\n'.join(to_maintainers) or None)) + + # Edit patch file in place to add maintainers + with open(patch_file, "r") as pf: + lines = pf.readlines() + + # Get the index of the first "From: " line in patch + from_line = find_pattern_in_lines("^(From: )(.*)<(.*)@(.*)>", lines) + + # Insert our To: and Cc: headers after it. + next_line_after_from = from_line + 1 + + for l in cc_lists: + lines.insert(next_line_after_from, l + "\n") + for o in cc_others: + lines.insert(next_line_after_from, o + "\n") + for om in cc_maintainers: + lines.insert(next_line_after_from, om + "\n") + for m in to_maintainers: + lines.insert(next_line_after_from, m + "\n") + + with open(patch_file, "w") as pf: + pf.writelines(lines) + +def add_maintainers(patch_files): + entities_per_file = dict() + + for patch in patch_files: + entities_per_file[os.path.basename(patch)] = gather_maintainers_of_file(patch) + + all_entities_union = {"all_maintainers": set(), "all_lists": set(), "all_others": set()} + for patch in patch_files: + all_entities_union["all_maintainers"] = all_entities_union["all_maintainers"].union(entities_per_file[os.path.basename(patch)].get("maintainers")) + all_entities_union["all_lists"] = all_entities_union["all_lists"].union(entities_per_file[os.path.basename(patch)].get("lists")) + all_entities_union["all_others"] = all_entities_union["all_others"].union(entities_per_file[os.path.basename(patch)].get("others")) + + for patch in patch_files: + add_maintainers_to_file(patch, entities_per_file, all_entities_union) + + logging.info("Maintainers added to all patch files successfully") + +def remove_to_cc_from_header(patch_files): + for patch in patch_files: + logging.info("UNDO: Patch: {}".format(os.path.basename(patch))) + with open(patch, "r") as pf: + lines = pf.readlines() + + # Get the index of the first "From: " line in patch + from_line = find_pattern_in_lines("^(From: )(.*)<(.*)@(.*)>", lines) + + # Get the index of the first "Date: " line in patch + date_line = find_pattern_in_lines("^(Date: )", lines) + + # Delete everything in between From: and Date: + # These are the lines that this script adds - any To: or Cc: anywhere + # else in the patch will not be removed. + del lines[(from_line + 1):date_line] + + with open(patch, "w") as pf: + pf.writelines(lines) + + logging.info("Maintainers removed from all patch files successfully") + +def main(): + parser = argparse.ArgumentParser(description='Add the respective maintainers and mailing lists to patch files') + parser.add_argument('patches', nargs='+', help="One or more patch files") + parser.add_argument('-v', '--verbosity', choices=['debug', 'info', 'error'], default='error', help="Verbosity level of script output") + parser.add_argument('-u', '--undo', action='store_true', help="Remove maintainers added by this script from patch(es)") + args = parser.parse_args() + + logging.basicConfig(level=args.verbosity.upper(), format='%(levelname)s: %(message)s') + + for patch in args.patches: + if not os.path.isfile(patch): + logging.error("File does not exist: {}".format(patch)) + sys.exit(1) + + if args.undo: + remove_to_cc_from_header(args.patches) + else: + add_maintainers(args.patches) + +if __name__ == "__main__": + main()