From d7fcdf5d488b3b3b5049468da01ed0689e3ae53d Mon Sep 17 00:00:00 2001 From: Kirk McKusick Date: Tue, 23 Jun 2020 21:37:12 +0000 Subject: [PATCH] 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 --- lib/libufs/sbread.3 | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/lib/libufs/sbread.3 b/lib/libufs/sbread.3 index 42342b2f3271..13cadd39d9b2 100644 --- a/lib/libufs/sbread.3 +++ b/lib/libufs/sbread.3 @@ -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 ,