2 # Maintainers.pm - show information about maintainers
10 # Please don't use post 5.008 features as this module is used by
11 # Porting/makemeta, and that in turn has to be run by the perl just built.
14 require "Maintainers.pl";
15 use vars qw(%Modules %Maintainers);
17 use vars qw(@ISA @EXPORT_OK $VERSION);
19 @EXPORT_OK = qw(%Modules %Maintainers
20 get_module_files get_module_pat
21 show_results process_options);
29 if (open(MANIFEST, "MANIFEST")) {
31 if (/^(\S+)\t+(.+)$/) {
37 die "$0: Failed to open MANIFEST for reading: $!\n";
42 split ' ', $Modules{$m}{FILES};
45 sub get_module_files {
47 sort { lc $a cmp lc $b }
49 -f $_ ? # Files as-is.
51 -d _ ? # Recurse into directories.
56 push @files, $File::Find::name
57 if -f $_ && exists $MANIFEST{$File::Find::name};
61 : glob($_) # The rest are globbable patterns.
65 sub get_maintainer_modules {
67 sort { lc $a cmp lc $b }
68 grep { $Modules{$_}{MAINTAINER} eq $m }
74 $0: Usage: $0 [[--maintainer M --module M --files]|[--check] [commit] | [file ...]
75 --maintainer M list all maintainers matching M
76 --module M list all modules matching M
77 --files list all files
78 --check check consistency of Maintainers.pl
79 with a file checks if it has a maintainer
80 with a dir checks all files have a maintainer
81 otherwise checks for multiple maintainers
82 --opened list all modules of modified files
83 Matching is case-ignoring regexp, author matching is both by
84 the short id and by the full name and email. A "module" may
85 not be just a module, it may be a file or files or a subdirectory.
86 The options may be abbreviated to their unique prefixes
101 'maintainer=s' => \$Maintainer,
102 'module=s' => \$Module,
105 'opened' => \$Opened,
111 chomp (@Files = `git ls-files -m --full-name`);
113 } elsif (@ARGV == 1 &&
114 $ARGV[0] =~ /^(?:HEAD|[0-9a-f]{4,40})(?:~\d+)?\^*$/) {
115 my $command = "git diff --name-only $ARGV[0]^ $ARGV[0]";
116 chomp (@Files = `$command`);
117 die "'$command' failed: $?" if $?;
122 usage() if @Files && ($Maintainer || $Module || $Files);
124 for my $mean ($Maintainer, $Module) {
125 warn "$0: Did you mean '$0 $mean'?\n"
126 if $mean && -e $mean && $mean ne '.' && !$Files;
129 warn "$0: Did you mean '$0 -mo $Maintainer'?\n"
130 if defined $Maintainer && exists $Modules{$Maintainer};
132 warn "$0: Did you mean '$0 -ma $Module'?\n"
133 if defined $Module && exists $Maintainers{$Module};
135 return ($Maintainer, $Module, $Files, @Files);
139 my ($Maintainer, $Module, $Files, @Files) = @_;
142 for my $m (sort keys %Maintainers) {
143 if ($m =~ /$Maintainer/io || $Maintainers{$m} =~ /$Maintainer/io) {
144 my @modules = get_maintainer_modules($m);
146 @modules = grep { /$Module/io } @modules;
150 for my $module (@modules) {
151 push @files, get_module_files($module);
153 printf "%-15s @files\n", $m;
156 printf "%-15s @modules\n", $m;
158 printf "%-15s $Maintainers{$m}\n", $m;
164 for my $m (sort { lc $a cmp lc $b } keys %Modules) {
165 if ($m =~ /$Module/io) {
167 my @files = get_module_files($m);
168 printf "%-15s @files\n", $m;
170 printf "%-15s %-12s %s\n", $m, $Modules{$m}{MAINTAINER}, $Modules{$m}{UPSTREAM}||'unknown';
176 missing_maintainers( qr{\.(?:[chty]|p[lm]|xs)\z}msx, @Files)
179 duplicated_maintainers();
184 for (@Files) { s:^\./:: }
186 @ModuleByFile{@Files} = ();
188 # First try fast match.
191 for my $module (keys %Modules) {
192 for my $pat (get_module_pat($module)) {
193 $ModuleByPat{$pat} = $module;
198 for my $pat (keys %ModuleByPat) {
200 $ExpModuleByPat{$pat} = $ModuleByPat{$pat};
202 for my $exp (glob($pat)) {
203 $ExpModuleByPat{$exp} = $ModuleByPat{$pat};
207 %ModuleByPat = %ExpModuleByPat;
208 for my $file (@Files) {
209 $ModuleByFile{$file} = $ModuleByPat{$file}
210 if exists $ModuleByPat{$file};
213 # If still unresolved files...
214 if (my @ToDo = grep { !defined $ModuleByFile{$_} } keys %ModuleByFile) {
216 # Cannot match what isn't there.
217 @ToDo = grep { -e $_ } @ToDo;
220 # Try prefix matching.
222 # Remove trailing slashes.
223 for (@ToDo) { s|/$|| }
228 for my $pat (keys %ModuleByPat) {
229 last unless keys %ToDo;
232 for my $file (keys %ToDo) {
233 if ($file =~ m|^$pat|i) {
234 $ModuleByFile{$file} = $ModuleByPat{$pat};
244 for my $file (@Files) {
245 if (defined $ModuleByFile{$file}) {
246 my $module = $ModuleByFile{$file};
247 my $maintainer = $Modules{$ModuleByFile{$file}}{MAINTAINER};
248 my $upstream = $Modules{$module}{UPSTREAM}||'unknown';
249 printf "%-15s [%-7s] $module $maintainer $Maintainers{$maintainer}\n", $file, $upstream;
251 printf "%-15s ?\n", $file;
256 print STDERR "(No files are modified)\n";
265 sub maintainers_files {
267 for my $k (keys %Modules) {
268 for my $f (get_module_files($k)) {
274 sub duplicated_maintainers {
276 for my $f (keys %files) {
277 if ($files{$f} > 1) {
278 warn "File $f appears $files{$f} times in Maintainers.pl\n";
283 sub warn_maintainer {
285 warn "File $name has no maintainer\n" if not $files{$name};
288 sub missing_maintainers {
289 my($check, @path) = @_;
293 if( -d $d ) { push @dir, $d } else { warn_maintainer($d) }
295 find sub { warn_maintainer($File::Find::name) if /$check/; }, @dir