Bug 13899: (QA followup) POD and usage message fixes

[koha-ffzg.git] / misc / devel / coverage.pl

diff --git a/misc/devel/coverage.pl b/misc/devel/coverage.pl
index f41c921..3dabae7 100755 (executable)
--- a/misc/devel/coverage.pl
+++ b/misc/devel/coverage.pl
@@ -1,20 +1,20 @@
 #!/usr/bin/perl
 
 # Copyright 2015 BibLibre
+#
 # This file is part of Koha.
 #
 # Koha 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
+# Foundation; either version 3 of the License, or (at your option) any later
 # version.
 #
 # Koha 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.
+# 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 Koha; if not, write to the Free Software Foundation, Inc.,
-# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+# with Koha; if not, see <http://www.gnu.org/licenses>.
 
 =head1 NAME
 
@@ -22,18 +22,43 @@ coverage.pl
 
 =head1 SYNOPSIS
 
-You have to be in yout Koha/src directory
-./misc/devel/coverage.pl
+    misc/devel/coverage.pl [-h|--help]
+
+This script must be run from your Koha source tree.
 
 =head1 DESCRIPTION
 
-This script make a cover on all files to see which modules are not tested yet
+This script runs all Koha tests and generates a coverage report on the
+cover_db directory.
+
+=cut
+
+=head1 OPTIONS
+
+=over 8
+
+=item B<-h|--help>
+
+prints this help text
+
+=back
 
 =cut
 
 use Modern::Perl;
+
 use C4::Context;
 use Cwd;
+use Getopt::Long;
+use Pod::Usage;
+
+my $help;
+
+GetOptions(
+    "h|help"      => \$help
+);
+
+pod2usage(1) if defined $help;
 
 #Die if you are not in your Koha src directory
 my $KOHA_PATH = C4::Context->config("intranetdir");
@@ -50,3 +75,5 @@ system("PERL5OPT=-MDevel::Cover /usr/bin/prove -r t/");
 system("cover");
 say("file://$KOHA_PATH/cover_db/coverage.html")
   unless !-e "$KOHA_PATH/cover_db/coverage.html";
+
+1;
\ No newline at end of file