linux-kernel - [PATCH] [RFC] Add a script that searched per-file maintainers for a patch.

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:	Wed,  1 Oct 2008 14:25:54 +0200
From:	Uwe Kleine-König <ukleinek@...len.de>
To:	"H. Peter Anvin" <hpa@...or.com>
Cc:	Pekka Enberg <penberg@...helsinki.fi>,
	Ben Dooks <ben-linux@...ff.org>, linux-kernel@...r.kernel.org,
	Pavel Machek <pavel@...e.cz>,
	Randy Dunlap <rdunlap@...otime.net>,
	Joe Perches <joe@...ches.com>
Subject: [PATCH] [RFC] Add a script that searched per-file maintainers for a patch.

I assume currently there are no files that have the maintainers noted in
a source file in a way that is understandable by the script, but for
testing you can use scripts/genpatchcc.py itself.  It is meant to be
used with git-send-email --cc-cmd=...

Currently the format to specify a maintainer is

	/*
	 * TOPIC
	 * P: M. Aintainer <ma@...ai.ner>
	 * L: some-list@...r.kernel.org
	 */

similar to the format of the MAINTAINERS file.  This has to be specified
in the first comment of a file starting at the file's start.  #-like
comments are supported, too.

---
To test it, apply the patch, and modify scripts/genpatchcc.py.  Then you
can run:

	git diff | scripts/genpatchcc.py

I havn't tested it yet with git-send-email and there are several things
to improve as noted in the comments of the script (and probably more).
And of course some documentation is missing.

Please consider it as a first draft and feel free to comment.

Best regards
Uwe
---
 scripts/genpatchcc.py |   95 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 95 insertions(+), 0 deletions(-)
 create mode 100755 scripts/genpatchcc.py

diff --git a/scripts/genpatchcc.py b/scripts/genpatchcc.py
new file mode 100755
index 0000000..6a757ed
--- /dev/null
+++ b/scripts/genpatchcc.py
@@ -0,0 +1,95 @@
+#! /usr/bin/env python
+# vim: set fileencoding=utf-8
+# (c) Uwe Kleine-König <ukleinek@...len.de>
+# GPLv2
+#
+# GENPATCHCC
+# P: Uwe Kleine-König <ukleinek@...len.de>
+
+# wishlist:
+# - support for per-directory '.maintainers' file
+#   when should it be used?  Assume a/b/c/d/file was changed.  The following
+#   files could be used:
+#    * a/b/c/d/.maintainers
+#    * a/b/c/.maintainers
+#    * a/b/.maintainers
+#    * a/.maintainers
+#    * .maintainers
+#   maybe only use the first that exists?  only if the changed file doesn't
+#   have an entry?
+# - (?) option to specify the srcdir
+# - (?) parse the patch if the maintainer entry is changed, use both, old and new version
+# - (?) extract git sha1 sums and parse the objects
+
+import fileinput
+import re
+
+def filename(name):
+    if name[0] == '"':
+        raise NotImplementedError, 'please teach me how to unquote a filename'
+
+    # assume -p1
+    return name[name.index('/') + 1:]
+
+re_changedfile = re.compile(r'(?:---|\+\+\+)\s(?P<file>".*?[^\\]"|[][-^A-Za-z0-9_ !#$%&\'()*+,./:;<=>@?{}~]+)')
+
+changed_files = set()
+
+for line in fileinput.input():
+    mo = re_changedfile.match(line)
+    if mo:
+        changed_files.add(filename(mo.group('file')))
+
+def extract_maintainers(file, compre_dict, dowhile=None):
+    next = ('start', 'topic')
+    anyfield = ('person', 'ml', 'otherfield')
+    next_dict = dict(start=('topic',), topic=anyfield, person=anyfield, ml=anyfield, otherfield=anyfield)
+
+    for line in file:
+        if dowhile is not None:
+            mo = dowhile.match(line)
+            if not mo:
+                break
+
+        for possnext in next:
+            mo = compre_dict[possnext].match(line)
+            if mo:
+                for v in mo.groupdict().itervalues():
+                    print v
+                next = next_dict[possnext]
+                break
+        else:
+            mo = compre_dict['start'].match(line)
+            if mo:
+                next = next_dict['start']
+            else:
+                next = ('start',)
+
+re_dict = dict(start=r'$',
+        topic=r'\S[^:].*',
+        person=r'P:\s*(?P<person>.*)',
+        ml=r'L:\s*(?P<ml>.*)',
+        otherfield=r'(?![PL])[A-Z]:')
+
+re_comment = r'\s*(?:#|/?\*)'
+
+compre_dict = dict((key, re.compile(value)) for key, value in re_dict.iteritems())
+compre_commented_dict = dict((key, re.compile(re_comment + r'\s*' + value)) for key, value in re_dict.iteritems())
+compre_comment = re.compile(re_comment)
+
+mailto_person = set()
+mailto_ml = set()
+
+for file in changed_files:
+    # MAINTAINERS [cw]ould result in many false matches, skip it
+    # alternatively print someone?  who?
+    if file == 'MAINTAINERS':
+        continue
+
+    try:
+        of = open(file)
+    except:
+        # TODO: try harder (e.g. is the patch really -p1?)
+        continue
+
+    extract_maintainers(of, compre_commented_dict, compre_comment)
-- 
1.5.6.5

--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/