413163 - sanitycheck.pl needs to be more helpful when run at command line

Status: RESOLVED FIXED

(Bugzilla :: Administration, task)

Description

[Colin Ogilvie [:cso]]

[colin@theta /var/www/htdocs/bugzilla-trunk $] perl sanitycheck.pl 
The name  is not a valid username.  
    Either you misspelled it, or the person has not
    registered for a Bugzilla account.

[colin@theta /var/www/htdocs/bugzilla-trunk $] perl sanitycheck.pl --help
Unknown option: help
The name  is not a valid username.  
    Either you misspelled it, or the person has not
    registered for a Bugzilla account.

It could be useful to provide a --help command, and possibly also provide the instruction in the error message.

Comment 1

[Colin Ogilvie [:cso]]

Attachment: Patch to add a help command

Add a --help / -h command parameter for people to know what the script does.

Comment 2

[Frédéric Buclin]

Comment on attachment 298017 [details] [diff] [review]
Patch to add a help command

>+my $help = 0; # Has user assked for help on this script?

s/assked/asked/


>+if ($help == 1)
>+{
>+	help() && exit();
>+}

Please use pod2usage(), see e.g. checksetup.pl and importxml.pl. Note that == 1 is not required. |if $help| will do it.


>+    print "  --verbose                Causes the script to be more\n";
>+    print "                           verbose in it's output\n";

s/it's/its/. Moreover, make it clear that --verbose will append *everything* in the email, why omitting it will only return errors.


>+    print "  --login <email address>  The user that is capable of running\n";
>+    print "                           a Sanity Check on the database\n";

Please specify that the user must have editcomponents privs and is the one who will get an email with the results returned by sanitycheck.cgi

Comment 3

[Frédéric Buclin]

Also, as soon as you converted the doc to POD, you can add sanitycheck.pl to docs/lib/Pod/Simple/HTMLBatch/Bugzilla.pm so that this script is listed in docs/html/api/index.html.

Comment 4

[Colin Ogilvie [:cso]]

Attachment: Patch v2

Updated per the previous review.

Comment 5

[Frédéric Buclin]

Comment on attachment 300464 [details] [diff] [review]
Patch v2

r=LpSolit

Comment 6

[Frédéric Buclin]

Checking in sanitycheck.pl;
/cvsroot/mozilla/webtools/bugzilla/sanitycheck.pl,v  <--  sanitycheck.pl
new revision: 1.3; previous revision: 1.2
done
Checking in docs/lib/Pod/Simple/HTMLBatch/Bugzilla.pm;
/cvsroot/mozilla/webtools/bugzilla/docs/lib/Pod/Simple/HTMLBatch/Bugzilla.pm,v  <--  Bugzilla.pm
new revision: 1.4; previous revision: 1.3
done