Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

zfsprops.7: Add note about comma-separation #12579

Merged
merged 2 commits into from
Oct 29, 2021
Merged

zfsprops.7: Add note about comma-separation #12579

merged 2 commits into from
Oct 29, 2021

Conversation

debdrup
Copy link
Contributor

@debdrup debdrup commented Sep 21, 2021

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

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Performance enhancement (non-breaking change which improves efficiency)
  • Code cleanup (non-breaking change which makes code smaller or more readable)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Library ABI change (libzfs, libzfs_core, libnvpair, libuutil and libzfsbootenv)
  • Documentation (a change to man pages or other documentation)

Checklist:

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.

Signed-off-by: Daniel Ebdrup Jensen <[email protected]>
@ericloewe
Copy link

Don't you have a duplicate "with" in there?

@behlendorf behlendorf added Status: Code Review Needed Ready for review and testing Type: Documentation Indicates a requested change to the documentation labels Sep 22, 2021
Copy link
Contributor

@behlendorf behlendorf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aside from the typo this looks fine. The comma separated format originally comes from what was used on Solaris, which I presume was done to keep the parsing simple.

man/man7/zfsprops.7 Outdated Show resolved Hide resolved
@behlendorf behlendorf added Status: Revision Needed Changes are required for the PR to be accepted and removed Status: Code Review Needed Ready for review and testing labels Oct 1, 2021
@behlendorf behlendorf added Status: Accepted Ready to integrate (reviewed, tested) and removed Status: Revision Needed Changes are required for the PR to be accepted labels Oct 29, 2021
@behlendorf behlendorf merged commit 28401f6 into openzfs:master Oct 29, 2021
tonyhutter pushed a commit to tonyhutter/zfs that referenced this pull request Feb 10, 2022
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.

Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Daniel Ebdrup Jensen <[email protected]>
Closes openzfs#12579
tonyhutter pushed a commit to tonyhutter/zfs that referenced this pull request Feb 16, 2022
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.

Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Daniel Ebdrup Jensen <[email protected]>
Closes openzfs#12579
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Accepted Ready to integrate (reviewed, tested) Type: Documentation Indicates a requested change to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants