[Koha-devel] Proposal for a new coding guideline for command line scripts

[Kyle Hall]

Sounds good to me.

Kyle

http://www.kylehall.info
ByWater Solutions ( http://bywatersolutions.com )
Meadville Public Library ( http://www.meadvillelibrary.org )
Crawford County Federated Library System ( http://www.ccfls.org )
Mill Run Technology Solutions ( http://millruntech.com )


On Tue, Jul 24, 2012 at 12:02 PM, Paul Poulain
<paul.poulain at biblibre.com> wrote:
> Hello koha-devel,
>
> I just pushed a few minuts ago a new script in misc (bug 8376, but it
> doesn't matter for this mail)
>
> This script has a help that is displayed when you run it with -h. So far
> so good.
>
> BUT, it has no PODDOC. Not so good.
>
> I've discovered recently that we could use:
>> use Pod::Usage;
>>
>> sub usage {
>>     pod2usage( -verbose => 2 );
>>     exit;
>> }
>> <snip>
>> usage() if $help;
>
> That will deal with both POD and -h flag. It's used in some scripts like
> misc/maintenance/touch_all_biblios.pl
>
> Do we agree it's a good idea to request that for future scripts, and add
> this in the coding guidelines ?
>
> --
> Paul POULAIN
> http://www.biblibre.com
> Expert en Logiciels Libres pour l'info-doc
> Tel : (33) 4 91 81 35 08
> _______________________________________________
> Koha-devel mailing list
> Koha-devel at lists.koha-community.org
> http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel
> website : http://www.koha-community.org/
> git : http://git.koha-community.org/
> bugs : http://bugs.koha-community.org/