Correctly describe the return values for the libufs library sbget()

and sbput() functions that respectively read and write the superblock.

PR:           247425
Sponsored by: Netflix
This commit is contained in:
Kirk McKusick 2020-06-23 21:37:12 +00:00
parent 92c839a156
commit d7fcdf5d48
Notes: svn2git 2020-12-20 02:59:44 +00:00
svn path=/head/; revision=362560

View file

@ -109,28 +109,30 @@ function will write to all the alternate superblock locations if the
.Fa all
value is non-zero.
.Sh RETURN VALUES
.Rv -std sbget sbput sbread sbwrite
.Sh ERRORS
.Rv -std sbread sbwrite
The
.Fn sbget
and
.Fn sbput
functions return the value 0 if successful;
otherwise they return one of the errors described below.
.Sh ERRORS
The errors returned by
.Fn sbget
and
.Fn sbread
functions may fail and set
.Va errno
for any of the errors specified for the library function
include any of the errors specified for the library function
.Xr bread 3 .
Additionally, it may follow the
Additionally, they may follow the
.Xr libufs 3
error methodologies in situations where no usable superblock could be
found.
.Pp
The
The errors returned by
.Fn sbput
and
.Fn sbwrite
functions may fail and set
.Va errno
for any of the errors specified for the library function
include any of the errors specified for the library function
.Xr bwrite 3 .
.Sh SEE ALSO
.Xr bread 3 ,