zfs-jail.8: Add introductory sentence, refactor #17883
Open
+49
−29
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
concussious
changed the title
allanjude
reviewed
Nov 4, 2025
man/man8/zfs-jail.8
Outdated
| .Pp | ||
| To allow management of the dataset from within a jail, the | ||
| .Sy jailed | ||
| property has to be set and the jail needs access to the |
There was a problem hiding this comment.
Suggested change
| property has to be set and the jail needs access to the | |
| property should be set and the required | |
| .Xr devfs.conf 5 | |
| entries to expose the |
man/man8/zfs-jail.8
Outdated
| .Sy jailed | ||
| property has to be set and the jail needs access to the | ||
| .Pa /dev/zfs | ||
| device. |
There was a problem hiding this comment.
Suggested change
| device. | |
| device within the jail must be present. |
man/man8/zfs-jail.8
Outdated
| .Bl -tag -width "" | ||
| The | ||
| .Nm | ||
| utility can be used to assign a dataset onto a running |
There was a problem hiding this comment.
Suggested change
| utility can be used to assign a dataset onto a running | |
| functionality can be used to assign a dataset onto a running |
zfs-jail isn't the utility itself. I originally suggested changing this to 'subcommand', but we detail both subcommands within this man page. So I think this is better wording.
man/man8/zfs-jail.8
Outdated
| feature and are not relevant on other platforms. | ||
| See | ||
| .Xr jail 8 | ||
| for more information on managing jails. |
There was a problem hiding this comment.
Should add a .Xr here to zfs-zone.8 for the equivalent functionality on Linux
Add an introductory sentance explaining why the reader may want to use this command, and establishing the requirement that the jail must be running. Move other requirements from the description of the subcommands to follow this for flow and structure. Move the caveat that this is for FreeBSD down to a cannonical CAVEATS section, and crossreference Linux's equivelant functionality. Mention that this utility can not be used to delegate the root directory of the jail to that section also. Event: OpenZFS Production User Call Reported by: Jan Brankamp <crest@rlwinm.de> Co-authored-by: Allan Jude <allan@klarasystems.com> Signed-off-by: Alexander Ziaee <ziaee@FreeBSD.org>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation and Context
This documentation change is intended to make the zfs jail manual more useful by implying why the reader would want to use the utility, exposing additional limitations, and correcting the structure of the document to accommodate this change with (hopefully) a good quality flow.
Description
Add an introductory sentance explaining why the reader may want to use this command, and establishing the requirement that the jail must be running. Move other requirements from the description of the subcommands to follow this for flow and structure. Move the caveat that this is for FreeBSD down to a cannonical CAVEATS section, and mention that this utility can not be used to delegate the root directory of the jail to that section also.
Checklist:
Signed-off-by.