Bug 413163: sanitycheck.pl needs to be more helpful when run at command line - Patch by Colin Ogilvie <colin.ogilvie@gmail.com> r/a=LpSolit

git-svn-id: svn://10.0.0.236/trunk@244589 18797224-902f-48f8-a5cc-f745e15eee43
This commit is contained in:
lpsolit%gmail.com 2008-01-31 12:00:19 +00:00
parent a89d8e4424
commit 0d66dcda13
2 changed files with 49 additions and 2 deletions

View File

@ -31,7 +31,8 @@ BEGIN { *esc = \&Pod::Simple::HTML::esc }
# Note that if you leave out a category here, it will not be indexed
# in the contents file, even though its HTML POD will still exist.
use constant FILE_TRANSLATION => {
Files => ['importxml', 'contrib', 'checksetup', 'email_in', 'install-module'],
Files => ['importxml', 'contrib', 'checksetup', 'email_in', 'install-module',
'sanitycheck'],
Modules => ['bugzilla'],
Extensions => ['extensions'],
};

View File

@ -30,11 +30,17 @@ use Bugzilla::User;
use Bugzilla::Mailer;
use Getopt::Long;
use Pod::Usage;
my $verbose = 0; # Return all comments if true, else errors only.
my $login = ''; # Login name of the user which is used to call sanitycheck.cgi.
my $help = 0; # Has user asked for help on this script?
my $result = GetOptions('verbose' => \$verbose, 'login=s' => \$login);
my $result = GetOptions('verbose' => \$verbose,
'login=s' => \$login,
'help|h|?' => \$help);
pod2usage({-verbose => 1, -exitval => 1}) if $help;
Bugzilla->usage_mode(USAGE_MODE_CMDLINE);
@ -68,3 +74,43 @@ if ($cgi->param('output')) {
MessageToMTA($message);
}
__END__
=head1 NAME
sanitycheck.pl - Perl script to perform a sanity check at the command line
=head1 SYNOPSIS
./sanitycheck.pl [--help]
./sanitycheck.pl [--verbose] --login <user@domain.com>
=head1 OPTIONS
=over
=item B<--help>
Displays this help text
=item B<--verbose>
Causes this script to be more verbose in its output. Without this option,
the script will return only errors. With the option, the script will append
all output to the email.
=item B<--login>
This should be passed the email address of a user that is capable of
running the Sanity Check process, a user with the editcomponents priv. This
user will receive an email with the results of the script run.
=back
=head1 DESCRIPTION
This script provides a way of running a 'Sanity Check' on the database
via either a CLI or cron. It is equivalent to calling sanitycheck.cgi
via a web broswer.