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.

Sign up for GitHub

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

Jump to bottom

Modernise and lint remaining manpages #12169

Merged
merged 1 commit into from
Jun 7, 2021
Merged

Modernise and lint remaining manpages #12169

merged 1 commit into from
Jun 7, 2021

Conversation

nabijaczleweli
Copy link
Contributor

@nabijaczleweli nabijaczleweli commented May 31, 2021 •
edited
Loading

Description

On top of #12129 and #12157

This is all manpages now. zfs-module-parameters.5 is sum -2000 alone lol.

The most obvious visual difference is that zpool-features.5 no longer lists empty dependencies. This could trivially be reverted, since it's a macro now, but this reads better and the ordering makes more sense.

How Has This Been Tested?

Looked at it.

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:

@nabijaczleweli nabijaczleweli force-pushed the old-old-stock branch 6 times, most recently from da6772a to 815ae7d Compare June 1, 2021 15:44
@tonynguien tonynguien requested a review from rlaager June 1, 2021 20:05
@tonynguien tonynguien added the Status: Code Review Needed Ready for review and testing label Jun 1, 2021
@rlaager
Copy link
Member

rlaager commented Jun 1, 2021

I've addressed the earlier commits in #12129 and #12157. The new ones here look good to me. I agree that it's reasonable to drop empty dependencies in zpool-features.5.

Other than the pluralization / "a" article question (which we're discussing in #12129) which also applies here, this one LGTM.

@nabijaczleweli nabijaczleweli force-pushed the old-old-stock branch 2 times, most recently from f575748 to d4b19b7 Compare June 2, 2021 10:18
rlaager
rlaager approved these changes Jun 3, 2021
View reviewed changes
Copy link
Member

@rlaager rlaager left a comment

Choose a reason for hiding this comment

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

With the same caveat about articles from #12129, I think this is good to merge.

@nabijaczleweli nabijaczleweli marked this pull request as ready for review June 4, 2021 19:59
@nabijaczleweli
Copy link
Contributor Author

nabijaczleweli commented Jun 4, 2021 •
edited
Loading

Rebased, should be g2g?

@behlendorf behlendorf added Status: Accepted Ready to integrate (reviewed, tested) and removed Status: Code Review Needed Ready for review and testing labels Jun 4, 2021
@behlendorf
Copy link
Contributor

behlendorf commented Jun 4, 2021 •
edited
Loading

@nabijaczleweli thanks for updating this. Unless you feel strongly about keeping these commits split up let's go ahead and squash them as well.

@nabijaczleweli
Modernise/fix/rewrite unlinted manpages
bed6075 
zpool-destroy.8: flatten, fix description
zfs-wait.8: flatten, fix description, use list for events
zpool-reguid.8: flatten, fix description
zpool-history.8: flatten, fix description
zpool-export.8: flatten, fix description, remove -f "unmount" reference
  AFAICT no such command exists even in Illumos (as of today, anyway),
  and we definitely don't call it
zpool-labelclear.8: flatten, fix description
zpool-features.5: modernise
spl-module-parameters.5: modernise
zfs-mount-generator.8: rewrite
zfs-module-parameters.5: modernise

Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz>
@nabijaczleweli
Copy link
Contributor Author

nabijaczleweli commented Jun 4, 2021 •
edited
Loading

Squashed, though I do feel a tinge of attachment to this, oddly, heh (old HEAD at old-old-stock-v1)

@nabijaczleweli nabijaczleweli mentioned this pull request Jun 4, 2021
Closed
13 tasks
@tonynguien tonynguien merged commit 2d815d9 into openzfs:master Jun 7, 2021
behlendorf pushed a commit to behlendorf/zfs that referenced this pull request Jun 8, 2021
@nabijaczleweli @behlendorf
Modernise/fix/rewrite unlinted manpages
66f0c0b 
zpool-destroy.8: flatten, fix description
zfs-wait.8: flatten, fix description, use list for events
zpool-reguid.8: flatten, fix description
zpool-history.8: flatten, fix description
zpool-export.8: flatten, fix description, remove -f "unmount" reference
  AFAICT no such command exists even in Illumos (as of today, anyway),
  and we definitely don't call it
zpool-labelclear.8: flatten, fix description
zpool-features.5: modernise
spl-module-parameters.5: modernise
zfs-mount-generator.8: rewrite
zfs-module-parameters.5: modernise

Reviewed-by: Richard Laager <rlaager@wiktel.com>
Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz>
Closes openzfs#12169
behlendorf pushed a commit to behlendorf/zfs that referenced this pull request Jun 8, 2021
@nabijaczleweli @behlendorf
Modernise/fix/rewrite unlinted manpages
71ac36b 
zpool-destroy.8: flatten, fix description
zfs-wait.8: flatten, fix description, use list for events
zpool-reguid.8: flatten, fix description
zpool-history.8: flatten, fix description
zpool-export.8: flatten, fix description, remove -f "unmount" reference
  AFAICT no such command exists even in Illumos (as of today, anyway),
  and we definitely don't call it
zpool-labelclear.8: flatten, fix description
zpool-features.5: modernise
spl-module-parameters.5: modernise
zfs-mount-generator.8: rewrite
zfs-module-parameters.5: modernise

Reviewed-by: Richard Laager <rlaager@wiktel.com>
Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz>
Closes openzfs#12169
behlendorf pushed a commit to behlendorf/zfs that referenced this pull request Jun 9, 2021
@nabijaczleweli @behlendorf
Modernise/fix/rewrite unlinted manpages
d7e6f29 
zpool-destroy.8: flatten, fix description
zfs-wait.8: flatten, fix description, use list for events
zpool-reguid.8: flatten, fix description
zpool-history.8: flatten, fix description
zpool-export.8: flatten, fix description, remove -f "unmount" reference
  AFAICT no such command exists even in Illumos (as of today, anyway),
  and we definitely don't call it
zpool-labelclear.8: flatten, fix description
zpool-features.5: modernise
spl-module-parameters.5: modernise
zfs-mount-generator.8: rewrite
zfs-module-parameters.5: modernise

Reviewed-by: Richard Laager <rlaager@wiktel.com>
Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz>
Closes openzfs#12169
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@behlendorf behlendorf behlendorf approved these changes

@rlaager rlaager rlaager approved these changes

Assignees

@tonynguien tonynguien

Labels
Status: Accepted Ready to integrate (reviewed, tested)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@nabijaczleweli @rlaager @behlendorf @tonynguien