[edk2-devel] [BIKESHEDDING-TARGET] BaseTools: add GetMaintainer.py helper script
Leif Lindholm
leif.lindholm at linaro.org
Wed Jun 12 11:19:51 UTC 2019
This is work-in-progress, but I figured it would be a good time to start
having a conversation about how we want it to work.
The script currently does nothing clever whatsoever with regards to
looking at historical contributors to the modified code - it only
performs a lookup in Maintainers.txt.
Known shortcomings:
- Does not provide any metainformation about why certain people
or mailing lists were picked.
- Does not reason about precedence of sections - all maintainers
for all sections that match a wildcard are returned.
- Does not substantially update Maintainers.txt.
- Does not implement the X: tag, to explicitly exclude subpaths.
(But scans for it.)
- The splitting of Maintainers.txt into sections is based on
directly adjacent lines starting with a valid tag (so I expect
Star is left out from MdeModulePkg hits, and OvmfPkg loses most
of its Reviewers. (My feeling is this is valid, and Maintainers.txt
should change - certainly all the problematic lines would become
redundant with this format change.)
Supported wildcards are '*' and '?' - there is no special treatment of
trailing '/' at this point.
Oh, and like 'SetupGit.py', it requires the gitpython module.
Laszlo: if you could provide some english language description of how
the path (F:) format is supposed to work, and how you think section
precedence should happen, I can implement that.
The qemu MAINTAINERS file does not contain this information, and my
perl knowledge is rustier than my python knowledge is incomplete.
Signed-off-by: Leif Lindholm <leif.lindholm at linaro.org>
---
BaseTools/Scripts/GetMaintainer.py | 131 +++++++++++++++++++++++++++++++++++++
Maintainers.txt | 38 +++++++++++
2 files changed, 169 insertions(+)
create mode 100644 BaseTools/Scripts/GetMaintainer.py
diff --git a/BaseTools/Scripts/GetMaintainer.py b/BaseTools/Scripts/GetMaintainer.py
new file mode 100644
index 0000000000..939930b052
--- /dev/null
+++ b/BaseTools/Scripts/GetMaintainer.py
@@ -0,0 +1,131 @@
+## @file
+# Retrieves the people to request review from on submission of a commit.
+#
+# Copyright (c) 2019, Linaro Ltd. All rights reserved.<BR>
+#
+# SPDX-License-Identifier: BSD-2-Clause-Patent
+#
+
+from __future__ import print_function
+from collections import defaultdict
+from collections import OrderedDict
+import argparse
+import os
+import re
+import SetupGit
+
+EXPRESSIONS = {
+ 'exclude': re.compile(r'^X:\s*(?P<exclude>.*?)\r*$'),
+ 'file': re.compile(r'^F:\s*(?P<file>.*?)\r*$'),
+ 'list': re.compile(r'^L:\s*(?P<list>.*?)\r*$'),
+ 'maintainer': re.compile(r'^M:\s*(?P<maintainer>.*<.*?>)\r*$'),
+ 'reviewer': re.compile(r'^R:\s*(?P<reviewer>.*?)\r*$'),
+ 'status': re.compile(r'^S:\s*(?P<status>.*?)\r*$'),
+ 'tree': re.compile(r'^T:\s*(?P<tree>.*?)\r*$'),
+ 'webpage': re.compile(r'^W:\s*(?P<webpage>.*?)\r*$')
+}
+
+def printsection(section):
+ """Prints out the dictionary describing a Maintainers.txt section."""
+ print('===')
+ for key in section.keys():
+ print("Key: %s" % key)
+ for item in section[key]:
+ print(' %s' % item)
+
+def pattern_to_regex(pattern):
+ """Takes a string containing regular UNIX path wildcards
+ and returns a string suitable for matching with regex."""
+ pattern = pattern.replace('.', r'\.')
+ pattern = pattern.replace('*', r'.*')
+ pattern = pattern.replace('?', r'.')
+
+ return pattern
+
+def get_section_maintainers(path, section):
+ """Returns a list with email addresses to any M: and R: entries
+ matching the provided path in the provided section."""
+ maintainers = []
+
+ for pattern in section['file']:
+ regex = pattern_to_regex(pattern)
+ match = re.match(regex, path)
+ if match:
+# print('path: "%s" pattern: "%s" regex: "%s"' % (path, pattern, regex))
+ for address in section['maintainer'], section['reviewer']:
+ maintainers += address
+
+ return maintainers
+
+def get_maintainers(path, sections):
+ """For 'path', iterates over all sections, returning maintainers
+ for matching ones."""
+ maintainers = []
+ for section in sections:
+ addresses = get_section_maintainers(path, section)
+ if addresses:
+ maintainers += addresses
+
+ # Remove any duplicates
+ return list(OrderedDict.fromkeys(maintainers))
+
+def parse_maintainers_line(line):
+ """Parse one line of Maintainers.txt, returning any match group and its key."""
+ for key, expression in EXPRESSIONS.items():
+ match = expression.match(line)
+ if match:
+ return key, match.group(key)
+ return None, None
+
+def parse_maintainers_file(filename):
+ """Parse the Maintainers.txt from top-level of repo and
+ return a list containing dictionaries of all sections."""
+ with open(filename, 'r') as text:
+ line = text.readline()
+ sectionlist = []
+ section = defaultdict(list)
+ while line:
+ key, value = parse_maintainers_line(line)
+ if key and value:
+ section[key].append(value)
+
+ line = text.readline()
+ # If end of section (end of file, or non-tag line encountered)...
+ if not key or not value or not line:
+ # ...if non-empty, append area to list.
+ if section:
+ sectionlist.append(section.copy())
+ section.clear()
+
+ return sectionlist
+
+def get_modified_files(repo, args):
+ """Returns a list of the files modified by the commit specified in 'args'."""
+ commit = repo.commit(args.commit)
+ return commit.stats.files
+
+if __name__ == '__main__':
+ PARSER = argparse.ArgumentParser(
+ description='Retrieves information on who to cc for review on a given commit')
+ PARSER.add_argument('commit',
+ action="store",
+ help='git revision to examine (default: HEAD)',
+ nargs='?',
+ default='HEAD')
+ ARGS = PARSER.parse_args()
+
+ REPO = SetupGit.locate_repo()
+
+ FILES = get_modified_files(REPO, ARGS)
+ CONFIG_FILE = os.path.join(REPO.working_dir, 'Maintainers.txt')
+
+ SECTIONS = parse_maintainers_file(CONFIG_FILE)
+
+ ADDRESSES = []
+
+ for file in FILES:
+ print(file)
+ ADDRESSES += get_maintainers(file, SECTIONS)
+
+ for address in list(OrderedDict.fromkeys(ADDRESSES)):
+ print(' %s' % address)
diff --git a/Maintainers.txt b/Maintainers.txt
index 762a684659..f4c851536e 100644
--- a/Maintainers.txt
+++ b/Maintainers.txt
@@ -47,6 +47,7 @@ T: svn (read-only, deprecated) - https://svn.code.sf.net/p/edk2/code/trunk/edk2
Tianocore Stewards
------------------
+F: *
M: Andrew Fish <afish at apple.com>
M: Laszlo Ersek <lersek at redhat.com>
M: Leif Lindholm <leif.lindholm at linaro.org>
@@ -61,19 +62,30 @@ EDK II Releases:
W: https://github.com/tianocore/tianocore.github.io/wiki/EDK-II-Release-Planning
M: Liming Gao <liming.gao at intel.com>
+EDK II Architectures:
+---------------------
+ARM, AARCH64
+F: */AARCH64/*
+F: */ARM/*
+M: Leif Lindholm <leif.lindholm at linaro.org>
+M: Ard Biesheuvel <ard.biesheuvel at linaro.org>
+
EDK II Packages:
----------------
ArmPkg
+F: ArmPkg/*
W: https://github.com/tianocore/tianocore.github.io/wiki/ArmPkg
M: Leif Lindholm <leif.lindholm at linaro.org>
M: Ard Biesheuvel <ard.biesheuvel at linaro.org>
ArmPlatformPkg
+F: ArmPlatformPkg/*
W: https://github.com/tianocore/tianocore.github.io/wiki/ArmPlatformPkg
M: Leif Lindholm <leif.lindholm at linaro.org>
M: Ard Biesheuvel <ard.biesheuvel at linaro.org>
ArmVirtPkg
+F: ArmVirtPkg/*
W: https://github.com/tianocore/tianocore.github.io/wiki/ArmVirtPkg
M: Laszlo Ersek <lersek at redhat.com>
M: Ard Biesheuvel <ard.biesheuvel at linaro.org>
@@ -81,26 +93,31 @@ R: Julien Grall <julien.grall at arm.com>
(Xen modules)
BaseTools
+F: BaseTools/*
W: https://github.com/tianocore/tianocore.github.io/wiki/BaseTools
M: Bob Feng <bob.c.feng at intel.com>
M: Liming Gao <liming.gao at intel.com>
CryptoPkg
+F: CryptoPkg/*
W: https://github.com/tianocore/tianocore.github.io/wiki/CryptoPkg
M: Jian Wang <jian.j.wang at intel.com>
R: Ting Ye <ting.ye at intel.com>
DynamicTablesPkg
+F: DynamicTablesPkg/*
W: https://github.com/tianocore/tianocore.github.io/wiki/DynamicTablesPkg
M: Sami Mujawar <Sami.Mujawar at arm.com>
M: Alexei Fedorov <Alexei.Fedorov at arm.com>
EmbeddedPkg
+F: EmbeddedPkg/*
W: https://github.com/tianocore/tianocore.github.io/wiki/EmbeddedPkg
M: Leif Lindholm <leif.lindholm at linaro.org>
M: Ard Biesheuvel <ard.biesheuvel at linaro.org>
EmulatorPkg
+F: EmulatorPkg/*
W: https://github.com/tianocore/tianocore.github.io/wiki/EmulatorPkg
M: Jordan Justen <jordan.l.justen at intel.com>
M: Andrew Fish <afish at apple.com>
@@ -108,55 +125,65 @@ M: Ray Ni <ray.ni at intel.com>
S: Maintained
FatPkg
+F: FatPkg/*
W: https://github.com/tianocore/tianocore.github.io/wiki/Edk2-fat-driver
M: Ray Ni <ray.ni at intel.com>
T: svn - https://svn.code.sf.net/p/edk2-fatdriver2/code/trunk/EnhancedFat
T: git - https://github.com/tianocore/edk2-FatPkg.git
FmpDevicePkg
+F: FmpDevicePkg/*
W: https://github.com/tianocore/tianocore.github.io/wiki/FmpDevicePkg
M: Liming Gao <liming.gao at intel.com>
M: Michael D Kinney <michael.d.kinney at intel.com>
IntelFrameworkModulePkg
+F: IntelFrameworkModulePkg/*
W: https://github.com/tianocore/tianocore.github.io/wiki/IntelFrameworkModulePkg
M: Liming Gao <liming.gao at intel.com>
IntelFrameworkPkg
+F: IntelFrameworkPkg/*
W: https://github.com/tianocore/tianocore.github.io/wiki/IntelFrameworkPkg
M: Michael D Kinney <michael.d.kinney at intel.com>
M: Liming Gao <liming.gao at intel.com>
IntelFsp2Pkg
+F: IntelFsp2Pkg/*
W: https://github.com/tianocore/tianocore.github.io/wiki/IntelFsp2Pkg
M: Chasel Chiu <chasel.chiu at intel.com>
R: Nate DeSimone <nathaniel.l.desimone at intel.com>
R: Star Zeng <star.zeng at intel.com>
IntelFsp2WrapperPkg
+F: IntelFsp2WrapperPkg/*
W: https://github.com/tianocore/tianocore.github.io/wiki/IntelFsp2WrapperPkg
M: Chasel Chiu <chasel.chiu at intel.com>
R: Nate DeSimone <nathaniel.l.desimone at intel.com>
R: Star Zeng <star.zeng at intel.com>
IntelFspPkg
+F: IntelFspPkg/*
W: https://github.com/tianocore/tianocore.github.io/wiki/IntelFspPkg
M: Chasel Chiu <chasel.chiu at intel.com>
R: Nate DeSimone <nathaniel.l.desimone at intel.com>
R: Star Zeng <star.zeng at intel.com>
IntelFspWrapperPkg
+F: IntelFspWrapperPkg/*
W: https://github.com/tianocore/tianocore.github.io/wiki/IntelFspWrapperPkg
M: Chasel Chiu <chasel.chiu at intel.com>
R: Nate DeSimone <nathaniel.l.desimone at intel.com>
R: Star Zeng <star.zeng at intel.com>
IntelSiliconPkg
+F: IntelSiliconPkg/*
W: https://github.com/tianocore/tianocore.github.io/wiki/IntelSiliconPkg
M: Ray Ni <ray.ni at intel.com>
M: Rangasai V Chaganty <rangasai.v.chaganty at intel.com>
MdeModulePkg
+F: MdeModulePkg/*
W: https://github.com/tianocore/tianocore.github.io/wiki/MdeModulePkg
M: Jian J Wang <jian.j.wang at intel.com>
M: Hao A Wu <hao.a.wu at intel.com>
@@ -166,16 +193,19 @@ R: Ray Ni <ray.ni at intel.com>
R: Star Zeng <star.zeng at intel.com>
MdePkg
+F: MdePkg/*
W: https://github.com/tianocore/tianocore.github.io/wiki/MdePkg
M: Michael D Kinney <michael.d.kinney at intel.com>
M: Liming Gao <liming.gao at intel.com>
NetworkPkg
+F: NetworkPkg/*
W: https://github.com/tianocore/tianocore.github.io/wiki/NetworkPkg
M: Siyuan Fu <siyuan.fu at intel.com>
M: Jiaxin Wu <jiaxin.wu at intel.com>
OvmfPkg
+F: OvmfPkg/*
W: http://www.tianocore.org/ovmf/
M: Jordan Justen <jordan.l.justen at intel.com>
M: Laszlo Ersek <lersek at redhat.com>
@@ -191,16 +221,19 @@ R: Stefan Berger <stefanb at linux.ibm.com>
S: Maintained
PcAtChipsetPkg
+F: PcAtChipsetPkg/*
W: https://github.com/tianocore/tianocore.github.io/wiki/PcAtChipsetPkg
M: Ray Ni <ray.ni at intel.com>
SecurityPkg
+F: SecurityPkg/*
W: https://github.com/tianocore/tianocore.github.io/wiki/SecurityPkg
M: Chao Zhang <chao.b.zhang at intel.com>
M: Jiewen Yao <jiewen.yao at intel.com>
M: Jian Wang <jian.j.wang at intel.com>
ShellPkg
+F: ShellPkg/*
W: https://github.com/tianocore/tianocore.github.io/wiki/ShellPkg
M: Jaben Carsey <jaben.carsey at intel.com>
M: Ray Ni <ray.ni at intel.com>
@@ -214,21 +247,25 @@ M: Leif Lindholm <leif.lindholm at linaro.org> (ARM/AArch64)
M: Ard Biesheuvel <ard.biesheuvel at linaro.org> (ARM/AArch64)
SignedCapsulePkg
+F: SignedCapsulePkg/*
W: https://github.com/tianocore/tianocore.github.io/wiki/SignedCapsulePkg
M: Jiewen Yao <jiewen.yao at intel.com>
M: Chao Zhang <chao.b.zhang at intel.com>
SourceLevelDebugPkg
+F: SourceLevelDebugPkg/*
W: https://github.com/tianocore/tianocore.github.io/wiki/SourceLevelDebugPkg
M: Hao A Wu <hao.a.wu at intel.com>
UefiCpuPkg
+F: UefiCpuPkg/*
W: https://github.com/tianocore/tianocore.github.io/wiki/UefiCpuPkg
M: Eric Dong <eric.dong at intel.com>
M: Ray Ni <ray.ni at intel.com>
R: Laszlo Ersek <lersek at redhat.com>
UefiPayloadPkg
+F: UefiPayloadPkg/*
W: https://github.com/tianocore/tianocore.github.io/wiki/UefiPayloadPkg
M: Maurice Ma <maurice.ma at intel.com>
M: Guo Dong <guo.dong at intel.com>
@@ -236,6 +273,7 @@ M: Benjamin You <benjamin.you at intel.com>
S: Maintained
StandaloneMmPkg
+F: StandaloneMmPkg/*
M: Achin Gupta <achin.gupta at arm.com>
M: Jiewen Yao <jiewen.yao at intel.com>
R: Supreeth Venkatesh <supreeth.venkatesh at arm.com>
--
2.11.0
-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#42283): https://edk2.groups.io/g/devel/message/42283
Mute This Topic: https://groups.io/mt/32039777/1813853
Group Owner: devel+owner at edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [edk2-devel-archive at redhat.com]
-=-=-=-=-=-=-=-=-=-=-=-
More information about the edk2-devel-archive
mailing list