[Bug 227406] man zfs describes effect of some flags on solaris/classic unix, need correcting for differences on import to FreeBSD

[bugzilla-noreply at freebsd.org]

https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=227406

            Bug ID: 227406
           Summary: man zfs describes effect of some flags on
                    solaris/classic unix, need correcting for differences
                    on import to FreeBSD
           Product: Documentation
           Version: Latest
          Hardware: Any
                OS: Any
            Status: New
          Severity: Affects Some People
          Priority: ---
         Component: Manual Pages
          Assignee: bugs at FreeBSD.org
          Reporter: stilezy at gmail.com
                CC: doc at FreeBSD.org

The zfs man page has been imported from its source unix
(illumos/openzfs/solaris/classical unix of some kind) without correcting for
discrepancies between the source OS described and FreeBSD. It therefore
misleads about the scope of the setuid flag on FreeBSD.

"man zfs" -> "setuid=on" property states that this property "controls whether
the set-UID bit is respected for the file system". There are no stated
qualifiers/limitations. 

On a classical unix this may be a correct description but on FreeBSD the setuid
bit acts on files **and dirs** "if the file system supports it", which "man
zfs" implies it does (ref: man chmod).

So a plain reading of man zfs is that setting this property will affect files
and dirs. This is not correct *for FreeBSD* even if common on other UNIXes.


Correction required:

"setuid = on | off : Controls whether the set-UID bit is respected for **files
on** the file system. **The property has no effect on directories on the file
system**.  The default value is on."


Current wording (incorrect):

"setuid = on | off : Controls whether the set-UID bit is respected for the file
system. The default value is on."


Issue identified via FreeBSD-fs mailing list discussion.

-- 
You are receiving this mail because:
You are on the CC list for the bug.