svn commit: r358920 - stable/12/lib/libefivar
Mateusz Piotrowski
0mp at FreeBSD.org
Thu Mar 12 20:51:07 UTC 2020
Author: 0mp (doc,ports committer)
Date: Thu Mar 12 20:51:04 2020
New Revision: 358920
URL: https://svnweb.freebsd.org/changeset/base/358920
Log:
MFC 339729:
efivar(3): Fix some typos and improve style
- Fix some typos.
- Remove redundant semicolons from the synopsis section.
- Stylize variable names and types with Vt and Va respectively.
- Use a list to present non-implemented functions.
- Sort the order of the sections.
- Add a history section.
- Use Nm when "libefivar" is mentioned.
PR: 232626
Reported by: Tiwei Bie <btw at mail.ustc.edu.cn>
Reviewed by: bcr, imp
Approved by: krion (mentor, implicit), mat (mentor, implicit)
Differential Revision: https://reviews.freebsd.org/D17686
Approved by: bcr (mentor)
Differential Revision: https://reviews.freebsd.org/D24044
Modified:
stable/12/lib/libefivar/efivar.3
Directory Properties:
stable/12/ (props changed)
Modified: stable/12/lib/libefivar/efivar.3
==============================================================================
--- stable/12/lib/libefivar/efivar.3 Thu Mar 12 19:55:51 2020 (r358919)
+++ stable/12/lib/libefivar/efivar.3 Thu Mar 12 20:51:04 2020 (r358920)
@@ -25,12 +25,12 @@
.\"
.\" $FreeBSD$
.\"
-.Dd September 14, 2016
+.Dd October 25, 2018
.Dt LIBEFIVAR 3
.Os
.Sh NAME
.Nm libefivar
-.Nd EFI Non Volatile Variable Suppoert
+.Nd EFI Non Volatile Variable Support
.Sh SYNOPSIS
.In efivar.h
.Ft int
@@ -56,15 +56,17 @@
.Ft int
.Fn efi_set_variable "efi_guid_t guid" "const char *name" "void *data" "size_t data_size" "uint32_t attributes"
.Ft int
-.Fn efi_str_to_guid "const char *s" "efi_guid_t *guid";
+.Fn efi_str_to_guid "const char *s" "efi_guid_t *guid"
.Ft int
-.Fn efi_variables_supported "void";
+.Fn efi_variables_supported "void"
.Sh DESCRIPTION
The
.Nm
library implements access to EFI Variables via the EFI Runtime
-Serivces.
-All char * strings are converted to 16-bit UTF strings before passing
+Services.
+All
+.Vt "char *"
+strings are converted to 16-bit UTF strings before passing
them to EFI.
.Pp
.Fn efi_variables_supported
@@ -74,28 +76,48 @@ Otherwise zero is returned.
.Pp
.Fn efi_del_variable
deletes the EFI variable selected by
-.Dv guid
+.Va guid
and
-.Dv name .
+.Va name .
.Pp
+The following functions have not been implemented yet:
+.Bl -dash -offset indent -compact
+.It
+.Fn efi_append_variable
+.It
+.Fn efi_get_next_variable_name
+.It
.Fn efi_get_variable
+.It
.Fn efi_get_variable_attributes
+.It
.Fn efi_get_variable_size
-.Fn efi_append_variable
-.Fn efi_set_variable
-.Fn efi_get_next_variable_name
-.Fn efi_str_to_guid
-.Fn efi_guid_to_str
-.Fn efi_name_to_guid
+.It
.Fn efi_guid_to_name
+.It
+.Fn efi_guid_to_str
+.It
.Fn efi_guid_to_symbol
-This function is not actually implemented.
-.Sh BUGS
-No facilities exist to process the strings as native UTF.
-This is a limitation in the Linux libefivar library interface.
+.It
+.Fn efi_name_to_guid
+.It
+.Fn efi_set_variable
+.It
+.Fn efi_str_to_guid
+.El
.Sh SEE ALSO
.Xr efidev 4
+.Sh HISTORY
+The
+.Nm
+library first appeared in
+.Fx 12.0 .
.Sh AUTHORS
.An -nosplit
This software was originally written by
.An Warner Losh .
+.Sh BUGS
+No facilities exist to process the strings as native UTF.
+This is a limitation in the Linux
+.Nm
+library interface.
More information about the svn-src-stable-12
mailing list