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 <andrew.isherwood@ptfs-europe.com>

Signed-off-by: Josef Moravec <josef.moravec@gmail.com>

Signed-off-by: Nick Clemens <nick@bywatersolutions.com>
This commit is contained in:
Magnus Enger 2018-10-26 22:47:16 +02:00 committed by Nick Clemens
parent 77ea468639
commit b7b6727f92

View file

@ -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