From 31b7f8f1978217e614aae52f58fbf1b90b09fc9d Mon Sep 17 00:00:00 2001 From: Magnus Enger Date: Fri, 26 Oct 2018 22:47:16 +0200 Subject: [PATCH] Bug 21698: Fix POD of cancel_unfilled_holds.pl To test: - Run "perldoc misc/cronjobs/holds/cancel_unfilled_holds.pl" - Notice some problems: -- No description in the NAME section -- Descriptions of options in the SYNOPSIS section -- A literal head1 -- Long options are listed with a single leading dash -- Options --verbose and --confirm are not listed under OPTIONS) - Take a look at the script itself to see that --verbose and --confirm should be listed. - Also note the typo on line 97: 'v|verbosev' => \$verbose, - Apply the patch - Look at the script and perldoc again and check that all problems described above are now fixed. Signed-off-by: Andrew Isherwood Signed-off-by: Josef Moravec --- misc/cronjobs/holds/cancel_unfilled_holds.pl | 36 +++++++++++++--------------- 1 file changed, 17 insertions(+), 19 deletions(-) diff --git a/misc/cronjobs/holds/cancel_unfilled_holds.pl b/misc/cronjobs/holds/cancel_unfilled_holds.pl index 407bc9c..892cb62 100755 --- a/misc/cronjobs/holds/cancel_unfilled_holds.pl +++ b/misc/cronjobs/holds/cancel_unfilled_holds.pl @@ -39,45 +39,43 @@ cronlogaction(); =head1 NAME -cancel_unfilled_holds.pl +cancel_unfilled_holds.pl - script to delete unfilled holds after a given +number of days. =head1 SYNOPSIS -cancel_unfilled_holds.pl - [-days][-library][-holidays] + cancel_unfilled_holds.pl [--days][--library][--holidays][--confirm][--verbose] - Options: - -help brief help - -days cancel holds placed this many days ago which have not been filled - -library [repeatable] limit to specified branch(es) - -holidays skip holidays when calculating days waiting - -v verbose - -head1 OPTIONS +=head1 OPTIONS =over 8 -=item B<-help> +=item B<--help | -h> Print brief help and exit. -=item B<-man> - -Print full documentation and exit. - -=item B<-days> +=item B<--days> Specify the number of days waiting since a hold that remains unfilled was placed. E.g. a value of 730 would cancel holds placed 2 years ago or more that have never been filled -=item B<-library> +=item B<--library> Repeatable option to specify which branchcode(s) to cancel holds for. -=item B<-holidays> +=item B<--holidays> This switch specifies whether to count holidays as days waiting. Default is no. +=item B<--confirm> + +Without this option, the script will run in test mode, and only report what it +would have done if it were not running in test mode. + +=item B<--verbose | -v> + +More verbose output. + =back =cut -- 2.1.4