[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

lintian: r911 - in trunk: checks debian testset testset/manpages testset/manpages/debian



Author: rra
Date: 2007-06-18 12:43:56 +0200 (Mon, 18 Jun 2007)
New Revision: 911

Added:
   trunk/testset/manpages/program.1
Modified:
   trunk/checks/manpages
   trunk/checks/manpages.desc
   trunk/debian/changelog
   trunk/testset/manpages/debian/rules
   trunk/testset/tags.manpages
Log:
* checks/manpages{.desc,}:
  + [RA] Check for dh_make man page templates (by looking for the
    template whatis entry).  Thanks, Bill Allombert.  (Closes: #173583)

Modified: trunk/checks/manpages
===================================================================
--- trunk/checks/manpages	2007-06-17 23:13:59 UTC (rev 910)
+++ trunk/checks/manpages	2007-06-18 10:43:56 UTC (rev 911)
@@ -239,6 +239,8 @@
 	    $desc =~ s/^[^:]+: \"(.*)\"$/$1/;
 	    if ($desc =~ /(\S+)\s+-\s+manual page for \1/i) {
 		tag "manpage-has-useless-whatis-entry", "$file";
+	    } elsif ($desc =~ /(\S+)\s+-\s+programs? to do something/i) {
+		tag "manpage-is-dh_make-template", "$file";
 	    }
 	    1 while <LEXGROG>;
 	    close LEXGROG;

Modified: trunk/checks/manpages.desc
===================================================================
--- trunk/checks/manpages.desc	2007-06-17 23:13:59 UTC (rev 910)
+++ trunk/checks/manpages.desc	2007-06-18 10:43:56 UTC (rev 911)
@@ -109,6 +109,17 @@
  If this manpage was generated by help2man, use the -n option to provide a
  more meaningful description.
 
+Tag: manpage-is-dh_make-template
+Type: error
+Info: This manual page appears to be an unmodified or insufficiently
+ modified copy of the dh_make manual page template.  It has a whatis entry
+ (the brief description found in the NAME section) of the form:
+ .
+  package - program to do something
+ .
+ Please double-check the manual page and replace the template language
+ with specific information about this program.
+
 Tag: manpage-has-errors-from-man
 Type: warning
 Info: This man page provokes warnings or errors from man.

Modified: trunk/debian/changelog
===================================================================
--- trunk/debian/changelog	2007-06-17 23:13:59 UTC (rev 910)
+++ trunk/debian/changelog	2007-06-18 10:43:56 UTC (rev 911)
@@ -11,6 +11,9 @@
       directory when the tar file was built.
     + [RA] Don't incorrectly skip all other file location checks for hard
       links.
+  * checks/manpages{.desc,}:
+    + [RA] Check for dh_make man page templates (by looking for the
+      template whatis entry).  Thanks, Bill Allombert.  (Closes: #173583)
   * checks/menus:
     + [RA] Avoid a quadratic search of the files in the package on
       doc-base files that list tons of files individually.  This speeds up
@@ -29,7 +32,7 @@
       output will be stable regardless of the hash order of the directory
       when the tar file was built.
 
- -- Russ Allbery <rra@debian.org>  Sun, 17 Jun 2007 15:42:15 -0700
+ -- Russ Allbery <rra@debian.org>  Mon, 18 Jun 2007 03:42:59 -0700
 
 lintian (1.23.31) unstable; urgency=low
 

Modified: trunk/testset/manpages/debian/rules
===================================================================
--- trunk/testset/manpages/debian/rules	2007-06-17 23:13:59 UTC (rev 910)
+++ trunk/testset/manpages/debian/rules	2007-06-18 10:43:56 UTC (rev 911)
@@ -27,6 +27,8 @@
 
 	gzip -c9 <true.1 >$(tmp)/usr/share/man/man1/true.1.gz
 
+	gzip -c9 <program.1 >$(tmp)/usr/share/man/man1/program.1.gz
+
 	ln -s ../X11R6/bin/rstartd $(tmp)/usr/bin/rstartd
 	touch $(tmp)/usr/X11R6/man/man1/rstartd.1x.gz
 

Added: trunk/testset/manpages/program.1
===================================================================
--- trunk/testset/manpages/program.1	2007-06-17 23:13:59 UTC (rev 910)
+++ trunk/testset/manpages/program.1	2007-06-18 10:43:56 UTC (rev 911)
@@ -0,0 +1,59 @@
+.\"                                      Hey, EMACS: -*- nroff -*-
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH PROGRAM 1 "2007-06-18"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh        disable hyphenation
+.\" .hy        enable hyphenation
+.\" .ad l      left justify
+.\" .ad b      justify to both left and right margins
+.\" .nf        disable filling
+.\" .fi        enable filling
+.\" .br        insert line break
+.\" .sp <n>    insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+program \- program to do something
+.SH SYNOPSIS
+.B program
+.RI [ options ] " files" ...
+.br
+.B bar
+.RI [ options ] " files" ...
+.SH DESCRIPTION
+This manual page documents briefly the
+.B program
+and
+.B bar
+commands.
+.PP
+.\" TeX users may be more comfortable with the \fB<whatever>\fP and
+.\" \fI<whatever>\fP escape sequences to invode bold face and italics, 
+.\" respectively.
+\fBprogram\fP is a program that...
+.SH OPTIONS
+These programs follow the usual GNU command line syntax, with long
+options starting with two dashes (`-').
+A summary of options is included below.
+For a complete description, see the Info files.
+.TP
+.B \-h, \-\-help
+Show summary of options.
+.TP
+.B \-v, \-\-version
+Show version of program.
+.SH SEE ALSO
+.BR bar (1),
+.BR baz (1).
+.br
+The programs are documented fully by
+.IR "The Rise and Fall of a Fooish Bar" ,
+available via the Info system.
+.SH AUTHOR
+program was written by <upstream author>.
+.PP
+This manual page was written by #USERNAME# <#EMAIL#>,
+for the Debian project (but may be used by others).

Modified: trunk/testset/tags.manpages
===================================================================
--- trunk/testset/tags.manpages	2007-06-17 23:13:59 UTC (rev 910)
+++ trunk/testset/tags.manpages	2007-06-18 10:43:56 UTC (rev 911)
@@ -11,6 +11,7 @@
 E: manpages: info-document-not-compressed-with-gzip usr/share/info/baz.broken.gz
 E: manpages: info-document-not-compressed-with-max-compression usr/share/info/bar.gz
 E: manpages: manpage-has-wrong-extension usr/X11R6/man/man6/X11R6-binary.man
+E: manpages: manpage-is-dh_make-template usr/share/man/man1/program.1.gz
 E: manpages: manpage-not-compressed usr/X11R6/man/man6/X11R6-binary.man
 E: manpages: manpage-not-compressed usr/share/man/de/man1/binary-without-english-manpage.1
 E: manpages: manpage-not-compressed usr/share/man/man1/usr-bin-binary.1



Reply to: