The following commit has been merged in the master branch: commit a94e7b93c5a7409523b854c8d907ad1809f781ac Author: Nelson A. de Oliveira <nao...@debian.org> Date: Wed Nov 10 10:45:34 2010 -0200
Add a check for synopsis starting with articles * Summary of tag changes: + Added: - description-synopsis-starts-with-article * checks/description{,.desc}: + [NT] Add a check for synopsis starting with articles. Thanks to Nelson A. de Oliveira for the patch. (Closes: #603053) Signed-off-by: Niels Thykier <ni...@thykier.net> diff --git a/checks/description b/checks/description index 0d75b9d..08cfbd4 100644 --- a/checks/description +++ b/checks/description @@ -61,6 +61,9 @@ if ($synopsis =~ m/^\s*$/) { if ($synopsis =~ m/^\Q$pkg\E\b/i) { tag "description-starts-with-package-name", ""; } + if ($synopsis =~ m/^(an?|the)\s/i) { + tag "description-synopsis-starts-with-article", ""; + } if ($synopsis =~ m/(?<!etc)\.\s*$/i) { tag "description-synopsis-might-not-be-phrased-properly", ""; } diff --git a/checks/description.desc b/checks/description.desc index 26b6043..99cf9d4 100644 --- a/checks/description.desc +++ b/checks/description.desc @@ -52,6 +52,17 @@ Info: The first line of the "Description:" should not start with the have a description like this: "foo is a program that...". Ref: policy 3.4.1 +Tag: description-synopsis-starts-with-article +Severity: minor +Certainty: certain +Info: The first line of the "Description:" should omit any initial indefinite + or definite article: "a", "an", or "the". A good heuristic is that it should + be possible to substitute the package <tt>name</tt> and <tt>synopsis</tt> + into this formula: + . + The package <tt>name</tt> provides {a,an,the,some} <tt>synopsis</tt>. +Ref: devref 6.2.2 + Tag: description-contains-tabs Severity: important Certainty: certain diff --git a/debian/changelog b/debian/changelog index 65fd825..1ad605c 100755 --- a/debian/changelog +++ b/debian/changelog @@ -5,6 +5,7 @@ lintian (2.4.4) UNRELEASED; urgency=low - build-depends-on-specific-java-doc-package - depends-on-specific-java-doc-package - unneeded-build-dep-on-quilt + - description-synopsis-starts-with-article * checks/*: + [NT] Use the new pre-sorted file index when iterating over files. @@ -18,6 +19,9 @@ lintian (2.4.4) UNRELEASED; urgency=low * checks/debian-source-dir: + [NT] Added missing import of "Util" perl module. Thanks to David Bremner for the patch. + * checks/description{,.desc}: + + [NT] Add a check for synopsis starting with articles. Thanks to + Nelson A. de Oliveira for the patch. (Closes: #603053) * checks/fields{,.desc}: + [NT] Added check for packages (build) depending on openjdk-X-doc or classpath-doc instead of the default-jdk-doc metapackage. diff --git a/t/tests/description-general/debian/debian/control.in b/t/tests/description-general/debian/debian/control.in index cbed638..fff24ba 100644 --- a/t/tests/description-general/debian/debian/control.in +++ b/t/tests/description-general/debian/debian/control.in @@ -100,3 +100,15 @@ Description: test package with duplicated words that aren't Lintian. It is part of the Lintian test suite and may do very odd things. It should not be installed like a regular package. It may be an empty package. + +Package: {$srcpkg}-syn-article +Architecture: {$architecture} +Depends: $\{shlibs:Depends\}, $\{misc:Depends\} +Description: the synopsis starts with an article + A good synopsis should start not start with "a", "an" and "the" + according to devref 6.2.2. + . + This is a test package designed to exercise some feature or tag of + Lintian. It is part of the Lintian test suite and may do very odd + things. It should not be installed like a regular package. It may + be an empty package. diff --git a/t/tests/description-general/desc b/t/tests/description-general/desc index 153d0d0..ebb8708 100644 --- a/t/tests/description-general/desc +++ b/t/tests/description-general/desc @@ -15,6 +15,7 @@ Test-For: description-synopsis-is-duplicated description-synopsis-is-empty description-synopsis-might-not-be-phrased-properly + description-synopsis-starts-with-article description-too-long extended-description-is-empty extended-description-line-too-long diff --git a/t/tests/description-general/tags b/t/tests/description-general/tags index 5775813..57c67af 100644 --- a/t/tests/description-general/tags +++ b/t/tests/description-general/tags @@ -15,6 +15,7 @@ W: description-general-2: possible-unindented-list-in-extended-description W: description-general-3: extended-description-line-too-long W: description-general-4: description-contains-homepage W: description-general-4: spelling-error-in-description mroe more +W: description-general-syn-article: description-synopsis-starts-with-article W: description-general: description-contains-dh-make-perl-template W: description-general: description-contains-duplicated-word All all all W: description-general: description-contains-duplicated-word The the -- Debian package checker -- To UNSUBSCRIBE, email to debian-lint-maint-requ...@lists.debian.org with a subject of "unsubscribe". Trouble? Contact listmas...@lists.debian.org Archive: http://lists.debian.org/e1pvv9r-000797...@alioth.debian.org