Explain intended use of ftp_abort
authorJacob Bachmeyer <jcb@gnu.org>
Thu, 17 Nov 2022 03:38:58 +0000 (21:38 -0600)
committerJacob Bachmeyer <jcb@gnu.org>
Thu, 17 Nov 2022 03:38:58 +0000 (21:38 -0600)
gatekeeper.pl

index 139fbd9e02b69b778e2eb4a36dea2fed3f758e93..e1509e98a34e80039ec65099b25f51f21a8635ba 100755 (executable)
@@ -441,6 +441,12 @@ 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.
 
+Most errors should be handled with die or throw, both of which throw
+exceptions that can be caught, allowing processing to continue with the
+next packet uploaded.  This sub should be used only for system errors or
+other situations that suggest that further processing will be futile.  This
+sub should B<never> be called as a direct result of invalid remote input.
+
 =cut
 
 sub ftp_abort($) {