From: Jeremiah Foster <jeremiah@test.maemo.org>
Date: Fri, 22 May 2009 16:39:09 +0000 (+0300)
Subject: Tagged this as version 0.1 since I am going to test it on garage.
X-Git-Url: http://vcs.maemo.org/git/?p=maemian;a=commitdiff_plain;h=8679f0c60bb11368f44d8acbdde01768ac621b7b

Tagged this as version 0.1 since I am going to test it on garage.
---

diff --git a/maemian b/maemian
index 5d54506..754d45c 100755
--- a/maemian
+++ b/maemian
@@ -25,6 +25,15 @@
 
 maemian - Maemo package checker
 
+=head1
+
+Maemian is the maemo version of lintian - a policy checker designed to
+assure the quality of a package uploaded into the maemo.org repositories.
+The goal of maemian is to improve quality by checking that the maemo
+packaging policy is followed. In order to do that it reads files in the
+uploaded deb. Currently maemian only looks at the .dsc file and tries to
+ascertain who uploaded it, and if they used the correct email address.
+
 =head1 EXAMPLE
 
 maemian -i file.dsc
@@ -41,7 +50,7 @@ use Carp;
 # my $lintout = new Maemian::Output;
 
 # --- Command line options
-my $inputfile;             # --- A file passed to maemian 
+my $inputfile;             # --- A file passed to maemian
 GetOptions ("inputfile|i=s" => \$inputfile);
 
 sub file_tests {
@@ -49,10 +58,10 @@ sub file_tests {
   my $path = shift;
   if (-r $path) {
     my ($filename, $dirs) = fileparse($path);
+    # --- maemo is a trademarked term
     if ($filename =~ /maemo/) {
       print "W: Any use of the word \"maemo\" is subject to trademark.\n";
     }
-
     # --- Open file into an array
     open my $file, '<', $path or die "Cannot open file: $!\n";
     my @lines = <$file>;
@@ -61,7 +70,7 @@ sub file_tests {
     my ($field, $maintainer) = map { split /: / } grep /Maintainer/, @lines;
     chomp($maintainer);
     if ($maintainer =~ /(ubuntu|debian)/i) {
-      print "W: Maintainer email addres ($maintainer) might be the same as upstream.\n";
+      print "W: Maintainer email address ($maintainer) might be the same as upstream.\n";
     }
     else {
       print "N: $maintainer\n";