Bug 162380

Summary: Documentation lacking for getfacl/setfacl
Product: Documentation Reporter: Enji Cooper <ngie>
Component: Books & ArticlesAssignee: Edward Tomasz Napierala <trasz>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description Enji Cooper freebsd_committer freebsd_triage 2011-11-08 19:20:08 UTC
getfacl and setfacl are lacking documentation, s.t. it's hard to interpret ACL output from getfacl and it's hard to interpret what inputs need to be provided to setfacl in order to get the desired results in terms of permissions, etc.

Basically, it would be nice if acl(3) said what the print outs meant, and getfacl(1) and setfacl(1) referenced acl(3) so that everything could be tied together appropriately and people could better understand what the utilities do.
Comment 1 Enji Cooper freebsd_committer freebsd_triage 2012-01-12 00:45:14 UTC
Here's the code that 'documents' the flags output via getfacl, can be
set via setfacl, etc:

struct flagnames_struct a_access_masks[] =
    {{ ACL_READ_DATA, "read_data", 'r'},
     { ACL_WRITE_DATA, "write_data", 'w'},
     { ACL_EXECUTE, "execute", 'x'},
     { ACL_APPEND_DATA, "append_data", 'p'},
     { ACL_DELETE_CHILD, "delete_child", 'D'},
     { ACL_DELETE, "delete", 'd'},
     { ACL_READ_ATTRIBUTES, "read_attributes", 'a'},
     { ACL_WRITE_ATTRIBUTES, "write_attributes", 'A'},
     { ACL_READ_NAMED_ATTRS, "read_xattr", 'R'},
     { ACL_WRITE_NAMED_ATTRS, "write_xattr", 'W'},
     { ACL_READ_ACL, "read_acl", 'c'},
     { ACL_WRITE_ACL, "write_acl", 'C'},
     { ACL_WRITE_OWNER, "write_owner", 'o'},
     { ACL_SYNCHRONIZE, "synchronize", 's'},
     { ACL_FULL_SET, "full_set", '\0'},
     { ACL_MODIFY_SET, "modify_set", '\0'},
     { ACL_READ_SET, "read_set", '\0'},
     { ACL_WRITE_SET, "write_set", '\0'},
     { 0, 0, 0}};

The code lives in lib/libc/posix1e/acl_support_nfs4.c

Thanks!
-Garrett
Comment 2 Enji Cooper freebsd_committer freebsd_triage 2012-01-16 20:18:10 UTC
    Correction: the documentation for _get_facl is lacking -- not
setfacl. setfacl describes everything properly -- minus the
synchronization flag being the wrong case, e.g. 'S', as opposed to
's'.
Thanks,
-Garrett
Comment 3 dfilter service freebsd_committer freebsd_triage 2012-09-03 18:26:32 UTC
Author: trasz
Date: Mon Sep  3 17:26:20 2012
New Revision: 240076
URL: http://svn.freebsd.org/changeset/base/240076

Log:
  Fix compact form of "synchronize" permission in setfacl(1) manual page - it
  should be "s", not "S".
  
  PR:		docs/162380
  MFC after:	2 weeks

Modified:
  head/bin/setfacl/setfacl.1

Modified: head/bin/setfacl/setfacl.1
==============================================================================
--- head/bin/setfacl/setfacl.1	Mon Sep  3 16:51:41 2012	(r240075)
+++ head/bin/setfacl/setfacl.1	Mon Sep  3 17:26:20 2012	(r240076)
@@ -26,7 +26,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd April 9, 2011
+.Dd September 2, 2012
 .Dt SETFACL 1
 .Os
 .Sh NAME
@@ -337,7 +337,7 @@ read_acl
 write_acl
 .It o
 write_owner
-.It S
+.It s
 synchronize
 .El
 .Pp
_______________________________________________
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-unsubscribe@freebsd.org"
Comment 4 Edward Tomasz Napierala freebsd_committer freebsd_triage 2012-09-03 18:28:16 UTC
Responsible Changed
From-To: freebsd-doc->trasz

