extattr_get_file(2): clarify RETURN VALUES
While some of the syscalls' behavior were documented and implied in the RETURN VALUES section by earlier, e.g., the DESCRIPTION sections, as having behavior of the other calls (`*_fd` vs `*_file` vs `*_link`), there was a lot of implied return value behavior in the section prior to this change. Explicitly document the syscall behavior per the current implementation in sys/kern/vfs_extattr.c so others can better develop based on its explicit documented behavior instead of having to digest the context of the manpage to understand the appropriate behavior. MFC after: 1 week MFC with: r368431, r368433, r368434 Sponsored by: DellEMC Isilon
This commit is contained in:
parent
f705523939
commit
cf681016d4
Notes:
svn2git
2020-12-20 02:59:44 +00:00
svn path=/head/; revision=368435
@ -169,21 +169,32 @@ For more information on named extended attributes, please see
|
|||||||
.Xr extattr 9 .
|
.Xr extattr 9 .
|
||||||
.Sh RETURN VALUES
|
.Sh RETURN VALUES
|
||||||
If successful, the
|
If successful, the
|
||||||
|
.Fn extattr_get_fd ,
|
||||||
.Fn extattr_get_file ,
|
.Fn extattr_get_file ,
|
||||||
|
.Fn extattr_get_link ,
|
||||||
|
.Fn extattr_list_fd ,
|
||||||
|
.Fn extattr_list_file ,
|
||||||
|
.Fn extattr_list_link ,
|
||||||
|
.Fn extattr_set_fd ,
|
||||||
.Fn extattr_set_file ,
|
.Fn extattr_set_file ,
|
||||||
and
|
and
|
||||||
.Fn extattr_list_file
|
.Fn extattr_set_link
|
||||||
calls return the number of bytes
|
calls return the number of bytes
|
||||||
that were read or written from the
|
that were read or written from the
|
||||||
.Fa data ,
|
.Fa data ,
|
||||||
respectively, or if
|
respectively.
|
||||||
|
If
|
||||||
.Fa data
|
.Fa data
|
||||||
was
|
was
|
||||||
.Dv NULL ,
|
.Dv NULL ,
|
||||||
then
|
then
|
||||||
.Fn extattr_get_file
|
.Fn extattr_get_fd ,
|
||||||
|
.Fn extattr_get_file ,
|
||||||
|
.Fn extattr_get_link ,
|
||||||
|
.Fn extattr_list_fd ,
|
||||||
|
.Fn extattr_list_file ,
|
||||||
and
|
and
|
||||||
.Fn extattr_list_file
|
.Fn extattr_list_link
|
||||||
return the number of bytes available to read.
|
return the number of bytes available to read.
|
||||||
If any of the calls are unsuccessful, the value \-1 is returned
|
If any of the calls are unsuccessful, the value \-1 is returned
|
||||||
and the global variable
|
and the global variable
|
||||||
|
Loading…
Reference in New Issue
Block a user