X-Git-Url: http://vcs.maemo.org/git/?a=blobdiff_plain;f=checks%2Fdescription;fp=checks%2Fdescription;h=b2bc12a6206f495f5bedc593df4d76eb9ae5fc92;hb=1960326d487467271f731ff6a62830404a4947af;hp=0000000000000000000000000000000000000000;hpb=ce31209d7230201c69f8f234032a774fbbbc43cd;p=maemian

diff --git a/checks/description b/checks/description
new file mode 100644
index 0000000..b2bc12a
--- /dev/null
+++ b/checks/description
@@ -0,0 +1,187 @@
+# description -- lintian check script -*- perl -*-
+
+# Copyright (C) 1998 Christian Schwarz
+#
+# 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 Maemian::description;
+use strict;
+use Spelling;
+use Tags;
+use Util;
+
+sub run {
+
+my $pkg = shift;
+my $type = shift;
+my $info = shift;
+
+my $tabs = 0;
+my $lines = 0;
+my $template = 0;
+my $unindented_list = 0;
+my $synopsis;
+my $description;
+
+# description?
+my $full_description = $info->field('description');
+unless (defined $full_description) {
+    tag "package-has-no-description", "";
+    return 0;
+}
+
+$full_description =~ m/^([^\n]*)\n(.*)$/s;
+($synopsis, $description) = ($1, $2);
+unless (defined $synopsis) {
+    $synopsis = $full_description;
+    $description = '';
+}
+
+if ($synopsis =~ m/^\s*$/) {
+    tag "description-synopsis-is-empty", "";
+} else {
+    if ($synopsis =~ m/^\Q$pkg\E\b/i) {
+	tag "description-starts-with-package-name", "";
+    }
+    if ($synopsis =~ m/(?<!etc)\.\s*$/i) {
+	tag "description-synopsis-might-not-be-phrased-properly", "";
+    }
+    if ($synopsis =~ m/\t/) {
+	tag "description-contains-tabs", "" unless $tabs++;
+    }
+    if (length($synopsis) >= 80) {
+	tag "description-too-long", "";
+    }
+    if ($synopsis =~ m/^missing\s*$/i) {
+	tag "description-is-debmake-template", "" unless $template++;
+    } elsif ($synopsis =~ m/<insert up to 60 chars description>/) {
+	tag "description-is-dh_make-template", "" unless $template++;
+    }
+}
+
+my $flagged_homepage;
+my $is_dummy;
+foreach (split /\n/, $description) {
+    next if m/^ \.\s*$/o;
+
+    if ($lines == 0) {
+	my $firstline = lc $_;
+	my $lsyn = lc $synopsis;
+	if ($firstline =~ /^\Q$lsyn\E$/) {
+	    tag "description-synopsis-is-duplicated", "";
+	} else {
+	    $firstline =~ s/[^a-zA-Z0-9]+//g;
+	    $lsyn =~ s/[^a-zA-Z0-9]+//g;
+	    if ($firstline eq $lsyn) {
+		tag "description-synopsis-is-duplicated", "";
+	    }
+	}
+    }
+
+    $lines++;
+
+    if (m/^ \.\s*\S/o) {
+	tag "description-contains-invalid-control-statement", "";
+    } elsif (m/^ [\-\*]/o) {
+	# Print it only the second time.  Just one is not enough to be sure that
+	# it's a list, and after the second there's no need to repeat it.
+	tag "possible-unindented-list-in-extended-description", "" if $unindented_list++ == 2;
+    }
+
+    if (m/\t/o) {
+	tag "description-contains-tabs", "" unless $tabs++;
+    }
+
+    if (m,^\s*Homepage: <?https?://,i) {
+	tag "description-contains-homepage";
+	$flagged_homepage = 1;
+    }
+
+    if (m,This description was automagically extracted from the module by dh-make-perl,i) {
+	tag "description-contains-dh-make-perl-template";
+    }
+
+    my $wo_quotes = $_;
+    $wo_quotes =~ s,(\"|\')(.*?)(\1),,;
+    while ($wo_quotes =~ m,(?:\W|^)((\w+)(\s+(\2))+)(?:\W|\z),i) {
+	my $words = $1;
+	$wo_quotes =~ s/\Q$words//;
+        tag "description-contains-duplicated-word", "$words";
+    }
+
+    my $first_person = $_;
+    while ($first_person =~
+	m/(?:^|\s)(I|[Mm]y|[Oo]urs?|mine|myself|me|us|[Ww]e)(?:$|\s)/) {
+
+	my $word = $1;
+	$first_person =~ s/\Q$word//;
+	tag "using-first-person-in-description", "line $lines: $word";
+    }
+
+    if ($lines == 1) {
+	# checks for the first line of the extended description:
+	if (m/^ \s/o) {
+	    tag "description-starts-with-leading-spaces", "";
+	}
+	if (m/^\s*missing\s*$/oi) {
+	    tag "description-is-debmake-template", "" unless $template++;
+	} elsif (m/<insert long description, indented with spaces>/) {
+	    tag "description-is-dh_make-template", "" unless $template++;
+	}
+    }
+
+    if (length($_) > 80) {
+	tag "extended-description-line-too-long", "";
+    }
+}
+
+if ($type ne 'udeb') {
+    if ($lines == 0) {
+	tag "extended-description-is-empty";
+    } elsif ($lines <= 2 and not $synopsis =~ /(dummy|transition)/i) {
+	tag "extended-description-is-probably-too-short";
+    }
+}
+
+# Check for a package homepage in the description and no Homepage field.  This
+# is less accurate and more of a guess than looking for the old Homepage:
+# convention in the body.
+unless ($info->field('homepage') or $flagged_homepage) {
+    if ($description =~ /homepage|webpage|website|url|upstream|web\s+site
+                         |home\s+page|further\s+information|more\s+info
+                         |official\s+site|project\s+home/xi
+	and $description =~ m,\b(https?://[a-z0-9][^>\s]+),i) {
+	tag 'description-possibly-contains-homepage', $1;
+    } elsif ($description =~ m,\b(https?://[a-z0-9][^>\s]+)>?\.?\s*\z,i) {
+	tag 'description-possibly-contains-homepage', $1;
+    }
+}
+
+if ($description) {
+    spelling_check('spelling-error-in-description', $description);
+    spelling_check_picky('spelling-error-in-description', $description);
+}
+
+}
+
+1;
+
+# Local Variables:
+# indent-tabs-mode: t
+# cperl-indent-level: 4
+# End:
+# vim: syntax=perl sw=4 ts=8