Bug 2389: (followup) Add documentation and fix use case

Signed-off-by: Tomas Cohen Arazi <[email protected]> Signed-off-by: Barton Chittenden <[email protected]> Signed-off-by: Katrin Fischer <[email protected]> Signed-off-by: Kyle M Hall <[email protected]>
Mike5620 · Sep 24, 2016 · 9e22a9c · 9e22a9c
1 parent 71454b4
commit 9e22a9c
Showing 1 changed file with 9 additions and 1 deletion.
diff --git a/misc/cronjobs/overdue_notices.pl b/misc/cronjobs/overdue_notices.pl
@@ -69,6 +69,7 @@ =head1 SYNOPSIS
    -borcat       <categorycode>   category code that must be included
    -borcatout    <categorycode>   category code that must be excluded
    -t                             only include triggered overdues
+   --test                         Run in test mode. No changes will be made on the DB.
    -list-all                      list all overdues
    -date         <yyyy-mm-dd>     emulate overdues run for this date
    -email        <email_type>     type of email that will be used. Can be 'email', 'emailpro' or 'B_email'. Repeatable.
@@ -159,6 +160,13 @@ =head1 OPTIONS
 Add the --triggered option for daily cron, at the risk of no notice 
 being generated if the cron fails to run on time.
 
+=item B<-test>
+
+This option makes the script run in test mode.
+
+In test mode, the script won't make any changes on the DB. This is useful
+for debugging configuration.
+
 =item B<-list-all>
 
 Default items.content lists only those items that fall in the 
@@ -813,7 +821,7 @@ =head1 SEE ALSO
                 attachments            => [$attachment],
                 to_address             => $admin_email_address,
             }
-        );
+        ) unless $test_mode;
     }
 
 }