summaryrefslogtreecommitdiff
path: root/Master/tlpkg/bin/check-file-coverage
blob: 4aa8b07b5d66394b92d573963ea9eb36cc167682 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
#!/usr/bin/env perl
# $Id: check-file-coverage 5846 2007-12-23 21:38:57Z preining $
# Copyright 2007, 2008 Norbert Preining
# This file is licensed under the GNU General Public License version 2
# or any later version.
# 
# check the file coverage of a TLTREE wrt to a texlive.tlpdb

BEGIN {
  $^W = 1;
  chomp ($mydir = `dirname $0`);
  unshift (@INC, "$mydir/..");
}

use strict;

use TeXLive::TLConfig;
use TeXLive::TLPSRC;
use TeXLive::TLPOBJ;
use TeXLive::TLPDB;
use TeXLive::TLTREE;
use TeXLive::TLUtils qw(dirname info debug);
use Getopt::Long;
use Pod::Usage;
use File::Path;

# things listed in 00texlive.core.tlpsrc are effectively ignored also.
my @IgnorePatterns = qw!
  .mkisofsrc$ autorun.inf$
  support/ source/ setuptl/
  texmf-dist/ls-R$ texmf-doc/ls-R$ texmf/ls-R$
  tlpkg/tlpsrc/
  tlpkg/bin
  tlpkg/lib/ tlpkg/tests/ tlpkg/etc/ 
  tlpkg/texlive.tlpdb
!;

chomp (my $opt_master = `cd $::mydir/../.. && pwd`);
my $opt_help = 0;

TeXLive::TLUtils::process_logging_options();
GetOptions(
    "master=s" => \$opt_master,	# location of the TL tree
    "help|?" => \$opt_help) or pod2usage(1);

pod2usage ('-exitstatus' => 0, '-verbose' => 2) if $opt_help;

exit (&main ());


sub main
{
  if (! -d $opt_master) {
    die "$0: Master $opt_master not a directory, goodbye.\n";
  }

  # checking for duplicates
  my $pack = "";
  open (TLPDB,"<$opt_master/tlpkg/texlive.tlpdb")
    or die "Cannot open $opt_master/tlpkg/texlive.tlpdb for reading: $!\n";
  my %filetopacks;
  while (<TLPDB>) {
    # ignore files mentioned in 00texlive.installer
    next if m/^\s*#/;
    next if m/^\s*$/;
    next if m/^((bin|run|doc|src)files|depend|execute|category|revision|shortdesc|longdesc|catalogue)/;
    if (m/^name\s+(\S+)\s+$/) {
      $pack = "$1";
      next;
    }
    next if ($pack eq "00texlive.installer");
    if (m/^ ([^\s]+)\s+/) {
      push @{$filetopacks{$1}}, $pack;
      next;
    } 
    print "NOT HANDLED $_";
  }

  my @multiple = ();
  foreach (keys %filetopacks) {
    my @foo = @{$filetopacks{$_}};
    if ($#foo < 0) {
      warn "that shouldn't happen: $_\n";
    } elsif ($#foo > 0) {
      push @multiple, $_;
    }
  }
  if ($#multiple >= 0) {
    print "$0: MULTIPLE INCLUDED FILES:\n";
    foreach (sort @multiple) {
      my @foo = @{$filetopacks{$_}};
      print "  $_ (@foo)\n";
    }
  }

  debug("reading Master tree $opt_master, patience...\n");
  my $tltree = TeXLive::TLTREE->new( "svnroot" => $opt_master );
  $tltree->init_from_svn;

  my %tltreefiles = %{$tltree->{'_allfiles'}};
  my @tlpdbfiles =  `grep '^ ' $opt_master/tlpkg/texlive.tlpdb | awk '{print\$1}'`;
  chomp(@tlpdbfiles);
  my %tlpdbf;
  for my $f (@tlpdbfiles) {
    $tlpdbf{$f} = 1;
  }
  my @nothit;
  for my $f (keys %tltreefiles) {
    # if it is mentioned in the tlpdb or is ignored it is considered 
    # as covered, thus, otherwise we push it onto the nothit list
    if (!defined($tlpdbf{$f})) {
      my $ignored = 0;
      foreach my $p (@IgnorePatterns) {
        if ($f =~ m/^$p/) {
          $ignored = 1;
          last;
        }
      }
      if (!$ignored) {
        push @nothit, $f;
      }
    }
  }
  if (@nothit) {
    print "$0: NOT COVERED FILES:\n";
    for my $f (sort @nothit) { print "\t$f\n"; }
  }
  return 0;
}

__END__

=head1 NAME

check-file-coverage - check file coverage TLTREE vs. texlive.tlpdb

=head1 SYNOPSIS

check-file-coverage [OPTION]...

=head1 OPTIONS

=over 8

=item B<-master> I<Master_dir>
The location given by B<-master> must point to a valid svn repository
of TeX Live's Master direcory.  Defaults to C<../..> of C<$0>.

=back

The standard options C<-help> and C<-debug> are also accepted.
See the tlpfiles documentation for details.

=head1 DESCRIPTION

Consistency check of the files in the master tree with the TeX Live
database.  Report on files that are included in more than one package,
and on files that are present in the tree but not in any package.

=head1 AUTHORS AND COPYRIGHT

This script and its documentation were written for the TeX Live
distribution (L<http://tug.org/texlive>) and both are licensed under the
GNU General Public License Version 2 or later.

=cut

### Local Variables:
### perl-indent-level: 2
### tab-width: 2
### indent-tabs-mode: nil
### End:
# vim:set tabstop=2 expandtab: #