system/freebsd-src
system/freebsd-src
1
0
Fork 0
mirror of https://github.com/freebsd/freebsd-src synced 2024-09-06 17:18:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

efivar(3): Fix some typos and improve style

Browse source 
- 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@mail.ustc.edu.cn>
Reviewed by:	bcr, imp
Approved by:	krion (mentor, implicit), mat (mentor, implicit)
MFC after:	3 days
Differential Revision:	https://reviews.freebsd.org/D17686
This commit is contained in:
Mateusz Piotrowski 2018-10-25 15:41:19 +00:00
parent a0a18fd46b
commit 4026e1cc68
Notes: svn2git 2020-12-20 02:59:44 +00:00 
svn path=/head/; revision=339729
1 changed files with 41 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

60
lib/libefivar/efivar.3
View file

@ -24,12 +24,12 @@
.\" .\"
.\" $FreeBSD$ .\" $FreeBSD$
.\" .\"
.Dd September 14, 2016 .Dd October 25, 2018
.Dt LIBEFIVAR 3 .Dt LIBEFIVAR 3
.Os .Os
.Sh NAME .Sh NAME
.Nm libefivar .Nm libefivar
.Nd EFI Non Volatile Variable Suppoert .Nd EFI Non Volatile Variable Support
.Sh SYNOPSIS .Sh SYNOPSIS
.In efivar.h .In efivar.h
.Ft int .Ft int
@ -55,15 +55,17 @@
.Ft int .Ft int
.Fn efi_set_variable "efi_guid_t guid" "const char *name" "void *data" "size_t data_size" "uint32_t attributes" .Fn efi_set_variable "efi_guid_t guid" "const char *name" "void *data" "size_t data_size" "uint32_t attributes"
.Ft int .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 .Ft int
.Fn efi_variables_supported "void"; .Fn efi_variables_supported "void"
.Sh DESCRIPTION .Sh DESCRIPTION
The The
.Nm .Nm
library implements access to EFI Variables via the EFI Runtime library implements access to EFI Variables via the EFI Runtime
Serivces. Services.
All char * strings are converted to 16-bit UTF strings before passing All
.Vt "char *"
strings are converted to 16-bit UTF strings before passing
them to EFI. them to EFI.
.Pp .Pp
.Fn efi_variables_supported .Fn efi_variables_supported
@ -73,28 +75,48 @@ Otherwise zero is returned.
.Pp .Pp
.Fn efi_del_variable .Fn efi_del_variable
deletes the EFI variable selected by deletes the EFI variable selected by
.Dv guid .Va guid
and and
.Dv name . .Va name .
.Pp .Pp
.Fn efi_get_variable The following functions have not been implemented yet:
.Fn efi_get_variable_attributes .Bl -dash -offset indent -compact
.Fn efi_get_variable_size .It
.Fn efi_append_variable .Fn efi_append_variable
.Fn efi_set_variable .It
.Fn efi_get_next_variable_name .Fn efi_get_next_variable_name
.Fn efi_str_to_guid .It
.Fn efi_guid_to_str .Fn efi_get_variable
.Fn efi_name_to_guid .It
.Fn efi_get_variable_attributes
.It
.Fn efi_get_variable_size
.It
.Fn efi_guid_to_name .Fn efi_guid_to_name
.It
.Fn efi_guid_to_str
.It
.Fn efi_guid_to_symbol .Fn efi_guid_to_symbol
This function is not actually implemented. .It
.Sh BUGS .Fn efi_name_to_guid
No facilities exist to process the strings as native UTF. .It
This is a limitation in the Linux libefivar library interface. .Fn efi_set_variable
.It
.Fn efi_str_to_guid
.El
.Sh SEE ALSO .Sh SEE ALSO
.Xr efidev 4 .Xr efidev 4
.Sh HISTORY
The
.Nm
library first appeared in
.Fx 12.0 .
.Sh AUTHORS .Sh AUTHORS
.An -nosplit .An -nosplit
This software was originally written by This software was originally written by
.An Warner Losh . .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.