d/freebsd-nq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

mdoc(7) police:

Browse Source 
- lowercase Nd argument
- mark function arguments with Fa
- mark defined values with Dv
- simply copying POSIX text for RETURN VALUES and ERRORS sections is not
  always a good idea.  POSIX uses the word "shall" indicating the behavior
  the correct implementation should follow.
This commit is contained in:
Ruslan Ermilov 2001-03-19 08:08:22 +00:00
parent 6eee1a1c12
commit bc057d3dff
4 changed files with 58 additions and 82 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
lib/libc/posix1e/acl_calc_mask.3
View File

@ -30,7 +30,7 @@
.Os
.Sh NAME
.Nm acl_calc_mask
.Nd Calculate and set ACL mask permissions
.Nd calculate and set ACL mask permissions
.Sh LIBRARY
.Lb libposix1e
.Sh SYNOPSIS
@ -41,40 +41,38 @@
.Sh DESCRIPTION
.Fn acl_calc_mask
is a POSIX.1e call that calculates and set the permissions
associated with the ACL_MASK ACL entry of the ACL referred to by
.Ar acl_p .
associated with the
.Dv ACL_MASK
ACL entry of the ACL referred to by
.Fa acl_p .
.Pp
The value of new permissions are the union of the permissions
granted by the ACL_GROUP, ACL_GROUP_OBJ, ACL_USER tag types which
granted by the
.Dv ACL_GROUP , ACL_GROUP_OBJ , ACL_USER
tag types which
match processes in the file group class contained in the ACL
referred to by
.Ar acl_p .
.Fa acl_p .
.Pp
If the ACL referred to by
.Ar acl_p
already contains an ACL_MASK entry, its permissions shall be
overwritten; if it does not contain an ACL_MASK entry, one shall
.Fa acl_p
already contains an
.Dv ACL_MASK
entry, its permissions shall be
overwritten; if it does not contain an
.Dv ACL_MASK
entry, one shall
be added.
.Sh RETURN VALUES
Upon successful completion, the function shall return a value of
.Va 0 .
Otherwise, a value of
.Va -1
shall be returned, and
.Va errno
shall be set to indicate the error.
.Rv -std acl_calc_mask
.Sh ERRORS
If the following condition occurs, the
The
.Fn acl_calc_mask
function shall return a value of
.Va -1
and set
.Va errno
to the corresponding value:
function fails if:
.Bl -tag -width Er
.It Bq Er EINVAL
Argument
.Ar acl_p
.Fa acl_p
does not point to a pointer to a valid ACL.
.El
.Sh SEE ALSO

28
lib/libc/posix1e/acl_delete_entry.3
View File

@ -30,7 +30,7 @@
.Os
.Sh NAME
.Nm acl_delete_entry
.Nd Delete an ACL entry from an ACL
.Nd delete an ACL entry from an ACL
.Sh LIBRARY
.Lb libposix1e
.Sh SYNOPSIS
@ -41,33 +41,23 @@
.Sh DESCRIPTION
.Fn acl_delete_entry
is a POSIX.1e call that removes the ACL entry
.Ar entry_d
.Fa entry_d
from ACL
.Ar acl .
.Fa acl .
.Sh RETURN VALUES
Upon successful completion, the function shall return a value of
.Va 0 .
Otherwise, a value of
.Va -1
shall be returned, and
.Va errno
shall be set to indicate the error.
.Rv -std acl_delete_entry
.Sh ERRORS
If the following condition occurs, the
The
.Fn acl_delete_entry
function shall return a value of
.Va -1
and set
.Va errno
to the corresponding value:
function fails if:
.Bl -tag -width Er
.It Bq Er EINVAL
Argument
.Ar acl
.Fa acl
does not point to a valid ACL. Argument
.Ar entry_d
.Fa entry_d
is not a valid descriptor for an ACL entry in
.Ar acl .
.Fa acl .
.El
.Sh SEE ALSO
.Xr acl 3 ,

42
lib/libposix1e/acl_calc_mask.3
View File

@ -30,7 +30,7 @@
.Os
.Sh NAME
.Nm acl_calc_mask
.Nd Calculate and set ACL mask permissions
.Nd calculate and set ACL mask permissions
.Sh LIBRARY
.Lb libposix1e
.Sh SYNOPSIS
@ -41,40 +41,38 @@
.Sh DESCRIPTION
.Fn acl_calc_mask
is a POSIX.1e call that calculates and set the permissions
associated with the ACL_MASK ACL entry of the ACL referred to by
.Ar acl_p .
associated with the
.Dv ACL_MASK
ACL entry of the ACL referred to by
.Fa acl_p .
.Pp
The value of new permissions are the union of the permissions
granted by the ACL_GROUP, ACL_GROUP_OBJ, ACL_USER tag types which
granted by the
.Dv ACL_GROUP , ACL_GROUP_OBJ , ACL_USER
tag types which
match processes in the file group class contained in the ACL
referred to by
.Ar acl_p .
.Fa acl_p .
.Pp
If the ACL referred to by
.Ar acl_p
already contains an ACL_MASK entry, its permissions shall be
overwritten; if it does not contain an ACL_MASK entry, one shall
.Fa acl_p
already contains an
.Dv ACL_MASK
entry, its permissions shall be
overwritten; if it does not contain an
.Dv ACL_MASK
entry, one shall
be added.
.Sh RETURN VALUES
Upon successful completion, the function shall return a value of
.Va 0 .
Otherwise, a value of
.Va -1
shall be returned, and
.Va errno
shall be set to indicate the error.
.Rv -std acl_calc_mask
.Sh ERRORS
If the following condition occurs, the
The
.Fn acl_calc_mask
function shall return a value of
.Va -1
and set
.Va errno
to the corresponding value:
function fails if:
.Bl -tag -width Er
.It Bq Er EINVAL
Argument
.Ar acl_p
.Fa acl_p
does not point to a pointer to a valid ACL.
.El
.Sh SEE ALSO

28
lib/libposix1e/acl_delete_entry.3
View File

@ -30,7 +30,7 @@
.Os
.Sh NAME
.Nm acl_delete_entry
.Nd Delete an ACL entry from an ACL
.Nd delete an ACL entry from an ACL
.Sh LIBRARY
.Lb libposix1e
.Sh SYNOPSIS
@ -41,33 +41,23 @@
.Sh DESCRIPTION
.Fn acl_delete_entry
is a POSIX.1e call that removes the ACL entry
.Ar entry_d
.Fa entry_d
from ACL
.Ar acl .
.Fa acl .
.Sh RETURN VALUES
Upon successful completion, the function shall return a value of
.Va 0 .
Otherwise, a value of
.Va -1
shall be returned, and
.Va errno
shall be set to indicate the error.
.Rv -std acl_delete_entry
.Sh ERRORS
If the following condition occurs, the
The
.Fn acl_delete_entry
function shall return a value of
.Va -1
and set
.Va errno
to the corresponding value:
function fails if:
.Bl -tag -width Er
.It Bq Er EINVAL
Argument
.Ar acl
.Fa acl
does not point to a valid ACL. Argument
.Ar entry_d
.Fa entry_d
is not a valid descriptor for an ACL entry in
.Ar acl .
.Fa acl .
.El
.Sh SEE ALSO
.Xr acl 3 ,