Add POD block for interpret_directive
authorJacob Bachmeyer <jcb@gnu.org>
Tue, 18 Oct 2022 02:07:45 +0000 (21:07 -0500)
committerJacob Bachmeyer <jcb@gnu.org>
Tue, 18 Oct 2022 02:07:45 +0000 (21:07 -0500)
This was held out of the previous commit to improve diff readability.

gatekeeper.pl

index b45c806e49b1ad649d784037a36963ca26447f1e..edd17a813c5d26319083ed04bcb85d154b180d12 100755 (executable)
@@ -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 {