svn commit: r362560 - head/lib/libufs

[Kirk McKusick]

Author: mckusick
Date: Tue Jun 23 21:37:12 2020
New Revision: 362560
URL: https://svnweb.freebsd.org/changeset/base/362560

Log:
  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

Modified:
  head/lib/libufs/sbread.3

Modified: head/lib/libufs/sbread.3
==============================================================================
--- head/lib/libufs/sbread.3	Tue Jun 23 21:28:26 2020	(r362559)
+++ head/lib/libufs/sbread.3	Tue Jun 23 21:37:12 2020	(r362560)
@@ -109,28 +109,30 @@ function will write to all the alternate superblock lo
 .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 ,