Revise ftp_abort and add POD block
authorJacob Bachmeyer <jcb@gnu.org>
Thu, 17 Nov 2022 03:28:36 +0000 (21:28 -0600)
committerJacob Bachmeyer <jcb@gnu.org>
Thu, 17 Nov 2022 03:28:36 +0000 (21:28 -0600)
The second argument is no longer used and is redundant with the
$AbortExitCode global variable, so it is removed.

gatekeeper.pl

index 22250fa90226c0242ea8c83678f43e860f71ef0d..1f9fdd5ebca03ddd3bad2d2cc6db6cfa18b26963 100755 (executable)
@@ -433,20 +433,27 @@ sub ftp_syslog {
   cluck($@) if $@;
 }
 
-sub ftp_abort($;$) {
+=item ftp_abort $message
+
+Abandon processing after emitting MESSAGE to the log.  Causes the program
+to exit with the current value of the C<$AbortExitCode> global variable.
+
+If the C<$AbortPipe> global variable is defined and an open file, sends
+MESSAGE there; otherwise MESSAGE is sent to syslog with 'err' severity.
+
+=cut
+
+sub ftp_abort($) {
     my $msg = shift;
-    my $exitcode = shift;
 
-    our $AbortExitCode;
-    $exitcode = (defined $exitcode ? $exitcode : $AbortExitCode);
+    our $AbortExitCode; our $AbortPipe;
 
-    our $AbortPipe;
     if (defined $AbortPipe && defined fileno $AbortPipe)
       { print $AbortPipe $msg, "\n" }
     else
       { ftp_syslog('err', $msg) }
 
-    exit $exitcode;
+    exit $AbortExitCode;
 }
 
 # Initialize our syslogging