I'll take it.
Comment 5 dfilter service freebsd_committer freebsd_triage 2012-09-04 13:02:38 UTC
Author: trasz
Date: Tue Sep  4 12:02:23 2012
New Revision: 240085
URL: http://svn.freebsd.org/changeset/base/240085

Log:
  In getfacl(1) manual page, mention where to read about the ACL syntax.
  PR submitter suggested adding it to acl(3) instead, but I don't think
  pointing ordinary users at section 3 is a good idea.
  
  PR:		docs/162380
  MFC after:	1 month

Modified:
  head/bin/getfacl/getfacl.1

Modified: head/bin/getfacl/getfacl.1
==============================================================================
--- head/bin/getfacl/getfacl.1	Tue Sep  4 11:50:13 2012	(r240084)
+++ head/bin/getfacl/getfacl.1	Tue Sep  4 12:02:23 2012	(r240085)
@@ -97,6 +97,10 @@ then
 reads a list of pathnames, each terminated by one newline character,
 from the standard input.
 .El
+.Pp
+For an explanation of the ACL syntax, see the
+.Xr setfacl 1
+manual page.
 .Sh EXIT STATUS
 .Ex -std
 .Sh EXAMPLES
_______________________________________________
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-unsubscribe@freebsd.org"
Comment 6 Edward Tomasz Napierala freebsd_committer freebsd_triage 2012-09-04 13:05:46 UTC
State Changed
From-To: open->patched

Fixed in HEAD.
Comment 7 dfilter service freebsd_committer freebsd_triage 2012-09-17 12:22:08 UTC
Author: trasz
Date: Mon Sep 17 11:21:57 2012
New Revision: 240598
URL: http://svn.freebsd.org/changeset/base/240598

Log:
  MFC r240076:
  
  Fix compact form of "synchronize" permission in setfacl(1) manual page - it
  should be "s", not "S".
  
  PR:		docs/162380

Modified:
  stable/9/bin/setfacl/setfacl.1
Directory Properties:
  stable/9/bin/setfacl/   (props changed)

Modified: stable/9/bin/setfacl/setfacl.1
==============================================================================
--- stable/9/bin/setfacl/setfacl.1	Mon Sep 17 09:32:11 2012	(r240597)
+++ stable/9/bin/setfacl/setfacl.1	Mon Sep 17 11:21:57 2012	(r240598)
@@ -26,7 +26,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd April 9, 2011
+.Dd September 2, 2012
 .Dt SETFACL 1
 .Os
 .Sh NAME
@@ -337,7 +337,7 @@ read_acl
 write_acl
 .It o
 write_owner
-.It S
+.It s
 synchronize
 .El
 .Pp
_______________________________________________
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-unsubscribe@freebsd.org"
Comment 8 Edward Tomasz Napierala freebsd_committer freebsd_triage 2012-09-17 12:22:27 UTC
State Changed
From-To: patched->closed

MFC-ed to 9-STABLE.
Comment 9 dfilter service freebsd_committer freebsd_triage 2012-10-04 09:53:18 UTC
Author: trasz
Date: Thu Oct  4 08:43:49 2012
New Revision: 241186
URL: http://svn.freebsd.org/changeset/base/241186

Log:
  MFC r240085:
  
  In getfacl(1) manual page, mention where to read about the ACL syntax.
  PR submitter suggested adding it to acl(3) instead, but I don't think
  pointing ordinary users at section 3 is a good idea.
  
  PR:		docs/162380

Modified:
  stable/9/bin/getfacl/getfacl.1
Directory Properties:
  stable/9/bin/getfacl/   (props changed)

Modified: stable/9/bin/getfacl/getfacl.1
==============================================================================
--- stable/9/bin/getfacl/getfacl.1	Thu Oct  4 08:33:46 2012	(r241185)
+++ stable/9/bin/getfacl/getfacl.1	Thu Oct  4 08:43:49 2012	(r241186)
@@ -97,6 +97,10 @@ then
 reads a list of pathnames, each terminated by one newline character,
 from the standard input.
 .El
+.Pp
+For an explanation of the ACL syntax, see the
+.Xr setfacl 1
+manual page.
 .Sh EXIT STATUS
 .Ex -std
 .Sh EXAMPLES
_______________________________________________
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-unsubscribe@freebsd.org"