2 # (c) 2007, Joe Perches <joe@perches.com>
3 # created from checkpatch.pl
5 # Print selected MAINTAINERS information for
6 # the files modified in a patch or for a file
8 # usage: perl scripts/get_maintainers.pl [OPTIONS] <patch>
9 # perl scripts/get_maintainers.pl [OPTIONS] -f <file>
11 # Licensed under the terms of the GNU GPL License version 2
18 use Getopt
::Long
qw(:config no_auto_abbrev);
22 my $email_usename = 1;
23 my $email_maintainer = 1;
25 my $email_subscriber_list = 0;
27 my $email_git_penguin_chiefs = 0;
28 my $email_git_min_signatures = 1;
29 my $email_git_max_maintainers = 5;
30 my $email_git_min_percent = 5;
31 my $email_git_since = "1-year-ago";
32 my $email_git_blame = 0;
33 my $email_remove_duplicates = 1;
34 my $output_multiline = 1;
35 my $output_separator = ", ";
41 my $from_filename = 0;
42 my $pattern_depth = 0;
48 my @penguin_chief = ();
49 push(@penguin_chief,"Linus Torvalds:torvalds\@linux-foundation.org");
50 #Andrew wants in on most everything - 2009/01/14
51 #push(@penguin_chief,"Andrew Morton:akpm\@linux-foundation.org");
53 my @penguin_chief_names = ();
54 foreach my $chief (@penguin_chief) {
55 if ($chief =~ m/^(.*):(.*)/) {
58 push(@penguin_chief_names, $chief_name);
61 my $penguin_chiefs = "\(" . join("|",@penguin_chief_names) . "\)";
63 # rfc822 email address - preloaded methods go here.
64 my $rfc822_lwsp = "(?:(?:\\r\\n)?[ \\t])";
65 my $rfc822_char = '[\\000-\\377]';
69 'git!' => \
$email_git,
70 'git-chief-penguins!' => \
$email_git_penguin_chiefs,
71 'git-min-signatures=i' => \
$email_git_min_signatures,
72 'git-max-maintainers=i' => \
$email_git_max_maintainers,
73 'git-min-percent=i' => \
$email_git_min_percent,
74 'git-since=s' => \
$email_git_since,
75 'git-blame!' => \
$email_git_blame,
76 'remove-duplicates!' => \
$email_remove_duplicates,
77 'm!' => \
$email_maintainer,
78 'n!' => \
$email_usename,
80 's!' => \
$email_subscriber_list,
81 'multiline!' => \
$output_multiline,
82 'separator=s' => \
$output_separator,
83 'subsystem!' => \
$subsystem,
84 'status!' => \
$status,
87 'pattern-depth=i' => \
$pattern_depth,
88 'k|keywords!' => \
$keywords,
89 'f|file' => \
$from_filename,
90 'v|version' => \
$version,
94 die "$P: invalid argument\n";
103 print("${P} ${V}\n");
109 die "$P: argument missing: patchfile or -f file please\n";
112 if ($output_separator ne ", ") {
113 $output_multiline = 0;
116 my $selections = $email + $scm + $status + $subsystem + $web;
117 if ($selections == 0) {
119 die "$P: Missing required option: email, scm, status, subsystem or web\n";
123 ($email_maintainer + $email_list + $email_subscriber_list +
124 $email_git + $email_git_penguin_chiefs + $email_git_blame) == 0) {
126 die "$P: Please select at least 1 email option\n";
129 if (!top_of_kernel_tree
($lk_path)) {
130 die "$P: The current directory does not appear to be "
131 . "a linux kernel source tree.\n";
134 ## Read MAINTAINERS for type/value pairs
139 open(MAINT
, "<${lk_path}MAINTAINERS") || die "$P: Can't open MAINTAINERS\n";
143 if ($line =~ m/^(\C):\s*(.*)/) {
147 ##Filename pattern matching
148 if ($type eq "F" || $type eq "X") {
149 $value =~ s@\
.@
\\\
.@g; ##Convert . to \.
150 $value =~ s/\*/\.\*/g; ##Convert * to .*
151 $value =~ s/\?/\./g; ##Convert ? to .
152 ##if pattern is a directory and it lacks a trailing slash, add one
154 $value =~ s@
([^/])$@$1/@
;
156 } elsif ($type eq "K") {
157 $keyword_hash{@typevalue} = $value;
159 push(@typevalue, "$type:$value");
160 } elsif (!/^(\s)*$/) {
162 push(@typevalue, $line);
169 if ($email_remove_duplicates) {
170 open(MAILMAP
, "<${lk_path}.mailmap") || warn "$P: Can't open .mailmap\n";
174 next if ($line =~ m/^\s*#/);
175 next if ($line =~ m/^\s*$/);
177 my ($name, $address) = parse_email
($line);
178 $line = format_email
($name, $address);
180 next if ($line =~ m/^\s*$/);
182 if (exists($mailmap{$name})) {
183 my $obj = $mailmap{$name};
184 push(@
$obj, $address);
186 my @arr = ($address);
187 $mailmap{$name} = \
@arr;
193 ## use the filenames on the command line or find the filenames in the patchfiles
197 my @keyword_tvi = ();
199 foreach my $file (@ARGV) {
200 ##if $file is a directory and it lacks a trailing slash, add one
202 $file =~ s@
([^/])$@$1/@
;
203 } elsif (!(-f
$file)) {
204 die "$P: file '${file}' not found\n";
206 if ($from_filename) {
208 if (-f
$file && $keywords) {
209 open(FILE
, "<$file") or die "$P: Can't open ${file}\n";
212 foreach my $line (keys %keyword_hash) {
213 if ($patch_line =~ m/^.*$keyword_hash{$line}/x) {
214 push(@keyword_tvi, $line);
221 my $file_cnt = @files;
223 open(PATCH
, "<$file") or die "$P: Can't open ${file}\n";
226 if (m/^\+\+\+\s+(\S+)/) {
228 $filename =~ s@
^[^/]*/@@
;
230 $lastfile = $filename;
231 push(@files, $filename);
232 } elsif (m/^\@\@ -(\d+),(\d+)/) {
233 if ($email_git_blame) {
234 push(@range, "$lastfile:$1:$2");
236 } elsif ($keywords) {
237 foreach my $line (keys %keyword_hash) {
238 if ($patch_line =~ m/^[+-].*$keyword_hash{$line}/x) {
239 push(@keyword_tvi, $line);
245 if ($file_cnt == @files) {
246 warn "$P: file '${file}' doesn't appear to be a patch. "
247 . "Add -f to options?\n";
249 @files = sort_and_uniq
(@files);
260 # Find responsible parties
262 foreach my $file (@files) {
264 #Do not match excluded file patterns
267 foreach my $line (@typevalue) {
268 if ($line =~ m/^(\C):\s*(.*)/) {
272 if (file_match_pattern
($file, $value)) {
283 foreach my $line (@typevalue) {
284 if ($line =~ m/^(\C):\s*(.*)/) {
288 if (file_match_pattern
($file, $value)) {
289 my $value_pd = ($value =~ tr@
/@@
);
290 my $file_pd = ($file =~ tr@
/@@
);
291 $value_pd++ if (substr($value,-1,1) ne "/");
292 if ($pattern_depth == 0 ||
293 (($file_pd - $value_pd) < $pattern_depth)) {
294 $hash{$tvi} = $value_pd;
301 foreach my $line (sort {$hash{$b} <=> $hash{$a}} keys %hash) {
302 add_categories
($line);
306 if ($email && $email_git) {
307 recent_git_signoffs
($file);
310 if ($email && $email_git_blame) {
311 git_assign_blame
($file);
316 @keyword_tvi = sort_and_uniq
(@keyword_tvi);
317 foreach my $line (@keyword_tvi) {
318 add_categories
($line);
323 foreach my $chief (@penguin_chief) {
324 if ($chief =~ m/^(.*):(.*)/) {
327 $email_address = format_email
($1, $2);
328 if ($email_git_penguin_chiefs) {
329 push(@email_to, $email_address);
331 @email_to = grep(!/${email_address}/, @email_to);
337 if ($email || $email_list) {
340 @to = (@to, @email_to);
343 @to = (@to, @list_to);
354 @status = uniq
(@status);
359 @subsystem = uniq
(@subsystem);
370 sub file_match_pattern
{
371 my ($file, $pattern) = @_;
372 if (substr($pattern, -1) eq "/") {
373 if ($file =~ m@
^$pattern@
) {
377 if ($file =~ m@
^$pattern@
) {
378 my $s1 = ($file =~ tr@
/@@
);
379 my $s2 = ($pattern =~ tr@
/@@
);
390 usage: $P [options] patchfile
391 $P [options] -f file|directory
394 MAINTAINER field selection options:
395 --email => print email address(es) if any
396 --git => include recent git \*-by: signers
397 --git-chief-penguins => include ${penguin_chiefs}
398 --git-min-signatures => number of signatures required (default: 1)
399 --git-max-maintainers => maximum maintainers to add (default: 5)
400 --git-min-percent => minimum percentage of commits required (default: 5)
401 --git-since => git history to use (default: 1-year-ago)
402 --git-blame => use git blame to find modified commits for patch or file
403 --m => include maintainer(s) if any
404 --n => include name 'Full Name <addr\@domain.tld>'
405 --l => include list(s) if any
406 --s => include subscriber only list(s) if any
407 --remove-duplicates => minimize duplicate email names/addresses
408 --scm => print SCM tree(s) if any
409 --status => print status if any
410 --subsystem => print subsystem name if any
411 --web => print website(s) if any
414 --separator [, ] => separator for multiple entries on 1 line
415 using --separator also sets --nomultiline if --separator is not [, ]
416 --multiline => print 1 entry per line
419 --pattern-depth => Number of pattern directory traversals (default: 0 (all))
420 --keywords => scan patch for keywords (default: 1 (on))
421 --version => show version
422 --help => show this help information
425 [--email --git --m --n --l --multiline --pattern-depth=0 --remove-duplicates]
428 Using "-f directory" may give unexpected results:
429 Used with "--git", git signators for _all_ files in and below
430 directory are examined as git recurses directories.
431 Any specified X: (exclude) pattern matches are _not_ ignored.
432 Used with "--nogit", directory is used as a pattern match,
433 no individual file within the directory or subdirectory
435 Used with "--git-blame", does not iterate all files in directory
436 Using "--git-blame" is slow and may add old committers and authors
437 that are no longer active maintainers to the output.
441 sub top_of_kernel_tree
{
444 if ($lk_path ne "" && substr($lk_path,length($lk_path)-1,1) ne "/") {
447 if ( (-f
"${lk_path}COPYING")
448 && (-f
"${lk_path}CREDITS")
449 && (-f
"${lk_path}Kbuild")
450 && (-f
"${lk_path}MAINTAINERS")
451 && (-f
"${lk_path}Makefile")
452 && (-f
"${lk_path}README")
453 && (-d
"${lk_path}Documentation")
454 && (-d
"${lk_path}arch")
455 && (-d
"${lk_path}include")
456 && (-d
"${lk_path}drivers")
457 && (-d
"${lk_path}fs")
458 && (-d
"${lk_path}init")
459 && (-d
"${lk_path}ipc")
460 && (-d
"${lk_path}kernel")
461 && (-d
"${lk_path}lib")
462 && (-d
"${lk_path}scripts")) {
469 my ($formatted_email) = @_;
474 if ($formatted_email =~ /^([^<]+)<(.+\@.*)>.*$/) {
477 } elsif ($formatted_email =~ /^\s*<(.+\@\S*)>.*$/) {
479 } elsif ($formatted_email =~ /^(.+\@\S*).*$/) {
483 $name =~ s/^\s+|\s+$//g;
484 $name =~ s/^\"|\"$//g;
485 $address =~ s/^\s+|\s+$//g;
487 if ($name =~ /[^a-z0-9 \.\-]/i) { ##has "must quote" chars
488 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
492 return ($name, $address);
496 my ($name, $address) = @_;
500 $name =~ s/^\s+|\s+$//g;
501 $name =~ s/^\"|\"$//g;
502 $address =~ s/^\s+|\s+$//g;
504 if ($name =~ /[^a-z0-9 \.\-]/i) { ##has "must quote" chars
505 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
509 if ($email_usename) {
511 $formatted_email = "$address";
513 $formatted_email = "$name <${address}>";
516 $formatted_email = $address;
519 return $formatted_email;
522 sub find_starting_index
{
526 my $tv = $typevalue[$index];
527 if (!($tv =~ m/^(\C):\s*(.*)/)) {
536 sub find_ending_index
{
539 while ($index < @typevalue) {
540 my $tv = $typevalue[$index];
541 if (!($tv =~ m/^(\C):\s*(.*)/)) {
554 my $start = find_starting_index
($index);
555 my $end = find_ending_index
($index);
557 push(@subsystem, $typevalue[$start]);
559 for ($i = $start + 1; $i < $end; $i++) {
560 my $tv = $typevalue[$i];
561 if ($tv =~ m/^(\C):\s*(.*)/) {
565 my $list_address = $pvalue;
566 my $list_additional = "";
567 if ($list_address =~ m/([^\s]+)\s+(.*)$/) {
569 $list_additional = $2;
571 if ($list_additional =~ m/subscribers-only/) {
572 if ($email_subscriber_list) {
573 push(@list_to, $list_address);
577 push(@list_to, $list_address);
580 } elsif ($ptype eq "M") {
581 my ($name, $address) = parse_email
($pvalue);
584 my $tv = $typevalue[$i - 1];
585 if ($tv =~ m/^(\C):\s*(.*)/) {
588 $pvalue = format_email
($name, $address);
593 if ($email_maintainer) {
594 push_email_addresses
($pvalue);
596 } elsif ($ptype eq "T") {
598 } elsif ($ptype eq "W") {
600 } elsif ($ptype eq "S") {
601 push(@status, $pvalue);
608 my %email_hash_address;
611 my ($name, $address) = @_;
613 return 1 if (($name eq "") && ($address eq ""));
614 return 1 if (($name ne "") && exists($email_hash_name{$name}));
615 return 1 if (($address ne "") && exists($email_hash_address{$address}));
620 sub push_email_address
{
623 my ($name, $address) = parse_email
($line);
625 if ($address eq "") {
629 if (!$email_remove_duplicates) {
630 push(@email_to, format_email
($name, $address));
631 } elsif (!email_inuse
($name, $address)) {
632 push(@email_to, format_email
($name, $address));
633 $email_hash_name{$name}++;
634 $email_hash_address{$address}++;
640 sub push_email_addresses
{
643 my @address_list = ();
645 if (rfc822_valid
($address)) {
646 push_email_address
($address);
647 } elsif (@address_list = rfc822_validlist
($address)) {
648 my $array_count = shift(@address_list);
649 while (my $entry = shift(@address_list)) {
650 push_email_address
($entry);
653 if (!push_email_address
($address)) {
654 warn("Invalid MAINTAINERS address: '" . $address . "'\n");
662 foreach my $path (split(/:/, $ENV{PATH
})) {
663 if (-e
"$path/$bin") {
675 foreach my $line (@lines) {
676 my ($name, $address) = parse_email
($line);
677 if (!exists($hash{$name})) {
678 $hash{$name} = $address;
679 } elsif ($address ne $hash{$name}) {
680 $address = $hash{$name};
681 $line = format_email
($name, $address);
683 if (exists($mailmap{$name})) {
684 my $obj = $mailmap{$name};
685 foreach my $map_address (@
$obj) {
686 if (($map_address eq $address) &&
687 ($map_address ne $hash{$name})) {
688 $line = format_email
($name, $hash{$name});
697 sub recent_git_signoffs
{
708 if (which
("git") eq "") {
709 warn("$P: git not found. Add --nogit to options?\n");
713 warn("$P: .git directory not found. Use a git repository for better results.\n");
714 warn("$P: perhaps 'git clone git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux-2.6.git'\n");
718 $cmd = "git log --since=${email_git_since} -- ${file}";
721 $output =~ s/^\s*//gm;
723 @lines = split("\n", $output);
725 @lines = grep(/^[-_ a-z]+by:.*\@.*$/i, @lines);
726 if (!$email_git_penguin_chiefs) {
727 @lines = grep(!/${penguin_chiefs}/i, @lines);
730 s/.*:\s*(.+)\s*/$1/ for (@lines);
732 $total_sign_offs = @lines;
734 if ($email_remove_duplicates) {
735 @lines = mailmap
(@lines);
738 @lines = sort(@lines);
741 $hash{$_}++ for @lines;
744 foreach my $line (sort {$hash{$b} <=> $hash{$a}} keys %hash) {
745 my $sign_offs = $hash{$line};
747 last if ($sign_offs < $email_git_min_signatures ||
748 $count > $email_git_max_maintainers ||
749 $sign_offs * 100 / $total_sign_offs < $email_git_min_percent);
750 push_email_address
($line);
755 my ($cmd, @commits) = @_;
761 @lines = split("\n", $output);
762 foreach my $line (@lines) {
763 if ($line =~ m/^(\w+) /) {
770 sub git_assign_blame
{
782 foreach my $file_range_diff (@range) {
783 next if (!($file_range_diff =~ m/(.+):(.+):(.+)/));
786 my $diff_length = $3;
787 next if (!("$file" eq "$diff_file"));
788 $cmd = "git blame -l -L $diff_start,+$diff_length $file";
789 @commits = save_commits
($cmd, @commits);
793 $cmd = "git blame -l $file";
794 @commits = save_commits
($cmd, @commits);
798 $total_sign_offs = 0;
799 @commits = uniq
(@commits);
800 foreach my $commit (@commits) {
801 $cmd = "git log -1 ${commit}";
804 $output =~ s/^\s*//gm;
805 @lines = split("\n", $output);
807 @lines = grep(/^[-_ a-z]+by:.*\@.*$/i, @lines);
808 if (!$email_git_penguin_chiefs) {
809 @lines = grep(!/${penguin_chiefs}/i, @lines);
813 s/.*:\s*(.+)\s*/$1/ for (@lines);
815 $total_sign_offs += @lines;
817 if ($email_remove_duplicates) {
818 @lines = mailmap
(@lines);
821 $hash{$_}++ for @lines;
825 foreach my $line (sort {$hash{$b} <=> $hash{$a}} keys %hash) {
826 my $sign_offs = $hash{$line};
828 last if ($sign_offs < $email_git_min_signatures ||
829 $count > $email_git_max_maintainers ||
830 $sign_offs * 100 / $total_sign_offs < $email_git_min_percent);
831 push_email_address
($line);
839 @parms = grep(!$saw{$_}++, @parms);
847 @parms = sort @parms;
848 @parms = grep(!$saw{$_}++, @parms);
855 if ($output_multiline) {
856 foreach my $line (@parms) {
860 print(join($output_separator, @parms));
868 # Basic lexical tokens are specials, domain_literal, quoted_string, atom, and
869 # comment. We must allow for rfc822_lwsp (or comments) after each of these.
870 # This regexp will only work on addresses which have had comments stripped
871 # and replaced with rfc822_lwsp.
873 my $specials = '()<>@,;:\\\\".\\[\\]';
874 my $controls = '\\000-\\037\\177';
876 my $dtext = "[^\\[\\]\\r\\\\]";
877 my $domain_literal = "\\[(?:$dtext|\\\\.)*\\]$rfc822_lwsp*";
879 my $quoted_string = "\"(?:[^\\\"\\r\\\\]|\\\\.|$rfc822_lwsp)*\"$rfc822_lwsp*";
881 # Use zero-width assertion to spot the limit of an atom. A simple
882 # $rfc822_lwsp* causes the regexp engine to hang occasionally.
883 my $atom = "[^$specials $controls]+(?:$rfc822_lwsp+|\\Z|(?=[\\[\"$specials]))";
884 my $word = "(?:$atom|$quoted_string)";
885 my $localpart = "$word(?:\\.$rfc822_lwsp*$word)*";
887 my $sub_domain = "(?:$atom|$domain_literal)";
888 my $domain = "$sub_domain(?:\\.$rfc822_lwsp*$sub_domain)*";
890 my $addr_spec = "$localpart\@$rfc822_lwsp*$domain";
892 my $phrase = "$word*";
893 my $route = "(?:\@$domain(?:,\@$rfc822_lwsp*$domain)*:$rfc822_lwsp*)";
894 my $route_addr = "\\<$rfc822_lwsp*$route?$addr_spec\\>$rfc822_lwsp*";
895 my $mailbox = "(?:$addr_spec|$phrase$route_addr)";
897 my $group = "$phrase:$rfc822_lwsp*(?:$mailbox(?:,\\s*$mailbox)*)?;\\s*";
898 my $address = "(?:$mailbox|$group)";
900 return "$rfc822_lwsp*$address";
903 sub rfc822_strip_comments
{
905 # Recursively remove comments, and replace with a single space. The simpler
906 # regexps in the Email Addressing FAQ are imperfect - they will miss escaped
907 # chars in atoms, for example.
909 while ($s =~ s
/^((?
:[^"\\]|\\.)*
910 (?:"(?
:[^"\\]|\\.)*"(?
:[^"\\]|\\.)*)*)
911 \((?:[^()\\]|\\.)*\)/$1 /osx) {}
915 # valid: returns true if the parameter is an RFC822 valid address
917 sub rfc822_valid ($) {
918 my $s = rfc822_strip_comments(shift);
921 $rfc822re = make_rfc822re();
924 return $s =~ m/^$rfc822re$/so && $s =~ m/^$rfc822_char*$/;
927 # validlist: In scalar context, returns true if the parameter is an RFC822
928 # valid list of addresses.
930 # In list context, returns an empty list on failure (an invalid
931 # address was found); otherwise a list whose first element is the
932 # number of addresses found and whose remaining elements are the
933 # addresses. This is needed to disambiguate failure (invalid)
934 # from success with no addresses found, because an empty string is
937 sub rfc822_validlist ($) {
938 my $s = rfc822_strip_comments(shift);
941 $rfc822re = make_rfc822re();
943 # * null list items are valid according to the RFC
944 # * the '1' business is to aid in distinguishing failure from no results
947 if ($s =~ m/^(?:$rfc822re)?(?:,(?:$rfc822re)?)*$/so &&
948 $s =~ m/^$rfc822_char*$/) {
949 while ($s =~ m/(?:^|,$rfc822_lwsp*)($rfc822re)/gos) {
952 return wantarray ? (scalar(@r), @r) : 1;
955 return wantarray ? () : 0;