sbkeysync: add comment to sigdb_iterate

Signed-off-by: Jeremy Kerr <jeremy.kerr@canonical.com>

1 files changed, 8 insertions, 0 deletions

diff --git a/src/sbkeysync.c b/src/sbkeysync.c
index 16a0627..55102c2 100644
--- a/src/sbkeysync.c
+++ b/src/sbkeysync.c
@@ -214,6 +214,14 @@ static int key_parse(struct key *key, const EFI_GUID *type,
 
 typedef int (*sigdata_fn)(EFI_SIGNATURE_DATA *, int, const EFI_GUID *, void *);
 
+/**
+ * Iterates an buffer of EFI_SIGNATURE_LISTs (at db_data, of length len),
+ * and calls fn on each EFI_SIGNATURE_DATA item found.
+ *
+ * fn is passed the EFI_SIGNATURE_DATA pointer, and the length of the
+ * signature data (including GUID header), the type of the signature list,
+ * and a context pointer.
+ */
 static int sigdb_iterate(void *db_data, size_t len,
 		sigdata_fn fn, void *arg)
 {