Bug 227406 - man zfs need correcting on import to FreeBSD, as some behaviours differ from its source OS
Summary: man zfs need correcting on import to FreeBSD, as some behaviours differ from ...
Status: New
Alias: None
Product: Documentation
Classification: Unclassified
Component: Manual Pages (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Some People
Assignee: freebsd-bugs (Nobody)
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2018-04-10 03:50 UTC by Stilez
Modified: 2018-04-10 04:15 UTC (History)
1 user (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Stilez 2018-04-10 03:50:01 UTC
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.
Comment 1 Stilez 2018-04-10 04:15:38 UTC
clarification to OP, 3rd para, "the setuid bit acts on files and dirs if the file system supports it" is referencing the chmod 4000 bit, not the zfs property of the same name. The issue is that zfs only supports it partially (files but not dirs) but its man page doesn't say so.