# debian-readme -- lintian check script -*- perl -*-

# Copyright (C) 1998 Richard Braakman
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, you can find it on the World Wide
# Web at http://www.gnu.org/copyleft/gpl.html, or write to the Free
# Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
# MA 02110-1301, USA.

package Lintian::debian_readme;
use strict;
use warnings;

use Lintian::Check qw(check_spelling);
use Lintian::Tags qw(tag);

sub run {

my $pkg = shift;
my $type = shift;
my $readme = '';

if (open(IN, '<', 'README.Debian')) {
    local $_;
    while (<IN>) {
        if (m,/usr/doc\b,) {
            tag 'readme-debian-mentions-usr-doc', "line $.";
        }
        $readme .= $_;
    }
    close(IN);
}

my @template =
    ('Comments regarding the Package',
     'So far nothing to say',
     '<possible notes regarding this package - if none, delete this file>');
my $regex = join ('|', @template);
if ($readme =~ m/$regex/io) {
    tag 'readme-debian-contains-debmake-template';
} elsif ($readme =~ m/^\s*-- [^<]*<([^> ]+.\@[^>.]*)>/m) {
    tag 'readme-debian-contains-invalid-email-address', $1;
}

check_spelling('spelling-error-in-readme-debian', $readme, undef, { $pkg => 1 });

}

1;

# Local Variables:
# indent-tabs-mode: nil
# cperl-indent-level: 4
# End:
# vim: syntax=perl sw=4 sts=4 sr et
