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

Expand zpool-remove.8 manpage with example results #16777

Merged
merged 1 commit into from
Nov 19, 2024

Conversation

smokris
Copy link
Contributor

@smokris smokris commented Nov 18, 2024

Motivation and Context

In the zpool-remove manpage's example of removing mirrors, it wasn't clear to me whether the removal commands would remove the entire vdev, or merely cause the mirrored vdev become unmirrored (reduce its redundancy). I performed a test and confirmed that it's the former, so I figured it might be useful to include the results in the example.

Also, zpool-remove.8 has a comment cross-referencing to zpool.8, but the example number was off, so I fixed it.

How Has This Been Tested?

Verified formatting by running:

man ./man/man8/zpool-remove.8
man ./man/man8/zpool.8

Also ran:

./scripts/mancheck.sh man

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:

  • My code follows the OpenZFS code style requirements.
    • I didn't find a style guide for manpages.
  • I have updated the documentation accordingly.
  • I have read the contributing document.
  • I have added tests to cover my changes.
    • n/a
  • I have run the ZFS Test Suite with this change applied.
    • n/a
  • All commit messages are properly formatted and contain Signed-off-by.

Also fix comment cross-referencing to zpool.8.

Signed-off-by: Steve Mokris <[email protected]>
Copy link
Member

@amotin amotin left a comment

Choose a reason for hiding this comment

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

Looks good to me, but makes me wonder why are we duplicating the examples.

@amotin amotin added the Status: Code Review Needed Ready for review and testing label Nov 18, 2024
@behlendorf behlendorf added Status: Accepted Ready to integrate (reviewed, tested) and removed Status: Code Review Needed Ready for review and testing labels Nov 19, 2024
@behlendorf behlendorf merged commit e08e832 into openzfs:master Nov 19, 2024
18 checks passed
@smokris smokris deleted the zpool-remove-example-result branch November 19, 2024 14:56
behlendorf pushed a commit to behlendorf/zfs that referenced this pull request Nov 21, 2024
Also fix comment cross-referencing to zpool.8.

Reviewed-by: Brian Behlendorf <[email protected]>
Reviewed-by:  Alexander Motin <[email protected]>
Signed-off-by: Steve Mokris <[email protected]>
Closes openzfs#16777
behlendorf pushed a commit to behlendorf/zfs that referenced this pull request Nov 21, 2024
Also fix comment cross-referencing to zpool.8.

Reviewed-by: Brian Behlendorf <[email protected]>
Reviewed-by:  Alexander Motin <[email protected]>
Signed-off-by: Steve Mokris <[email protected]>
Closes openzfs#16777
ixhamza pushed a commit to truenas/zfs that referenced this pull request Dec 2, 2024
Also fix comment cross-referencing to zpool.8.

Reviewed-by: Brian Behlendorf <[email protected]>
Reviewed-by:  Alexander Motin <[email protected]>
Signed-off-by: Steve Mokris <[email protected]>
Closes openzfs#16777
lundman pushed a commit to openzfsonwindows/openzfs that referenced this pull request Jan 26, 2025
Also fix comment cross-referencing to zpool.8.

Reviewed-by: Brian Behlendorf <[email protected]>
Reviewed-by:  Alexander Motin <[email protected]>
Signed-off-by: Steve Mokris <[email protected]>
Closes openzfs#16777
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)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants