zfsprops.7: Add note about comma-separation #12579
Merged
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.
This change primarily seeks to make implicit documentation explicit, as
it is not outright stated that options should be comma-separated, nor is
there a reason given for it.
Motivation and Context
Having implicit documentation can lead to important details being lost,
and makes it harder to point to anything specific.
Description
An extra paragraph has been added to make it clear that the options are
comma-separated, and that this is different from what's expected in
exports(5). Additionally, the reason for the choice is expanded upon,
and although I wasn't able to find a commit to back this up, I think it
might be nice to have something to refer to in the commit message.
How Has This Been Tested?
It has been tested using mandoc on FreeBSD 13, rendered to both less(1)
and as a HTML using -Thtml
Types of changes
Checklist:
requirements.
document.
Signed-off-by
.