From: Jacob Bachmeyer <jcb@gnu.org>
Date: Tue, 18 Oct 2022 02:07:45 +0000 (-0500)
Subject: Add POD block for interpret_directive
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=b916d0864d7b1b57553d98754528b2288cf1f6dd;p=gatekeeper.git

Add POD block for interpret_directive

This was held out of the previous commit to improve diff readability.
---

diff --git a/gatekeeper.pl b/gatekeeper.pl
index b45c806..edd17a8 100755
--- a/gatekeeper.pl
+++ b/gatekeeper.pl
@@ -1268,9 +1268,17 @@ sub verify_keyring {
 # other things, this lets us use gpgv everywhere, for paranoia's sake.
 #
 
+=item $ops = interpret_directive ( $directive )
 
+Analyze the elements in DIRECTIVE, performing basic validation.  An
+exception is thrown if DIRECTIVE contains invalid element values.
 
+The return value is an arrayref of command/parameter arrayrefs representing
+the operations to be performed to carry out DIRECTIVE.
 
+The values in the returned structure are untainted.
+
+=cut
 
 # As temporary scaffolding, also sets the %info quasi-global.
 sub interpret_directive {