[Bug 10810] New: Fix synopsis for -html option to overdue_notices.pl
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10810 Bug ID: 10810 Summary: Fix synopsis for -html option to overdue_notices.pl Change sponsored?: --- Product: Koha Version: master Hardware: All OS: All Status: NEW Severity: trivial Priority: P5 - low Component: Command-line Utilities Assignee: magnus@enger.priv.no Reporter: magnus@enger.priv.no QA Contact: testopia@bugs.koha-community.org See http://perldoc.koha-community.org/misc/cronjobs/overdue_notices.html The synopsis says: -html <filename> Output html to file But the description of the -html option says: -html Produces html data. if patron does not have a mail address or -n (no mail) flag is set, an html file is generated in the specified directory. This can be downloaded or futher processed by library staff. If the -html option is given a filename as its argument it will fail without warning. Confusingly enough, the variable associated with the -html option is called $htmlfilename: 'html:s' => \$htmlfilename, But it is actually used as a path, and the filename is added to it: open $html_fh, ">",File::Spec->catdir ($htmlfilename,"notices-".$today->ymd().".html"); I'll do a patch that fixes the synopsis and makes the full description clearer, but leave the variable name alone, as changing it will not gain us much. -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10810 Magnus Enger <magnus@enger.priv.no> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|NEW |Needs Signoff Patch complexity|--- |String patch -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10810 --- Comment #1 from Magnus Enger <magnus@enger.priv.no> --- Created attachment 20749 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=20749&action=edit Bug 10810 - Fix synopsis for -html option to overdue_notices.pl The synopsis for the -html option used to be: -html <filename> Output html to file but the argument to this option should actually be a directory, not a filename. This patch fixes the synopsis. To test: - Run perldoc misc/cronjobs/overdue_notices.pl - Check that the synopsis is as shown above - Apply this patch - Run perldoc misc/cronjobs/overdue_notices.pl - Check that - the synopsis asks for a directory, not a filename - that the description of the -html option further down in the perldoc now mentions the filename that the HTML file will be created with. -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10810 Bernardo Gonzalez Kriegel <bgkriegel@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #20749|0 |1 is obsolete| | --- Comment #2 from Bernardo Gonzalez Kriegel <bgkriegel@gmail.com> --- Created attachment 20870 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=20870&action=edit [SIGNED-OFF] Bug 10810 - Fix synopsis for -html option to overdue_notices.pl The synopsis for the -html option used to be: -html <filename> Output html to file but the argument to this option should actually be a directory, not a filename. This patch fixes the synopsis. To test: - Run perldoc misc/cronjobs/overdue_notices.pl - Check that the synopsis is as shown above - Apply this patch - Run perldoc misc/cronjobs/overdue_notices.pl - Check that - the synopsis asks for a directory, not a filename - that the description of the -html option further down in the perldoc now mentions the filename that the HTML file will be created with. Signed-off-by: Bernardo Gonzalez Kriegel <bgkriegel@gmail.com> Works as described. No koha-qa errors. If feeded with a filename -html option fails with many messages like print() on closed filehandle $html_fh at misc/cronjobs/overdue_notices.pl line 384. Perhaps it could be improved, but that was the old behavior. -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10810 Bernardo Gonzalez Kriegel <bgkriegel@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Needs Signoff |Signed Off CC| |bgkriegel@gmail.com -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10810 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Signed Off |Passed QA -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10810 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #20870|0 |1 is obsolete| | --- Comment #3 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- Created attachment 20976 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=20976&action=edit [PASSED QA] Bug 10810 - Fix synopsis for -html option to overdue_notices.pl The synopsis for the -html option used to be: -html <filename> Output html to file but the argument to this option should actually be a directory, not a filename. This patch fixes the synopsis. To test: - Run perldoc misc/cronjobs/overdue_notices.pl - Check that the synopsis is as shown above - Apply this patch - Run perldoc misc/cronjobs/overdue_notices.pl - Check that - the synopsis asks for a directory, not a filename - that the description of the -html option further down in the perldoc now mentions the filename that the HTML file will be created with. Signed-off-by: Bernardo Gonzalez Kriegel <bgkriegel@gmail.com> Works as described. No koha-qa errors. If feeded with a filename -html option fails with many messages like print() on closed filehandle $html_fh at misc/cronjobs/overdue_notices.pl line 384. Perhaps it could be improved, but that was the old behavior. Signed-off-by: Katrin Fischer <Katrin.Fischer.83@web.de> Improves documentation, no negative side effects found. -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10810 Galen Charlton <gmcharlt@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Passed QA |Pushed to Master CC| |gmcharlt@gmail.com --- Comment #4 from Galen Charlton <gmcharlt@gmail.com> --- Pushed to master. Thanks, Magnus! -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=10810 Tomás Cohen Arazi <tomascohen@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Pushed to Master |Pushed to Stable CC| |tomascohen@gmail.com --- Comment #5 from Tomás Cohen Arazi <tomascohen@gmail.com> --- This patch has been pushed to 3.12.x, will be in 3.12.7. Thanks Magnus! -- You are receiving this mail because: You are watching all bug changes.
participants (1)
-
bugzilla-daemon＠bugs.koha-community.org