Add documentation for efi_get_next_variable_name()

Signed-off-by: Peter Jones <pjones@redhat.com>

diff --git a/docs/efi_get_next_variable_name.3 b/docs/efi_get_next_variable_name.3
new file mode 100644 (file)
index 0000000..bcc1340
--- /dev/null
+++ b/docs/efi_get_next_variable_name.3
@@ -0,0 +1 @@
+.so man3/efi_get_variable.3

diff --git a/docs/efi_get_variable.3 b/docs/efi_get_variable.3
index cf6cac9..df4c1a1 100644 (file)
--- a/docs/efi_get_variable.3
+++ b/docs/efi_get_variable.3
@@ -23,6 +23,8 @@ manipulate UEFI variables
 \fBint efi_set_variable(efi_guid_t \fR\fIguid\fR\fB, const char *\fR\fIname\fR\fB,
                                 void *\fR\fIdata\fR\fB, size_t \fR\fIdata_size\fR\fB,
                                 uint32_t \fR\fIattributes\fR\fB);\fR
+
+\fBint efi_get_next_variable_name(efi_guid_t **\fR\fIguid\fR\fB, char **\fr\fIname\fR\fB;\fR
 .fi
 .SH DESCRIPTION
 .BR efi_variables_supported ()
@@ -43,9 +45,14 @@ gets the size of the data for the variable specified by \fIguid\fR and \fIname\f
 .BR efi_set_variable ()
 sets the variable specified by \fIguid\fR and \fIname\fR.
 .PP
+.BR efi_get_next_variable_name ()
+iterates across the currently extant variables, passing back a guid and name.
+.PP
 .SH "RETURN VALUE"
 \fBefi_variables_supported\fR() returns true if variables are supported on the running hardware, and false if they are not.
 .PP
+\fBefi_get_next_variable_name\fR() returns 0 when iteration has completed, 1 when iteration has not completed, and -1 on error.
+.PP
 \fBefi_del_variable\fR(), \fBefi_get_variable\fR(), \fBefi_get_variable_attributes\fR(), \fBefi_get_variable_size\fR(), and \fBefi_set_variable\fR() return negative on error and zero on success.
 .SH AUTHORS
 .nf