From: Jacob Bachmeyer <jcb@gnu.org>
Date: Thu, 17 Nov 2022 03:38:58 +0000 (-0600)
Subject: Explain intended use of ftp_abort
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=0c639a12ac0b10193f587ca5c15a526c7f1a9b28;p=gatekeeper.git

Explain intended use of ftp_abort
---

diff --git a/gatekeeper.pl b/gatekeeper.pl
index 139fbd9..e1509e9 100755
--- a/gatekeeper.pl
+++ b/gatekeeper.pl
@@ -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($) {