Author: trasz Date: Sat May 23 13:51:05 2009 New Revision: 192638 URL: http://svn.freebsd.org/changeset/base/192638
Log: Improve API documentation. Reviewed by: rwatson (earlier version) Modified: head/lib/libc/posix1e/acl.3 head/lib/libc/posix1e/acl_add_perm.3 head/lib/libc/posix1e/acl_get.3 head/lib/libc/posix1e/acl_set.3 head/lib/libc/posix1e/acl_set_tag_type.3 Modified: head/lib/libc/posix1e/acl.3 ============================================================================== --- head/lib/libc/posix1e/acl.3 Sat May 23 13:44:37 2009 (r192637) +++ head/lib/libc/posix1e/acl.3 Sat May 23 13:51:05 2009 (r192638) @@ -48,7 +48,7 @@ The library calls include routines to al and validate ACLs associated with file objects. As well as the POSIX.1e routines, there are a number of non-portable extensions defined that allow for alternative ACL semantics than the -POSIX.1e semantics, such as AFS, NTFS, Coda, and NWFS semantics. +POSIX.1e semantics, such as NFSv4, AFS, NTFS, Coda, and NWFS semantics. Where routines are non-standard, they are suffixed with _np to indicate that they are not portable. .Pp Modified: head/lib/libc/posix1e/acl_add_perm.3 ============================================================================== --- head/lib/libc/posix1e/acl_add_perm.3 Sat May 23 13:44:37 2009 (r192637) +++ head/lib/libc/posix1e/acl_add_perm.3 Sat May 23 13:51:05 2009 (r192638) @@ -49,6 +49,14 @@ to the permission set .Pp Note: it is not considered an error to attempt to add permissions that already exist in the permission set. +.Pp +For POSIX.1e ACLs, valid values are: +.Pp +.Bl -column -offset 3n "ACL_EXECUTE" +.It ACL_EXECUTE Execute permission +.It ACL_WRITE Write permission +.It ACL_READ Read permission +.El .Sh RETURN VALUES .Rv -std acl_add_perm .Sh ERRORS Modified: head/lib/libc/posix1e/acl_get.3 ============================================================================== --- head/lib/libc/posix1e/acl_get.3 Sat May 23 13:44:37 2009 (r192637) +++ head/lib/libc/posix1e/acl_get.3 Sat May 23 13:51:05 2009 (r192638) @@ -91,6 +91,15 @@ with the object referred to by .Va fd . The ACL in the working storage shall not participate in any access control decisions. +.Pp +Valid values for the +.Va type +argument are: +.Pp +.Bl -column -offset 3n "ACL_TYPE_DEFAULT" +.It ACL_TYPE_ACCESS POSIX.1e access ACL +.It ACL_TYPE_DEFAULT POSIX.1e default ACL +.El .Sh IMPLEMENTATION NOTES .Fx Ns 's support for POSIX.1e interfaces and features is still under Modified: head/lib/libc/posix1e/acl_set.3 ============================================================================== --- head/lib/libc/posix1e/acl_set.3 Sat May 23 13:44:37 2009 (r192637) +++ head/lib/libc/posix1e/acl_set.3 Sat May 23 13:51:05 2009 (r192638) @@ -75,6 +75,15 @@ The .Fn acl_set_link_np function acts on a symlink rather than its target, if the target of the path is a symlink. +.Pp +Valid values for the +.Va type +argument are: +.Pp +.Bl -column -offset 3n "ACL_TYPE_DEFAULT" +.It ACL_TYPE_ACCESS POSIX.1e access ACL +.It ACL_TYPE_DEFAULT POSIX.1e default ACL +.El .Sh IMPLEMENTATION NOTES .Fx Ns 's support for POSIX.1e interfaces and features is still under Modified: head/lib/libc/posix1e/acl_set_tag_type.3 ============================================================================== --- head/lib/libc/posix1e/acl_set_tag_type.3 Sat May 23 13:44:37 2009 (r192637) +++ head/lib/libc/posix1e/acl_set_tag_type.3 Sat May 23 13:51:05 2009 (r192638) @@ -46,6 +46,18 @@ is a POSIX.1e call that sets the ACL tag .Fa entry_d to the value of .Fa tag_type . +.Pp +Valid values are: +.Pp +.Bl -column -offset 3n "ACL_EVERYONE" +.It ACL_USER_OBJ Permissions apply to file owner +.It ACL_USER Permissions apply to additional user specified by qualifier +.It ACL_GROUP_OBJ Permissions apply to file group +.It ACL_GROUP Permissions apply to additional group specified by qualifier +.It ACL_MASK Permissions specify mask +.It ACL_OTHER Permissions apply to "other" +.It ACL_OTHER_OBJ Same as ACL_OTHER +.El .Sh RETURN VALUES .Rv -std acl_set_tag_type .Sh ERRORS _______________________________________________ svn-src-all@freebsd.org mailing list http://lists.freebsd.org/mailman/listinfo/svn-src-all To unsubscribe, send any mail to "svn-src-all-unsubscr...@freebsd.org"
